USusenash
Zones

Create zone restriction

Changed on

Create a zone restriction rule that controls delivery behavior within a specific zone, such as provider restrictions or time-based rules.

post/v1/zone-restrictions

Request

Request body

externalIdstring nullable

The external ID of the zone restriction.

namestring required

The name of the zone restriction.

isActiveboolean nullable

Whether the zone restriction is active.

restrictionMetadataobject nullable

The metadata of the zone restriction.

Example request

{
  "restrictionMetadata": {
    "key": "value"
  }
}

Response

OK

idstring required

The ID of the zone restriction.

externalIdstring required

The external ID of the zone restriction.

namestring required

The name of the zone restriction.

isActiveboolean required

Whether the zone restriction is active.

restrictionMetadataobject nullable required

The metadata of the zone restriction.

Example response

{
  "id": "res_01234567890123456789",
  "externalId": "ext_01234567890123456789",
  "name": "Zone Restriction 1",
  "isActive": true,
  "restrictionMetadata": {
    "restriction_metadata": {
      "key": "value"
    }
  }
}

Changes