Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Senders

Update sender name

Update a sender. Only name can be changed; value is set at creation and is immutable.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

put/senders/{id}

Request body

namestring required

New sender display name.

Example request

{
  "name": "CommPeak Alerts"
}

Response

The updated sender.

idinteger

Unique sender identifier.

namestring

Sender display name.

valuestring

The sender ID or phone number used on outbound messages.

dailyLimitinteger

Maximum messages this sender may send per day.

streamstring

IRI of the stream this sender belongs to, if any.

senderType'PHONE' | 'ALPHANUMERIC' | 'INBOUND_ONLY' | 'BOT' | 'WHATSAPP' | 'TELEGRAM_PRIVATE' | 'WHATSAPP_PRIVATE' | 'WIDGET' | 'VOICE'

Sender type (read-only, derived from the value).

status'WAITING_APPROVE' | 'APPROVED' | 'UNAPPROVED'

Approval status (read-only).

Example response

{
  "id": 7,
  "name": "CommPeak",
  "value": "CommPeak",
  "dailyLimit": 5000,
  "stream": "/api/streams/5",
  "senderType": "ALPHANUMERIC",
  "status": "APPROVED"
}