Ir al contenido

Suscribir un contacto (idempotente)

POST
/v1/bulk/sequences/{id}/subscribers
curl --request POST \
--url https://api.mailerdash.com/v1/bulk/sequences/example/subscribers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email": "example", "started_at": "example", "variables": {} }'
id
required
string
Media type application/json
object
email
required
string
started_at
string
variables
object
Example generated
{
"email": "example",
"started_at": "example",
"variables": {}
}

Ya suscrito (activa/pausada) — devuelve la suscripción existente

Media type application/json

Suscripción de un contacto a una secuencia drip (row de sequence_subscriptions)

object
id
integer
sequence_id
string
key_id
string
contact_email
string
started_at
string format: date-time
current_step
integer
next_send_at
string format: date-time
nullable
status
string
Allowed values: active paused completed cancelled unsubscribed bounced failed
variables_json

JSON string con variables de personalización

string
retry_count
integer
last_sent_at
string format: date-time
nullable
completed_at
string format: date-time
nullable
cancelled_at
string format: date-time
nullable
cancel_reason
string
nullable
created_at
string format: date-time
updated_at
string format: date-time
Example
{
"status": "active"
}

Suscrito — nueva suscripción creada

Media type application/json

Suscripción de un contacto a una secuencia drip (row de sequence_subscriptions)

object
id
integer
sequence_id
string
key_id
string
contact_email
string
started_at
string format: date-time
current_step
integer
next_send_at
string format: date-time
nullable
status
string
Allowed values: active paused completed cancelled unsubscribed bounced failed
variables_json

JSON string con variables de personalización

string
retry_count
integer
last_sent_at
string format: date-time
nullable
completed_at
string format: date-time
nullable
cancelled_at
string format: date-time
nullable
cancel_reason
string
nullable
created_at
string format: date-time
updated_at
string format: date-time
Example
{
"status": "active"
}

Validacion

Secuencia no encontrada

Suscripcion existente en estado terminal