Pular para o conteúdo principal
POST
Criar segmento por filtros

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.

Corpo

application/json
name
string
obrigatório

Nome do segmento. Se já estiver em uso, a Bevits acrescenta um número ao final.

Required string length: 1 - 200
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}.

description
string
Maximum string length: 1000
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
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

Segmento criado.

object
string
obrigatório
Allowed value: "segment_write"
segment
object
obrigatório
next_step
string
obrigatório