put
https://gw.commpeak.com/textpeak/senders/
Description
Summary: Updates the name of an existing sender identified by its unique ID. Details: This endpoint allows you to modify the human-readable label (name) of a sender resource. The sender's underlying value (e.g., phone number or alphanumeric sender ID) cannot be changed through this endpoint — only the display name. Use this when you need to rename a sender for organizational or clarity purposes without affecting its routing or delivery behavior.
Authentication & Scopes
Authentication is handled via an API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the key.
| Method | Details |
|---|---|
| API Key | Pass your API key directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The API key that verifies your access to the API. |
Content-Type | Yes | Must be application/json. |
accept | No | Expected response format. Default: application/json. |
Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
id | integer | Path | Yes | The unique identifier of the sender to update. In the URL pattern /senders/{id}, replace {id} with the sender ID. |
Request Body
The request body must be a JSON object with the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The new human-readable label for the sender (e.g., "Marketing SMS", "Alerts"). |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…