Sign in

Update Zones in Bulk

Update up to 100 zones in a single request.

put/v2/locations/zones

Query parameters

inheritLocaleboolean

When true, locale fields are inherited from the parent zone when not explicitly provided.

Request body

identifierName'ID' | 'CODE' | 'EXTERNAL_ID' required

How to identify the target zone. One of ID, CODE, EXTERNAL_ID (case-insensitive).

identifierValuestring required

The identifier value matching identifierName.

namestring

Display name for the zone. Cannot be null or empty. Cannot equal root (any case). Max 100 characters. Accepts letters, digits, underscores, and spaces.

descriptionstring nullable

Free-text description. Set to null to clear.

isAdminboolean

Whether the zone has admin access.

isActiveboolean

Whether the zone is active. Deactivation fails if children are active. Activation fails if parent is inactive.

areaParentCodestring

Code of the parent zone. Must be a valid active zone code. Cannot be set to null.

externalIdsobject nullable

Key-value map of external identifiers. Omit to preserve. Set to null to clear all. Set a key's value to null to remove that specific key. Pass {} to make no change. Maximum five entries. Keys and values must not exceed 200 characters each.

customFieldsobject nullable

Key-value map of custom field values. Omit to preserve. Set to null to clear all. Set a key's value to null to remove that specific key. Pass {} to make no change. Keys must match custom fields configured for the org.

languagestring

IETF BCP 47 language code (e.g. en-IN). Must be enabled for the org.

currencystring

ISO 4217 currency code (e.g. INR). Must be enabled for the org.

timezonestring

IANA timezone name (e.g. Asia/Kolkata). Must be enabled for the org.

Response

All zones updated successfully.

totalCountinteger

Total number of concept records in the request.

failureCountinteger

Number of concepts that failed to update.

Changes