post
/api/v2/zones/custom-sub-typesPython SDK method:
client.zones.create_sub_type(params)Create custom zone sub-type
Creates a new custom zone sub-type for the authenticated user's database. Sub-types categorise custom zones (e.g. distribution centre, fuel stop).
Altitude Help Center — createCustomZoneTypeRequest Body
Custom zone sub-type definition.
application/json: object
| Name | Type | Input Shape | Values | Description | Value Required |
|---|---|---|---|---|---|
comments | string | - | - | Optional notes describing the purpose or usage of this custom zone sub-type. | N |
name | string | - | - | Display name for the custom zone sub-type. Must be unique within the database. | Y |
Examples
Create custom zone subType request
Translated from the v1 createCustomZoneType sample.
{
"comments": "Fueling locations",
"name": "Fuel Stop"
}Success Responses
201 response: object
Resource created.
| Name | Type | Description |
|---|---|---|
comments | string | Notes describing the purpose or usage of this sub-type. |
created | string | Timestamp of when the resource was created. |
createdBy | string | Username of the user who created the resource. |
database | string | Database the sub-type belongs to. Omitted for global sub-types. |
id | string | Unique custom zone sub-type identifier. |
modified | string | Timestamp of the most recent modification. |
modifiedBy | string | Username of the user who last modified the resource. |
name | string | Display name for the custom zone sub-type. |
status | integer (int64) | Lifecycle status: 1 = active, 0 = archived. |
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. |
| 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. |