v52

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

Phone Number Block Orders

Create a number block order

Creates a phone number block order.

post/number_block_orders

Request body

connection_idstring

Identifies the connection associated with this phone number.

created_atstring date-time

An ISO 8901 datetime string denoting when the number order was created.

customer_referencestring

A customer reference string for customer look ups.

errorsstring

Errors the reservation could happen upon

idstring uuid

messaging_profile_idstring

Identifies the messaging profile associated with the phone number.

phone_numbers_countinteger

The count of phone numbers in the number order.

rangeinteger required

The phone number range included in the block.

record_typestring

requirements_metboolean

True if all requirements are met for every phone number, false otherwise.

starting_numberstring required

Starting phone number block

status'pending' | 'success' | 'failure'

The status of the order.

updated_atstring date-time

An ISO 8901 datetime string for when the number order was updated.

Example request

{
  "range": 10,
  "starting_number": "+19705555000"
}

Response

Successful response with details about a number block order.

Example response

{
  "data": {
    "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_count": 10,
    "range": 10,
    "record_type": "number_block_order",
    "requirements_met": true,
    "starting_number": "+19705555000",
    "status": "pending",
    "updated_at": "2018-01-01T00:00:00.000000Z"
  }
}