API ReferenceTag

Update Tag

Updates an existing Tag based on information you provide. A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color.

Path parameters

tagIdstringRequiredformat: "uuid"
The id of the tag

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

The information to update the tag
colorstringOptional

The color that will be used to represent this Tag visually. This color is automatically chosen by the application when a user creates a Tag.

You can choose specify any color that can be represented using HTML RGB syntax such as #0088FF, in the format RRGGBB. You may not use names for colors.

Response

Success
errorobjectOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptional

True if the API call succeeded; false otherwise.

hasErrorbooleanOptional
True if the API call failed.
statusCodeobjectOptional
The HTTP code of the response.
dataobjectOptional
A Tag is a named categorization you can use to distinguish objects from each other. Tags each have a unique identifier, a name, and a color.