Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Zones in Bulk

Create up to 100 zones in a single request.

post/v2/locations/zones

Query parameters

inheritLocaleboolean

When true, inherits missing locale fields (language, currency, timezone) from the parent zone.

Headers

Authorizationstring
X-CAP-API-OAUTH-TOKENstring

Request body

codestring required

Unique zone code. Lowercase letters, digits, periods, underscores, hyphens. Max 50 characters.

namestring required

Display name. Letters, digits, underscores, and spaces. Cannot equal root. Max 100 characters.

areaParentCodestring required

Code of the parent zone. Must be an existing active zone.

languagestring

IETF BCP 47 language code (e.g. en-IN). Required when inheritLocale is false.

currencystring

ISO 4217 currency code (e.g. INR). Required when inheritLocale is false.

timezonestring

IANA timezone name (e.g. Asia/Kolkata). Required when inheritLocale is false.

descriptionstring

Free-text description of the zone.

isActiveboolean

Whether the zone is active. Defaults to true when omitted.

externalIdsobject

Key-value pairs of external identifiers. Max five entries. Keys and values must be non-blank and max 200 characters each.

customFieldsobject

Custom field key-value pairs. Keys must match custom fields configured for the org.

Response

All zones created successfully.

totalCountinteger

Total number of concept records in the request.

failureCountinteger

Number of concepts that failed to update.