patch
/api/v2/zones/custom-sub-types/{id}Python SDK method:
client.zones.update_sub_type(id, params)Update custom zone sub-type
Update a custom zone sub-type with the given ID. Pass any field that you want updated as a parameter
Altitude Help Center — updateCustomZoneTypeInput Parameters
| Name | Location | Type | Values | Description | Value Required |
|---|---|---|---|---|---|
id | path | string | - | Resource identifier. | Y |
Request Body
Partial custom zone sub-type update (merge-patch).
application/merge-patch+json: object
| Name | Type | Input Shape | Values | Description | Value Required |
|---|---|---|---|---|---|
comments | string | - | - | Updated notes. Omit to leave unchanged. | N |
name | string | - | - | New display name for the custom zone sub-type. Omit to leave unchanged. | N |
status | integer (int64) | - | - | Lifecycle status: 1 = active, 0 = archived. Omit to leave unchanged. | N |
Examples
Update custom zone subType request
Translated from the v1 updateCustomZoneType sample; the identifier is supplied in the path.
{
"comments": "Updated notes",
"name": "Updated Fuel Stop",
"status": 1
}Success Responses
200 response: object
Updated.
| 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. |
| 404 | The requested resource does not exist. |
| 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. |