Description
Summary: Creates a new sender on your account. Details: This endpoint registers a new sender resource with the specified name and value. The name is a human-readable label for the sender, while the value is the actual sender identifier (e.g., a phone number or alphanumeric sender ID) that will appear as the originator of outbound messages. Once created, the sender may be subject to approval or verification depending on your account configuration and the destination network requirements.
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
This endpoint does not use path or query parameters.
Request Body
The request body must be a JSON object with the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A human-readable label for the sender (e.g., "Marketing SMS", "Alerts"). |
value | string | Yes | The sender identifier value — typically a phone number or alphanumeric sender ID that recipients will see as the message originator. |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||