post
/api/v2/zones/custom/by-sub-typePython SDK method:
client.zones.by_sub_type(params).run()Start custom zones by sub-type job
Starts a job to return GeoJSON features for custom zones matching the given sub-type IDs.
Altitude Help Center — getCustomZonesRequest Body
Custom zone sub-type selection.
application/json: object
| Name | Type | Input Shape | Values | Description | Value Required |
|---|---|---|---|---|---|
subTypeIds | array<string> | - | - | An optional array of customer zone sub type ids. Leaving it empty will return all zones. | N |
Examples
Custom zones by subType
Replace the database-specific placeholder with an id returned by GET /api/v2/zones/custom-sub-types.
{
"subTypeIds": [
"zt-00001"
]
}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. |
