Senders and settings
Register SMS senders and manage the account's SMS settings and callback URL.
Register custom senders and configure the account’s SMS-related settings before using them in production workflows.
Sender prerequisites
A custom sender requires an active subscription or the custom sender service. Test accounts use the senders already provided for the account.
Alphanumeric senders must contain 3–11 characters from A–Z, a–z and 0–9. Numeric senders follow E.164 and may contain up to 15 digits. Carrier and country rules may restrict which senders are delivered.
Sender endpoints
| Method | Path | Description |
|---|---|---|
GET |
/v2/me/senders |
List registered senders. |
GET |
/v2/me/senders/{sender} |
Read a sender. |
PUT |
/v2/me/senders/{sender} |
Register a sender. |
DELETE |
/v2/me/senders/{sender} |
Unregister a sender. |
curl -X PUT "https://api.ip1sms.com/v2/me/senders/YourCompany" \
-H "Authorization: Bearer $IP1_TOKEN"{
"sender": "YourCompany",
"created": "2026-10-05T08:03:21Z"
}The older quickstart alternatively showed PUT /v2/me/senders with { "sender": "..." }, while the endpoint list and language examples use the path parameter. This documentation uses the latter form. Confirm the collection variant in a test environment before using it.
Account settings
| Method | Path | Description |
|---|---|---|
GET |
/me/sms/settings |
List all SMS settings. |
GET |
/me/sms/settings/{setting} |
Read a setting. |
PUT |
/me/sms/settings/{setting} |
Create or replace a setting. |
DELETE |
/me/sms/settings/{setting} |
Reset to the global default or disable. |
The account-settings endpoints belong to an older API structure that remains operational and sit directly under https://api.ip1sms.com, without /v2.
Inbound SMS callback
| Property | Value |
|---|---|
| Name | IncomingCallbackUrl |
| Data type | Absolute URL as a string |
| Default | null, disabled |
Example:
curl -X PUT \
"https://api.ip1sms.com/me/sms/settings/IncomingCallbackUrl" \
-H "Authorization: Bearer $IP1_TOKEN" \
-H "Content-Type: application/json" \
-d '"https://example.com/webhooks/ip1/incoming"'The published settings page does not specify the exact request wrapper for the value. Test the payload format with a non-production account, or configure the URL in the portal before putting automated settings management into production.
Read Inbound SMS for the payload and receiver behavior.