KUkudosity
Senders

Create a sender registration

Changed on

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.
post/v2/senders/registrations

Request

  • Base URL
    https://api.transmitmessage.com
  • Auth
    API key in header x-api-key

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.

account_idstring

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.

child_account_idstring

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

Example request

{
  "account_id": "1234"
}

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": {
    "account_id": "1234",
    "details": {
      "alphanumeric": {
        "status": "PENDING_CUSTOMER",
        "status_reason": "Customer has not taken any actions"
      }
    }
  }
}

Changes

  • e6206dcd3439Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new SUBMITTED_TO_REGISTRY enum value to the // response property for the response status

    • info

      added the new optional request property

    • info

      request property deprecated

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      response property allOf[subschema #2]/data/child_account_id deprecated

    • info

      added the required property // to the response with the status

  • e7314f92947aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status