Sign in
Zones

Create a zone

Creates a new Zone at a site. Requires the SETTINGS_MANAGE permission on the target site.

post/shop/zones

Request body

namestring required

Display name for the new zone. Plain text only. Zone names do not need to be unique within a site, but duplicates can make the UI confusing — pick distinct labels where possible.

site_idstring uuid required

ID of the site to create this zone under. The caller's API key must have access to the site and the SETTINGS_MANAGE permission on it.

organisation_idstring uuid

Optional organisation to attribute the zone to. Defaults to the caller's primary organisation when omitted.

Example request

{
  "name": "Pool Deck",
  "site_id": "11111111-1111-1111-1111-111111111111",
  "organisation_id": "22222222-2222-2222-2222-222222222222"
}

Response

A single Zone.

Example response

{
  "data": {
    "id": "5f1234567890abcdef123456",
    "name": "Pool Deck",
    "organisation_id": "22222222-2222-2222-2222-222222222222",
    "site_id": "11111111-1111-1111-1111-111111111111"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.