v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Disputes

Update Tag

Update a Tag's name, color, or description.

patch/dispute/tags/{tagId}

Path parameters

tagIdstring uuid required

Identifier of the resource in Payrails.

Request body

namestring required

New display name.

colorstring required

New hex color code (e.g. "#EF4444").

descriptionstring nullable

Updated description.

Response

Tag updated.

idstring uuid required

Unique identifier of the Tag.

workspaceIdstring uuid nullable

Workspace the Tag belongs to. Null for org-level tags visible to all workspaces.

namestring required

Human-readable display name of the Tag.

slugstring required

URL-safe identifier derived from the Tag name.

colorstring required

Hex color code used to render the Tag (e.g. "#EF4444").

descriptionstring nullable

Optional description of the Tag.

typestring required

Tag type slug. Determines cardinality and grouping (e.g. "merchant_status", "default").

typeIdstring uuid required

UUID of the tag_types row this tag belongs to.

cardinality'single' | 'multi' required

Whether multiple tags of this type can be attached to the same dispute at once. single means at most one tag of this type per dispute; multi allows many.

createdAtstring date-time required

Date and time when the Tag was created.

updatedAtstring date-time required

Date and time when the Tag was last updated.

deletedAtstring date-time nullable

Date and time when the Tag was soft-deleted. Null if active.