Skip to main content

Update a sub number order's requirements

PATCH 
/sub_number_orders/:sub_number_order_id

Updates a sub number order.

Request ​

Path Parameters

    sub_number_order_id stringrequired

    The sub number order 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 sub number order.

Schema

    data

    SubNumberOrder

    id uuid
    order_request_id uuid
    country_code string
    phone_number_type string

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

    user_id uuid

    regulatory_requirements

    SubNumberOrderRegulatoryRequirement[]

  • Array [

    • record_type string
    requirement_id uuid

    Unique id for a requirement.

    field_type string

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

  • ]

    • record_type string
    phone_numbers_count integer

    The count of phone numbers in the number order.

    created_at datetime

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

    updated_at datetime

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

    requirements_met boolean

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

    status string

    Possible values: [pending, success, failure]

    The status of the order.

    customer_reference string

    A customer reference string for customer look ups.

    is_block_sub_number_order boolean

    True if the sub number order is a block sub number order

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/sub_number_orders/:sub_number_order_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": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
    "country_code": "US",
    "phone_number_type": "local",
    "user_id": "d70873cd-7c98-401a-81b6-b1ae08246995",
    "regulatory_requirements": [
      {
        "record_type": "phone_number_regulatory_requirement",
        "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
        "field_type": "address"
      }
    ],
    "record_type": "sub_number_order",
    "phone_numbers_count": 1,
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z",
    "requirements_met": true,
    "status": "pending",
    "customer_reference": "MY REF 001",
    "is_block_sub_number_order": false
  }
}