Pular para o conteúdo principal
POST
Prévia de segmento

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
conditions
object[]
obrigatório

Condições do catálogo de filtros (GET /v1/segment-builder/catalog). Até 30.

Required array length: 1 - 30 elements

Uma condição de um segmento por filtros. O mesmo formato entra na criação, na atualização e na prévia e volta em GET /v1/segments/{segment_id}.

match
enum<string>

all: clientes que atendem a todas as condições. any: clientes que atendem a pelo menos uma.

Opções disponíveis:
all,
any
sample_size
integer
padrão:5

Quantidade de clientes na amostra.

Intervalo obrigatório: 0 <= x <= 20

Resposta

Prévia do segmento. Nada foi salvo.

object
string
obrigatório
Allowed value: "segment_preview"
customer_count
integer
obrigatório
Intervalo obrigatório: x >= 0
whatsapp_reachable_count
integer
obrigatório

Clientes que atendem às condições, com telefone e sem opt-out.

Intervalo obrigatório: x >= 0
email_reachable_count
integer
obrigatório

Clientes que atendem às condições, com e-mail e inscritos para receber e-mails.

Intervalo obrigatório: x >= 0
match
enum<string>
obrigatório

all: clientes que atendem a todas as condições. any: clientes que atendem a pelo menos uma.

Opções disponíveis:
all,
any
conditions
object[]
obrigatório

Uma condição de um segmento por filtros. O mesmo formato entra na criação, na atualização e na prévia e volta em GET /v1/segments/{segment_id}.

sample
object[]
obrigatório
evaluated_at
string<date-time>
obrigatório