Update a tag

PATCH

/tags/:tag_id

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

Auth

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

Get payables analytics

Up Next

1	curl -X PATCH https://api.sandbox.monite.com/v1/tags/tag_id \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{}'

1	{
2	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
3	"created_at": "2022-09-07T16:35:18Z",
4	"updated_at": "2022-09-07T16:35:18Z",
5	"name": "Marketing",
6	"category": "document_type",
7	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
8	"description": "Tag for the Marketing Department"
9	}