Skip to main content
PATCH
Update a zone

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

zone_id
string
required

Flatpeak Zone ID.

Body

application/json

Zone update payload.

Zone update payload. Send only the fields to change.

name
string

Zone name, for your own reference.

Example:

"NGED Bristol constraint zone"

definition
object

Replaces the zone area: a country, narrowed by at most one of states, postal_codes or multipolygon. With none of the three, the zone is the whole country. Membership is re-resolved, and zone.membership.update fires when that completes and for devices that join or leave.

Example:

Response

Zone response. device_count is null while membership is being resolved again.

An area in one country: the whole country, or part of it defined by states, postal codes or a GeoJSON MultiPolygon. Flatpeak resolves membership from enrollment addresses; you receive counts and device IDs, never addresses. zone.membership.update fires on changes.

id
string
required

Flatpeak Zone ID.

Example:

"zon_9b3c5d7e1f2a4b6c8d0e2f4a"

object
enum<string>
required

Object type, zone.

Available options:
zone
Example:

"zone"

live_mode
boolean
required

true for live data, false for test data.

Example:

true

name
string
required

Zone name, for your own reference.

Example:

"NGED Bristol constraint zone"

definition
object
required

The zone area: a country, narrowed by at most one of states, postal_codes or multipolygon. With none of the three, the zone is the whole country.

Example:
device_count
integer | null
required
read-only

Devices resolved into the zone. null while Flatpeak is still resolving membership, which happens after the zone is created and after its definition changes.

Example:

214

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-08-12T09:30:00Z"

account_id
string
required

Flatpeak Account ID of the operator that owns the zone.

Example:

"acc_649d465ede6a785d2fa5f905"