Update requirement group for a phone number order

POST 
/number_order_phone_numbers/:id/requirement_group

Update requirement group for a phone number order

Path Parameters

id uuidrequired

The unique identifier of the number order phone number

application/json

Body

required

requirement_group_id uuidrequired

The ID of the requirement group to associate

200: Successful response with updated phone number order details

application/json

• Schema
• Example (from schema)

Schema

data

object

status string

order_request_id uuid

country_code string

is_block_number boolean

regulatory_requirements

object[]

Array [

requirement_id uuid

field_value string

field_type string

status string

]

locality string

phone_number_type string

bundle_id uuidnullable

sub_number_order_id uuid

deadline date-time

requirements_status string

id uuid

phone_number string

requirements_met boolean

record_type string

{
  "data": {
    "status": "pending",
    "order_request_id": "a11d58fe-88a4-494a-b752-8dea411993c6",
    "country_code": "AT",
    "is_block_number": false,
    "regulatory_requirements": [
      {
        "requirement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "field_value": "1234567890",
        "field_type": "textual",
        "status": "pending-approval"
      }
    ],
    "locality": "AUSTRIA",
    "phone_number_type": "toll_free",
    "bundle_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sub_number_order_id": "f826ed66-b27c-4340-9dc0-57dc3459f1bd",
    "deadline": "2024-07-29T15:51:28.071Z",
    "requirements_status": "requirement-info-under-review",
    "id": "613d517a-0432-4bae-a785-c11033bd0985",
    "phone_number": "+43800300238",
    "requirements_met": false,
    "record_type": "number_order_phone_number"
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

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.

]

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/number_order_phone_numbers/:id/requirement_group' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "requirement_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

Response samples

• 200
• default

---

{
  "data": {
    "status": "pending",
    "order_request_id": "a11d58fe-88a4-494a-b752-8dea411993c6",
    "country_code": "AT",
    "is_block_number": false,
    "regulatory_requirements": [
      {
        "requirement_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "field_value": "1234567890",
        "field_type": "textual",
        "status": "pending-approval"
      }
    ],
    "locality": "AUSTRIA",
    "phone_number_type": "toll_free",
    "bundle_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sub_number_order_id": "f826ed66-b27c-4340-9dc0-57dc3459f1bd",
    "deadline": "2024-07-29T15:51:28.071Z",
    "requirements_status": "requirement-info-under-review",
    "id": "613d517a-0432-4bae-a785-c11033bd0985",
    "phone_number": "+43800300238",
    "requirements_met": false,
    "record_type": "number_order_phone_number"
  }
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}