Update requirement group for a sub number order

POST 
/sub_number_orders/:id/requirement_group

Update requirement group for a sub number order

Path Parameters

id uuidrequired

The ID of the sub number order

application/json

Body

required

requirement_group_id uuidrequired

The ID of the requirement group to associate

200: Sub number order requirement group updated successfully

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

order_request_id uuid

country_code string

phone_number_type string

phone_numbers_count integer

requirements_met boolean

is_block_sub_number_order boolean

status string

customer_reference string

created_at date-time

updated_at date-time

record_type string

regulatory_requirements

object[]

Array [

record_type string

requirement_id uuid

field_type string

]

phone_numbers

object[]

Array [

id uuid

phone_number string

country_code string

phone_number_type string

requirements_met boolean

requirements_status string

status string

record_type string

bundle_id uuid

regulatory_requirements

object[]

Array [

requirement_id uuid

field_type string

field_value string

status string

]

]

{
  "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": null,
        "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"
  }
}

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/sub_number_orders/:id/requirement_group' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "requirement_group_id": "a4b201f9-8646-4e54-a7d2-b2e403eeaf8c"
}'

Response samples

• 200
• default

---

{
  "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": null,
        "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"
  }
}

{
  "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"
      }
    }
  ]
}