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

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

PATCH /number_order_phone_numbers/{number_order_phone_number_id}

JavaScript

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.numberOrderPhoneNumbers.updateRequirements(
  'number_order_phone_number_id',
);

console.log(response.data);

200

{
  "data": {
    "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
    "record_type": "number_order_phone_number",
    "phone_number": "[phone]",
    "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": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "locality": "San Francisco",
    "deadline": "2024-05-31T11:14:00Z",
    "requirements_status": "pending",
    "is_block_number": false
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

number_order_phone_number_id · string · required

The number order phone number ID.

Body

application/json

regulatory_requirements · object[]

Show child attributes

Response

200

application/json

Successful response with details about a number order phone number.

data · object

Show child attributes