v53

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB

Phone Number Reservations

Create a number reservation

Creates a Phone Number Reservation for multiple numbers.

post/number_reservations

Request body

created_atstring date-time

An ISO 8901 datetime string denoting when the numbers reservation was created.

customer_referencestring

A customer reference string for customer look ups.

idstring uuid

record_typestring

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

The status of the entire reservation.

updated_atstring date-time

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

Example request

{
  "created_at": "2018-01-01T00:00:00.000000Z",
  "customer_reference": "MY REF 001",
  "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
  "phone_numbers": [
    {
      "created_at": "2018-01-01T00:00:00.000000Z",
      "errors": "Number is already on hold",
      "expired_at": "2018-01-01T00:00:00.000000Z",
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "phone_number": "+19705555098",
      "record_type": "reserved_phone_number",
      "status": "pending",
      "updated_at": "2018-01-01T00:00:00.000000Z"
    }
  ],
  "record_type": "number_reservation",
  "status": "pending",
  "updated_at": "2018-01-01T00:00:00.000000Z"
}

Response

Successful response with details about a number reservation.

Example response

{
  "data": {
    "created_at": "2018-01-01T00:00:00.000000Z",
    "customer_reference": "MY REF 001",
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "phone_numbers": [
      {
        "created_at": "2018-01-01T00:00:00.000000Z",
        "errors": "Number is already on hold",
        "expired_at": "2018-01-01T00:00:00.000000Z",
        "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
        "phone_number": "+19705555098",
        "record_type": "reserved_phone_number",
        "status": "pending",
        "updated_at": "2018-01-01T00:00:00.000000Z"
      }
    ],
    "record_type": "number_reservation",
    "status": "pending",
    "updated_at": "2018-01-01T00:00:00.000000Z"
  }
}