Sign in

v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB
Campaign Registry: Phone Number Assignments

Create phone number assignment order

Creates a new order for a campaign.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging and Numbers.

Learn more about API scopes.

post/api/relay/rest/registry/beta/campaigns/{id}/orders

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the campaign.

Request body

phone_numbersstring[]

A list of phone numbers in E164 format.

status_callback_urlstring

Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state. See the 10DLC status callback docs for the webhook payload.

Example request

{
  "phone_numbers": [
    "+15558675309"
  ],
  "status_callback_url": "https://example.com/handle_callback"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

statestring

The current state of the order.

processed_atstring date-time

Timestamp when the order was processed.

created_atstring date-time

Timestamp when the order was created.

updated_atstring date-time

Timestamp when the order was last updated.

status_callback_urlstring

Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state. See the 10DLC status callback docs for the webhook payload.

Example response

{
  "state": "pending",
  "status_callback_url": "https://example.com/handle_callback"
}