Saltar al contenido principal
POST
Agregar o quitar etiquetas de clientes

Autorizaciones

Authorization
string
header
requerido

Clave API creada en la configuración de la organización.

Encabezados

Idempotency-Key
string

Clave única de la operación. Repetir la misma clave con el mismo cuerpo devuelve la respuesta original en lugar de ejecutarla de nuevo.

Cuerpo

application/json
action
enum<string>
requerido

add agrega las etiquetas; remove las quita. Las demás etiquetas de los clientes se mantienen.

Opciones disponibles:
add,
remove
tag_ids
string[]
requerido

IDs de las etiquetas (tag_...), hasta 20.

Required array length: 1 - 20 elements
Pattern: ^tag_[A-Za-z0-9_-]+$
customer_ids
string[]
requerido

IDs de los clientes (cus_...), hasta 500 por llamada.

Required array length: 1 - 500 elements
Pattern: ^cus_[A-Za-z0-9_-]+$
operation_id
string

Identificador único opcional de esta llamada, como un UUID. Repite el mismo valor solo para reintentar la misma llamada: el reintento devuelve el primer resultado en lugar de crear de nuevo. El mismo valor con otro contenido se rechaza con 409.

Required string length: 8 - 128

Respuesta

Etiquetas de los clientes actualizadas.

object
string
requerido
Allowed value: "customer_tags"
action
enum<string>
requerido
Opciones disponibles:
add,
remove
customers
integer
requerido
Rango requerido: x >= 0
tag_ids
string[]
requerido
Pattern: ^tag_[A-Za-z0-9_-]+$
changed
integer
requerido

Vínculos entre cliente y etiqueta creados o quitados.

Rango requerido: x >= 0