Ricky logorickyDocs

Actualizar una etiqueta

PATCH
/tags/{tag_id}

Cambia el nombre o el color de una etiqueta en todos los contactos que la tienen. Un nombre ya usado, en mayúsculas o minúsculas, responde 409 conflict.

Permiso: tags:write.

Autorización

bearerAuth
headerAuthorizationBearer <clave>

Una clave de API de la organización, rky_live_…, creada en Configuración → API. Envíala solo desde un servidor.

Parámetros de ruta

tag_id*string

ID de la etiqueta.

Formatouuid

Parámetros de cabecera

Idempotency-Key?string

Opcional. Un valor que eliges, único por escritura lógica, de 8 a 200 caracteres: un UUID o un ID de tu sistema, como order-10482-ready. Reintentar con la misma clave y el mismo cuerpo repite la primera respuesta en lugar de repetir la escritura.

Longitud8 <= length <= 200

Cuerpo de la solicitud

application/json
  1. body

Solo cambian los campos que envías, en todos los contactos que tienen la etiqueta.

name?string

Nombre visible, único en la organización sin importar mayúsculas o minúsculas.

Longitud1 <= length <= 40
color?string

Color visible.

Uno de"gray""red""orange""amber""green""teal""blue""indigo""purple""pink"

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Una etiqueta que se aplica a contactos.

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"  }}