Pular para o conteúdo principal
POST
Criar segmento por engajamento em campanha

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
campaign_ids
string[]
obrigatório

IDs das campanhas de WhatsApp Oficial (tcp_...), até 50.

Required array length: 1 - 50 elements
Pattern: ^tcp_[A-Za-z0-9_-]+$
engagement
enum<string>
obrigatório

engaged: leu a mensagem ou clicou em um link dela. not_engaged: a mensagem foi entregue e a pessoa não leu nem clicou. received: a mensagem foi entregue.

Opções disponíveis:
engaged,
not_engaged,
received
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
purchases
enum<string>

Mantém quem não tem (none) ou tem (any) compra concluída no período. Exige purchases_from.

Opções disponíveis:
none,
any
purchases_from
string<date-time>

Início do período de compras (inclusivo), em ISO 8601 com fuso.

purchases_to
string<date-time>

Fim do período de compras (exclusivo), em ISO 8601 com fuso. Sem ele, o período fica aberto.

only_site_base
boolean
padrão:true

Se true (padrão), deixa de fora os clientes que pertencem só às unidades físicas, como nas campanhas da marca.

description
string
Maximum string length: 1000
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 por engajamento criado.

object
string
obrigatório
Allowed value: "campaign_engagement_segment"
segment
object
obrigatório
customers_added
integer
obrigatório
Intervalo obrigatório: x >= 0
reachable_count
integer
obrigatório
Intervalo obrigatório: x >= 0
breakdown
object
obrigatório
snapshot_at
string<date-time>
obrigatório
next_step
string
obrigatório