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.

Authentication

AuthorizationBearer

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

Path parameters

tagIdstringRequiredformat: "uuid"
The id of the tag

Headers

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

Request

The information to update the tag
namestring or nullOptional
The name of this Tag. When omitted or null, the name is left unchanged.
colorstring or nullOptional

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. When omitted or null, the color is left unchanged.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successbooleanRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanRead-only
True if the API call failed.
statusCodeenum
The HTTP code of the response.
dataobject
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.