Senders

Update sender name

Changed on Nov 3, 2026

Update a sender. Only name can be changed; value is set at creation and is immutable. WhatsApp senders cannot be renamed here.

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

put/senders/{id}

Request

Base URL
https://api.commpeak.com/textpeak
URL
https://api.commpeak.com/textpeak/senders/{id}
Auth
API key in header Authorization

Path parameters

idinteger required

Unique identifier of the resource.

Request body

namestring required

New sender display name. The only field a sender update can change.

Example request

{
  "name": "CommPeak Alerts"
}

Response

Successful Response

idinteger required

Unique sender identifier.

namestring required

Sender display name.

valuestring required

The sender ID or phone number used on outbound messages (-, spaces and + removed).

dailyLimitinteger required

Maximum messages this sender may send per day. 0 for senders created through the API.

streamstring nullable

IRI of the stream this sender is bound to (/api/streams/{id}), or null.

status'WAITING_APPROVE' | 'APPROVED' | 'UNAPPROVED' | 'UNKNOWN' required

Example response

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

Changes

Nov 3, 20265012671cf95d Revision changes
- breaking
  added the new path request parameter id
- breaking
  response property stream list-of-types was widened by adding types null to media type application/json of response 200
- warning
  the request property's maxLength was set to 255
- warning
  added the new EMAIL enum value to the response property for the response status
- warning
  added the new UNKNOWN enum value to the response property for the response status
- warning
  added the new UNKNOWN enum value to the response property for the response status
- info
  api operation id updateSenderName removed and replaced with update_sender
- info
  the endpoint scheme security APIKeyHeader was added to the API
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status

Operation history