Need help?
Sender
SMS Sender
An SMS Sender is the name that appears as the sender on an SMS message. Before you can send an SMS, you must first register a Sender and wait for it to be approved.
Approval is required. Newly created Sender IDs have a Pending status. Only Approved Sender IDs can be used in the sender field when sending SMS.
Create Sender ID
Submit a new Sender ID for approval. Once approved, use the senderId value as the sender field in your SMS requests.
POST
/v1/sender-id
Authorization
Header
Required
yes
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| senderName | string | yes | The name to display as the sender. Max 11 characters, alphanumeric. |
| purpose | string | yes | Intended use of this sender. Accepted values: marketing, transactional. |
| channel | string | yes | Delivery channel. Accepted value: sms. |
| targetTraffic | number | yes | Estimated monthly message volume for this sender. |
| sampleMessage | string | yes | A representative message you plan to send. Used during the approval review. |
Response · 200 OK
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | — | true when the Sender ID was submitted successfully. |
| data | object | — | The newly created Sender ID record. |
| meta | object | — | Request metadata. |
Fetch Sender IDs
Retrieve all Sender IDs registered under your account. Use the status field to check whether a Sender ID has been approved before using it to send messages.
GET
/v1/sender-id
Authorization
Header
Required
yes
Response · 200 OK
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| success | boolean | — | true when the request was successful. |
| data | object | — | The response payload. |
| meta | object | — | Request metadata. |