Skip to main content

Update requirement values in requirement group

PATCH 
/requirement_groups/:id

Update requirement values in requirement group

Request

Path Parameters

    id stringrequired

    ID of the requirement group

Body

required

    customer_reference string

    Reference for the customer

    regulatory_requirements

    object[]

  • Array [

  • requirement_id string

    Unique identifier for the regulatory requirement

    field_value string

    New value for the regulatory requirement

  • ]

Responses

200: Updated requirement group

Request samples


curl -L -X PATCH 'https://api.telnyx.com/v2/requirement_groups/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"customer_reference": "0002",
"regulatory_requirements": [
{
"requirement_id": "53970723-fbff-4f46-a975-f62be6c1a585",
"field_value": "new requirement value"
}
]
}'

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