Ricky logorickyDocs

Cambiar etiquetas de muchos contactos

POST
/contacts/tags

Agrega y quita las mismas etiquetas en hasta 100 contactos y responde un resultado por contacto, en orden. Un ID de etiqueta que la organización no tiene rechaza toda la solicitud antes de cambiar algún contacto.

Permiso: contacts: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 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

Agrega y quita las mismas etiquetas en muchos contactos. Sus demás etiquetas se mantienen.

contact_ids*array<>

Contactos que cambiar, hasta 100. Los IDs repetidos cuentan una vez.

Elementos1 <= items <= 100
add_tag_ids?array<>

Etiquetas que agregar. Consulta GET /tags.

Elementositems <= 30
Predeterminado[]
remove_tag_ids?array<>

Etiquetas que quitar.

Elementositems <= 30
Predeterminado[]

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*array<>
next_cursor*|

Pásalo como cursor para la página siguiente; null en la última página.

curl -X POST 'https://getricky.ai/api/v1/contacts/tags' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "contact_ids": [    "3f6c2b1e-8d4a-4b7e-9a51-2c7d8e9f0a1b"  ],  "add_tag_ids": [    "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f"  ]}'
{  "data": [    {      "contact_id": "3f6c2b1e-8d4a-4b7e-9a51-2c7d8e9f0a1b",      "status": "updated",      "tags": [        {          "id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",          "name": "Cliente frecuente",          "color": "gray"        }      ]    }  ],  "next_cursor": "string"}