Crear campaña

POST

/v1/bulk/campaigns

curl --request POST \
  --url https://api.mailerdash.com/v1/bulk/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "template_id": "example", "list_id": "example", "from_email": "example", "from_name": "example", "reply_to": "example", "preference_category": "example", "segment_id": "promos" }'

• Production
• Local development

Authorizations

• BearerAuth

Request Body ^required

Media type application/json

object

name

required

string

template_id

required

string

list_id

required

string

from_email

required

string

from_name

string

reply_to

string

preference_category

Slug de una categoría del centro de preferencias (ver /v1/client/preference-categories). Los destinatarios que se dieron de baja de esa categoría no reciben la campaña.

string

nullable

segment_id

Segmento que ACOTA la lista. NULL = la lista entera. El segmento nunca reemplaza a la lista: la pertenencia a la lista es la que carga el consentimiento (doble opt-in), así que un segmento solo puede quitar destinatarios. Omitir o null = campaña sin clasificar: sale a todos los que no estén suprimidos, igual que siempre.

string

nullable

Example

promos

Responses

201

Campaña creada

Media type application/json

object

id

string

name

string

key_id

string

template_id

string

list_id

string

from_email

string

from_name

string

nullable

reply_to

string

nullable

segment_id

Segmento que acota la lista. NULL = la lista entera.

string

nullable

resend_of_campaign_id

Si viene poblado, esta campaña es un reenvío a quienes no abrieron la campaña indicada. NULL = campaña normal.

string

nullable

status

string

Allowed values: draft scheduled sending sent paused cancelled

scheduled_at

string

nullable

started_at

string

nullable

completed_at

string

nullable

total_contacts

integer

sent_count

integer

failed_count

integer

created_at

string

updated_at

string

Example

{
  "id": "cmp-d894cd3d626d9d11",
  "status": "draft"
}

400

Campos requeridos faltantes

401

No autorizado

404

Plantilla o lista no encontrada