CreateNumberBlockOrderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-create-number-block-order-request-schema.json",
  "title": "CreateNumberBlockOrderRequest",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-phone-number-block-orders-api-openapi.yml#/components/schemas/CreateNumberBlockOrderRequest",
  "properties": {
    "connection_id": {
      "description": "Identifies the connection associated with this phone number.",
      "type": "string"
    },
    "created_at": {
      "description": "An ISO 8901 datetime string denoting when the number order was created.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "customer_reference": {
      "description": "A customer reference string for customer look ups.",
      "type": "string"
    },
    "errors": {
      "description": "Errors the reservation could happen upon",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "format": "uuid",
      "readOnly": true,
      "type": "string"
    },
    "messaging_profile_id": {
      "description": "Identifies the messaging profile associated with the phone number.",
      "type": "string"
    },
    "phone_numbers_count": {
      "description": "The count of phone numbers in the number order.",
      "readOnly": true,
      "type": "integer"
    },
    "range": {
      "description": "The phone number range included in the block.",
      "type": "integer",
      "writeOnly": true
    },
    "record_type": {
      "readOnly": true,
      "type": "string"
    },
    "requirements_met": {
      "description": "True if all requirements are met for every phone number, false otherwise.",
      "readOnly": true,
      "type": "boolean"
    },
    "starting_number": {
      "description": "Starting phone number block",
      "type": "string",
      "writeOnly": true
    },
    "status": {
      "description": "The status of the order.",
      "enum": [
        "pending",
        "success",
        "failure"
      ],
      "readOnly": true,
      "type": "string"
    },
    "updated_at": {
      "description": "An ISO 8901 datetime string for when the number order was updated.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "starting_number",
    "range"
  ],
  "type": "object"
}