Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB
Requirement Groups

Create a new requirement group

post/requirement_groups

Request body

country_codestring required

ISO alpha 2 country code

phone_number_type'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost' required
action'ordering' | 'porting' required
customer_referencestring

Example request

{
  "country_code": "US",
  "phone_number_type": "local",
  "action": "ordering",
  "customer_reference": "My Requirement Group"
}

Response

Requirement group created

idstring
country_codestring
phone_number_typestring
status'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired'
actionstring
customer_referencestring
created_atstring date-time
updated_atstring date-time
record_typestring

Example response

{
  "record_type": "requirement_group"
}