MepMail Docs
Referência da APIEndpointsBroadcasts

Create a broadcast

POST
/broadcasts

Creates a broadcast to a segment, and schedules it when send is true.

AuthorizationBearer <token>

An API key from the dashboard (ms_…), sent as Authorization: Bearer. A sending-only key reaches the /emails routes only.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/broadcasts" \  -H "Content-Type: application/json" \  -d '{    "name": "October newsletter",    "segment_id": "8c1d4e2f-0a3b-4c5d-9e6f-7a8b9c0d1e2f",    "topic_id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",    "from": "Acme <news@yourdomain.com>",    "subject": "What is new in October",    "html": "<p>Here is what changed this month.</p>",    "send": false  }'
{  "id": "ae2014de-c168-4c61-8267-70d2662a1ce1",  "finishes_at": "2026-10-19T12:00:00.000Z",  "estimated": true,  "warning": {    "code": "paced",    "days": 1,    "message": "A human-readable explanation"  }}