Quick Start — Campaigns

​

In brief

• Prepare segment, template, and channel instance.
• Create the campaign in the dashboard or with POST /v1/campaigns.
• Send immediately or scheduled; monitor status and metrics.

​

Before you start

​

1. In the dashboard

1. Campaigns → New
2. Internal name
3. Audience: segment (recommended) or manual selection
4. Channel + instance
5. Template (MARKETING category requires a topic)
6. Send: now or date/time
7. Review preview and confirm

​

2. Create a campaign (API)

POST /v1/campaigns
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "name": "March newsletter",
  "segmentId": "clxxSegmentId",
  "channel": "email",
  "instanceId": "clxxInstanceEmail",
  "templateId": "clxxTemplateId",
  "sendAt": null
}

​

3. Query a campaign

GET /v1/campaigns/{campaignId}
Authorization: Bearer sk_live_xxxxx

​

4. List campaigns

GET /v1/campaigns?page=1&limit=20
Authorization: Bearer sk_live_xxxxx

​

Best practices

• Use segments instead of static lists when the audience changes over time.
• MARKETING templates: associate a topic and respect receiveMarketing.
• Test with a small segment or sandbox before the full send.
• Check suppressions — suppressed contacts do not receive.

​

Next steps

• Segments — Quick Start
• Suppressions — introduction
• Introduction — Contacts