Skip to content

Create custom region coverage profile

Request

Creates a custom region coverage profile using a list of ISO 2-letter country codes.

Validation checks:

The system performs the following validations before creating the profile:

  • Duplicate name check: If a region with the same name already exists for this organization, returns 400 Bad Request
  • Duplicate coverage check: If a coverage profile with the exact same set of countries already exists, returns 409 Conflict with the existing profile details

Note: Coverage profiles are immutable and cannot be deleted. You can only create new profiles.

Security
ApiKeyAuth
Bodyapplication/json
region_namestringrequired

The name of the custom region.

Example:"Usa and Mexico Regional Plan"
labelstring(Label)required
Enum:"Green""Aqua""Blue""Voilet""Red""Grey""Orange"
iso2_listArray of stringsrequired

List of ISO 2-letter country codes included in the custom region.

Example:
[
  "US",
  "MX"
]
POST
/v3/coverage-profiles/custom-region
curl -i -X POST \
  'https://api.tellisim.com/v3/coverage-profiles/custom-region?key=YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "region_name": "Usa and Mexico Regional Plan",
    "label": "Green",
    "iso2_list": [
      "US",
      "MX"
    ]
  }'

Responses

Successful response containing the created custom region coverage profile.

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred during the request

Example:false
dataobjectrequired
Response
{
  "error": false,
  "data": {
    "coverage_id": "85089a51-801c-4737-bd8b-f542705712bf",
    "region_code": "R33BHT",
    "region_name": "Usa and Mexico Regional Plan",
    "iso2_list": [ … ]
  }
}