v52

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

Update a sub number order's requirements

Updates a sub number order.

patch/sub_number_orders/{sub_number_order_id}

Path parameters

sub_number_order_idstring required

The sub number order ID.

Request body

Example request

{
  "regulatory_requirements": [
    {
      "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
      "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
    }
  ]
}

Response

Successful response with details about a sub number order.

Example response

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