v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

CustomTag

Patch custom tag

Requires one of the following scopes: custom_tags:update, custom_tags:all, all:update, all:all

patch/api/v2/custom-tags/{id}

Path parameters

idstring uuid required

Example:019f94cd-ae66-7070-9e74-e9f7fe8688a9

The ID of the item to update

Request body

labelstring

Display label for the custom tag. Must be unique per workspace after trimming whitespace.

descriptionstring nullable

Detailed description of the custom tag purpose

Example request

{
  "label": "Important",
  "description": "Used for marking important items"
}

Response

The updated Custom Tag

idstring uuid required

Unique identifier for the custom tag

timestamp_createdstring date-time required

Timestamp when the custom tag was created

timestamp_updatedstring date-time required

Timestamp when the custom tag was last updated

organization_idstring uuid required

Organization ID that owns this custom tag

labelstring required

Display label for the custom tag. Must be unique per workspace after trimming whitespace.

descriptionstring nullable

Detailed description of the custom tag purpose

Example response

{
  "id": "019f94cd-83c1-7baf-8a0d-b05c07849384",
  "timestamp_created": "2026-07-24T15:45:24.417Z",
  "timestamp_updated": "2026-07-24T15:45:24.417Z",
  "organization_id": "019f94cd-83c1-7baf-8a0d-b05dd9a6b0e3",
  "label": "Important",
  "description": "Used for marking important items"
}