Skip to main content

Create a new requirement group

POST 
/requirement_groups

Create a new requirement group

Request

Body

required

    country_code stringrequired

    ISO alpha 2 country code

    phone_number_type stringrequired

    Possible values: [local, toll_free, mobile, national, shared_cost]

    action stringrequired

    Possible values: [ordering, porting]

    customer_reference string

    regulatory_requirements

    object[]

  • Array [

  • requirement_id string
    field_value string
  • ]

Responses

200: Requirement group created

Request samples


curl -L 'https://api.telnyx.com/v2/requirement_groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"country_code": "US",
"phone_number_type": "local",
"action": "ordering",
"customer_reference": "My Requirement Group",
"regulatory_requirements": [
{
"requirement_id": "string",
"field_value": "string"
}
]
}'

Response samples


{
"id": "string",
"country_code": "string",
"phone_number_type": "string",
"status": "approved",
"action": "string",
"customer_reference": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"record_type": "requirement_group",
"regulatory_requirements": [
{
"requirement_id": "string",
"field_value": "string",
"field_type": "string",
"status": "approved",
"expires_at": "2024-07-29T15:51:28.071Z",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
]
}