Create a Phone Number Assignment Order

POST 
/registry/beta/campaigns/:id/orders

To create a new Phone Number Assignment Order, you send a POST request to the Orders resource. Phone Number Assignments belong to Campaigns. A list of phone_numbers in E164 format is required.

Permissions

The API token must include the following scopes: Messaging.

Request

Path Parameters

id uuidrequired

Unique ID of the campaign

application/json

Body

required

phone_numbers string[]

A list of phone number in E164 format.

status_callback_url string

Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state.

Responses

200

OK

application/json

Schema

Schema

id uuidrequired

The unique id of the order.

state string

The current state of the order.

processed_at date-time
created_at date-time
updated_at date-time
status_callback_url string

Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "state": "pending",
  "processed_at": null,
  "created_at": "2024-07-12T14:04:37.985Z",
  "updated_at": "2024-07-12T14:04:37.985Z",
  "status_callback_url": "https//example.com/handle_callback"
}

Loading...