Create a sender registration

Creates a sender registration and sets status to PENDING_APPROVAL.

  • If you omit account_id, the API registers the sender for the authenticated account.
  • If you provide account_id, the API registers the sender for that account: your own account or one of your child accounts. The API returns 404 Not Found for an account that isn't visible to you, and 403 Forbidden for one that's visible but you don't manage.
  • child_account_id is a deprecated name for account_id. If you send both, they must name the same account, or the API returns 400 Bad Request.
  • An account you can't use returns 403 or 404. Before these responses were added, a child_account_id you couldn't use returned 400 Bad Request.
  • If a registration for the same sender was already created within the last 30 minutes (for the same account or child account), the API returns 429 Too Many Requests. This prevents abuse of the verification retry limit.
  • Any existing PENDING_APPROVAL registration for the same sender (for the same account or child account) is automatically cancelled before the new one is created.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a sender registration.

string
required

The sender number to register, for example a phone number.

string
required
length between 2 and 2
^[A-Z]{2}$

ISO 3166-1 alpha-2 country code for the sender, for example AU.

string
enum
required

Type of sender registration that can be created through the public API. Only
PERSONAL_MOBILE_NUMBER is supported here; alpha (ALPHANUMERIC) registrations are
created through the registration backoffice and are read-only on this API.

Allowed:
string

The account to register the sender for: your own account or one of your child
accounts. If omitted, the API registers the sender for the authenticated account.

string
deprecated

Deprecated: use account_id, which it is another name for.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json