Skip to main content
PATCH
Update tag

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Tag sid (cr_tg_…).

Required string length: 18
Pattern: ^cr_tg_

Body

application/json

Request body of update_tag.

name
string

New label; re-checked case-insensitively against live tags - 409 duplicate_rejected on collision.

Required string length: 1 - 255
color
string | null

New chip color "#rrggbb" (lowercase hex); null resets to the client default palette.

Required string length: 7
Pattern: ^#[0-9a-f]{6}$

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.