Saltar al contenido principal
POST
Crear segmento por interacción con campañas

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.

Cuerpo

application/json
campaign_ids
string[]
requerido

IDs de las campañas de WhatsApp Oficial (tcp_...), hasta 50.

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

engaged: leyó el mensaje o hizo clic en uno de sus enlaces. not_engaged: el mensaje fue entregado y la persona no lo leyó ni hizo clic. received: el mensaje fue entregado.

Opciones disponibles:
engaged,
not_engaged,
received
name
string
requerido

Nombre del segmento. Si ya está en uso, Bevits agrega un número al final.

Required string length: 1 - 200
purchases
enum<string>

Mantiene a quienes no tienen (none) o tienen (any) una compra concluida en el período. Exige purchases_from.

Opciones disponibles:
none,
any
purchases_from
string<date-time>

Inicio del período de compras (inclusivo), en ISO 8601 con zona horaria.

purchases_to
string<date-time>

Fin del período de compras (exclusivo), en ISO 8601 con zona horaria. Sin él, el período queda abierto.

only_site_base
boolean
predeterminado:true

Si es true (por defecto), deja fuera a los clientes que pertenecen solo a las unidades físicas, como en las campañas de la marca.

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

Segmento por interacción creado.

object
string
requerido
Allowed value: "campaign_engagement_segment"
segment
object
requerido
customers_added
integer
requerido
Rango requerido: x >= 0
reachable_count
integer
requerido
Rango requerido: x >= 0
breakdown
object
requerido
snapshot_at
string<date-time>
requerido
next_step
string
requerido