Skip to main content

Update requirements for a single phone number within a number order.

PATCH 
/number_order_phone_numbers/:number_order_phone_number_id

Updates requirements for a single phone number within a number order.

Request​

Path Parameters

    number_order_phone_number_id stringrequired

    The number order phone number ID.

Body

required

    regulatory_requirements

    UpdateRegulatoryRequirement[]

  • Array [

    • requirement_id uuid

    Unique id for a requirement.

    field_value string

    The value of the requirement. For address and document requirements, this should be the ID of the resource. For textual, this should be the value of the requirement.

  • ]

Responses​

200: Successful response with details about a number order phone number.

Schema

    data

    NumberOrderPhoneNumber

    id uuid
    record_type string
    phone_number e164_phone_number
    order_request_id uuid
    sub_number_order_id uuid
    country_code string
    phone_number_type string

    Possible values: [local, toll_free, mobile, national, shared_cost, landline]

    regulatory_requirements

    SubNumberOrderRegulatoryRequirementWithValue[]

  • Array [

    • record_type string
    requirement_id uuid

    Unique id for a requirement.

    field_type string

    Possible values: [textual, datetime, address, document]

    field_value string

    The value of the requirement, this could be an id to a resource or a string value.

  • ]

    • requirements_met boolean

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

    status string

    Possible values: [pending, success, failure]

    The status of the phone number in the order.

    bundle_id uuid
    locality string
    deadline datetime
    requirements_status string

    Possible values: [pending, approved, cancelled, deleted, requirement-info-exception, requirement-info-pending, requirement-info-under-review]

    Status of requirements (if applicable)

    is_block_number boolean

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Request samples

curl -L -X PATCH 'https://api.telnyx.com/v2/number_order_phone_numbers/:number_order_phone_number_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "regulatory_requirements": [
    {
      "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
      "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21"
    }
  ]
}'

Response samples

{
  "data": {
    "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
    "record_type": "number_order_phone_number",
    "phone_number": "+19705555098",
    "order_request_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd495",
    "sub_number_order_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd496",
    "country_code": "US",
    "phone_number_type": "local",
    "regulatory_requirements": [
      {
        "record_type": "phone_number_regulatory_requirement",
        "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
        "field_type": "address",
        "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21"
      }
    ],
    "requirements_met": true,
    "status": "pending",
    "bundle_id": null,
    "locality": "San Francisco",
    "deadline": "024-05-31T11:14:00+00:00",
    "requirements_status": "pending",
    "is_block_number": false
  }
}