Sign in

v1

latestOpenAPI 3.0.02026-07-244771176.5 KB
Senders

Create a sender registration

Creates a sender registration and sets status to PENDING_APPROVAL.

  • If the account does not use parent/child accounts, the API ignores child_account_id and registers the sender for the authenticated account.
  • If the account is a parent account and you omit child_account_id, the API registers the sender for the parent account.
  • If you provide child_account_id, the API registers the sender for that child account.
  • 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.
post/v2/senders/registrations

Request body

senderstring required

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

countrystring required

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

type'PERSONAL_MOBILE_NUMBER' 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.

child_account_idstring

Child account ID to register the sender for. Ignored for accounts without parent/child accounts. If omitted for a parent account, the API registers the sender for the parent account.

Response

Successful response containing the new sender registration details.

requestobject

Optional metadata (e.g. requestId, traceId)

metaobject

Optional pagination, feature flags, etc.

Example response

{
  "data": {
    "details": {
      "alphanumeric": {
        "status": "PENDING_CUSTOMER",
        "status_reason": "Customer has not taken any actions"
      }
    }
  }
}