Saltar al contenido principal
POST
Quitar clientes del segmento

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.

Parámetros de ruta

segment_id
string
requerido

ID público del segmento.

Pattern: ^seg_[A-Za-z0-9_-]+$

Cuerpo

application/json
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

Clientes del segmento actualizados.

object
string
requerido
Allowed value: "segment_membership"
segment
object
requerido
action
enum<string>
requerido
Opciones disponibles:
add,
remove
changed
integer
requerido

Clientes que cambiaron. Al agregar, quienes ya estaban en el segmento no cuentan.

Rango requerido: x >= 0
next_step
string
requerido