Pular para o conteúdo principal
POST
Adicionar clientes ao segmento

Autorizações

Authorization
string
header
obrigatório

API key criada nas configurações da organização.

Cabeçalhos

Idempotency-Key
string

Chave única da operação. Repetir a mesma chave com o mesmo corpo devolve a resposta original em vez de executar de novo.

Parâmetros de caminho

segment_id
string
obrigatório

ID público do segmento.

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

Corpo

application/json
customer_ids
string[]
obrigatório

IDs dos clientes (cus_...), até 500 por chamada.

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

Identificador único opcional desta chamada, como um UUID. Repita o mesmo valor só para tentar de novo a mesma chamada: a nova tentativa devolve o primeiro resultado em vez de criar de novo. O mesmo valor com outro conteúdo é recusado com 409.

Required string length: 8 - 128

Resposta

Clientes do segmento atualizados.

object
string
obrigatório
Allowed value: "segment_membership"
segment
object
obrigatório
action
enum<string>
obrigatório
Opções disponíveis:
add,
remove
changed
integer
obrigatório

Clientes que mudaram. Ao adicionar, quem já estava no segmento não conta.

Intervalo obrigatório: x >= 0
next_step
string
obrigatório