Skip to main content
PATCH
Update Tag

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

tagId
string<uuid>
required

Identifier of the resource in Payrails.

Body

application/json
name
string
required

New display name.

color
string
required

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

description
string | null

Updated description.

Response

Tag updated.

id
string<uuid>
required

Unique identifier of the Tag.

name
string
required

Human-readable display name of the Tag.

slug
string
required

URL-safe identifier derived from the Tag name.

color
string
required

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

type
string
required

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

typeId
string<uuid>
required

UUID of the tag_types row this tag belongs to.

cardinality
enum<string>
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.

Available options:
single,
multi
createdAt
string<date-time>
required

Date and time when the Tag was created.

updatedAt
string<date-time>
required

Date and time when the Tag was last updated.

workspaceId
string<uuid> | null

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

description
string | null

Optional description of the Tag.

deletedAt
string<date-time> | null

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

Last modified on October 1, 2026