Ir al contenido

Inscribir todos los contactos activos de una lista (idempotente)

POST
/v1/bulk/sequences/{id}/enroll
curl --request POST \
--url https://api.mailerdash.com/v1/bulk/sequences/example/enroll \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "list_id": "example" }'

Suscribe a la secuencia cada contacto con status=active de la lista indicada. Es idempotente (contactos ya suscritos en active/paused no se duplican) y salta contactos suprimidos (cuenta o plataforma). Corre síncrono, acotado por un tope interno de contactos por corrida; si la lista lo excede, la respuesta trae truncated: true.

id
required
string
Media type application/json
object
list_id
required
string
Example generated
{
"list_id": "example"
}

Resultado de la inscripción masiva

Media type application/json
object
enrolled

Nuevas suscripciones creadas

integer
already_in

Ya suscritos (active/paused), sin cambios

integer
skipped_terminal

Suscripción previa en estado terminal, no reinscritos

integer
suppressed

Saltados por supresión (cuenta o plataforma)

integer
total

Total de contactos activos en la lista

integer
truncated

True si la lista excede el tope por corrida

boolean
Example generated
{
"enrolled": 1,
"already_in": 1,
"skipped_terminal": 1,
"suppressed": 1,
"total": 1,
"truncated": true
}

Validacion (falta list_id, secuencia inactiva o sin steps)

Secuencia o lista no encontrada