CommonTags

Update a tag

Change the tag name. The new name must be unique among existing tags. Tag names are case-sensitive, that is Marketing and marketing are two different tags.

Path parameters

tag_idstringRequired

Headers

AuthorizationstringRequired

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

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
categoryenumOptional
The tag category.
descriptionstringOptional>=1 character<=255 characters
The tag description.
namestringOptional>=1 character<=255 characters
The tag name. Must be unique.

Response

Successful Response
idstringformat: "uuid"
A unique ID of this tag.
created_atdatetime

Date and time when the tag was created. Timestamps follow the ISO 8601 standard.

updated_atdatetime

Date and time when the tag was last updated. Timestamps follow the ISO 8601 standard.

namestring
The tag name.
categoryenumOptional
The tag category.
created_by_entity_user_idstringOptionalformat: "uuid"
ID of the user who created the tag.
descriptionstringOptional>=1 character<=255 characters
The tag description.

Errors