v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Phone Number Orders

Create a number order

Creates a phone number order.

post/number_orders

Request body

billing_group_idstring

Identifies the billing group associated with the phone number.

connection_idstring

Identifies the connection associated with this phone number.

customer_referencestring

A customer reference string for customer look ups.

messaging_profile_idstring

Identifies the messaging profile associated with the phone number.

Example request

{
  "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
  "connection_id": "346789098765567",
  "customer_reference": "MY REF 001",
  "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
  "phone_numbers": [
    {
      "bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd494",
      "phone_number": "+19705555098"
    },
    {
      "phone_number": "+492111609539",
      "requirement_group_id": "dbbd94ee-9079-488f-80ba-f566b247fd79"
    }
  ]
}

Response

Successful response with details about a number order.

Example response

{
  "data": {
    "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
    "connection_id": "346789098765567",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "customer_reference": "MY REF 001",
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
    "phone_numbers": [
      {
        "bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd474",
        "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
        "phone_number": "+19705555098",
        "record_type": "number_order_phone_number",
        "regulatory_requirements": [
          {
            "field_type": "address",
            "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
            "record_type": "phone_number_regulatory_requirement",
            "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
          }
        ],
        "requirements_met": true,
        "status": "success"
      }
    ],
    "phone_numbers_count": 1,
    "record_type": "number_order",
    "requirements_met": true,
    "updated_at": "2018-01-01T00:00:00.000000Z"
  }
}