Skip to main content
POST
/
sub_number_orders
/
{id}
/
requirement_group
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.subNumberOrders.updateRequirementGroup(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { requirement_group_id: 'a4b201f9-8646-4e54-a7d2-b2e403eeaf8c' },
);

console.log(response.data);
{
  "data": {
    "country_code": "AT",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z",
    "regulatory_requirements": [
      {
        "record_type": "phone_number_regulatory_requirement",
        "requirement_id": "2708e569-696a-4fc7-9305-5fdb3eb9c7dd",
        "field_type": "textual"
      }
    ],
    "phone_numbers_count": 1,
    "phone_numbers": [
      {
        "country_code": "AT",
        "regulatory_requirements": [
          {
            "field_value": "4804570924",
            "requirement_id": "2708e569-696a-4fc7-9305-5fdb3eb9c7dd",
            "field_type": "textual",
            "status": "pending-approval"
          }
        ],
        "bundle_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
        "requirements_status": "requirement-info-under-review",
        "phone_number_type": "toll_free",
        "requirements_met": false,
        "record_type": "number_order_phone_number",
        "status": "pending",
        "id": "613d517a-0432-4bae-a785-c11033bd0985",
        "phone_number": "+43800300238"
      }
    ],
    "is_block_sub_number_order": false,
    "phone_number_type": "toll_free",
    "requirements_met": false,
    "id": "f826ed66-b27c-4340-9dc0-57dc3459f1bd",
    "order_request_id": "a11d58fe-88a4-494a-b752-8dea411993c6",
    "status": "pending",
    "customer_reference": "missing",
    "record_type": "sub_number_order"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

The ID of the sub number order

Body

application/json
​
requirement_group_id
string<uuid>
required

The ID of the requirement group to associate

Response

Sub number order requirement group updated successfully

​
data
object