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 — updateCustomZoneType

Input Parameters

NameLocationTypeValuesDescriptionValue Required
idpathstring-Resource identifier.Y

Request Body

Partial custom zone sub-type update (merge-patch).

application/merge-patch+json: object

NameTypeInput ShapeValuesDescriptionValue Required
commentsstring--Updated notes. Omit to leave unchanged.N
namestring--New display name for the custom zone sub-type. Omit to leave unchanged.N
statusinteger (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.

NameTypeDescription
commentsstringNotes describing the purpose or usage of this sub-type.
createdstringTimestamp of when the resource was created.
createdBystringUsername of the user who created the resource.
databasestringDatabase the sub-type belongs to. Omitted for global sub-types.
idstringUnique custom zone sub-type identifier.
modifiedstringTimestamp of the most recent modification.
modifiedBystringUsername of the user who last modified the resource.
namestringDisplay name for the custom zone sub-type.
statusinteger (int64)Lifecycle status: 1 = active, 0 = archived.

Response Errors

HTTP Status CodeReason
400The request body or parameters are invalid.
401Authentication is required or the provided credentials are invalid.
403The authenticated user lacks permission to perform this operation.
404The requested resource does not exist.
422The request is syntactically valid but semantically cannot be processed.
429The request rate limit has been exceeded.
500An unexpected server error occurred.