Batch update custom zones

Batch updates multiple custom zones in one request. Each zone is updated using JSON Merge Patch — only the fields you include are changed. Poll the job status endpoint to confirm completion. Keys can be either a zone ID (properties.id) or a raw zone code.

Altitude Help Center — updateCustomZones

Request Body

An object where each key is a zone ID or zone code and each value contains the fields to update.

application/merge-patch+json: object

Examples

Batch update custom zones

Keys can be either a zone ID (properties.id from a custom zone response) or a raw zone code.

{
  "4PBF7WD59Rj7gaNiy95bbC3ajnwrfjXWMjEg": {
    "comments": "Updated example notes",
    "name": "Updated Zone by ID"
  },
  "z-00001": {
    "name": "Updated Zone By Code"
  }
}

Success Responses

202 response: object

Job accepted and queued for processing. Poll the location header URL to check status.

Name	Type	Description
`error`	object	Details about why the job failed (RFC 7807 format), or null if it succeeded.
`id`	string	Unique job identifier.
`links`	object	Navigation URLs for polling and result retrieval.
`status`	string	Current job lifecycle state: PENDING, QUEUED, RUNNING, DONE, FAILED, CANCELED, or NOT_FOUND.

Response Errors

HTTP Status Code	Reason
400	The request body or parameters are invalid.
401	Authentication is required or the provided credentials are invalid.
403	The authenticated user lacks permission to perform this operation.
409	The operation conflicts with the current state of the resource.
422	The request is syntactically valid but semantically cannot be processed.
429	The request rate limit has been exceeded.
500	An unexpected server error occurred.