Ricky logorickyDocs

Update a tag

PATCH
/tags/{tag_id}

Renames or recolors a tag on every contact that has it. A name already in use, in any case, answers 409 conflict.

Scope: tags:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Path Parameters

tag_id*string

Tag ID.

Formatuuid

Header Parameters

Idempotency-Key?string

Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as order-10482-ready. Retrying with the same key and body replays the first response instead of repeating the write.

Length8 <= length <= 200

Request Body

application/json
  1. body

Only the fields you send change, on every contact that has the tag.

name?string

Display name, unique in the organization regardless of case.

Length1 <= length <= 40
color?string

Display color.

Value in"gray""red""orange""amber""green""teal""blue""indigo""purple""pink"

Response Body

Success.

application/json
  1. response
data*

A label applied to contacts.

curl -X PATCH 'https://getricky.ai/api/v1/tags/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "name": "Cliente VIP",  "color": "purple"}'
{  "data": {    "id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",    "name": "Cliente frecuente",    "color": "gray"  }}