Campaigns
Campaign drafts and scheduled campaign runs. 15 endpoints under /v1/campaigns.
Endpoints
| Endpoint | What it does |
|---|---|
GET /v1/campaigns | List campaigns |
POST /v1/campaigns | Create a campaign |
GET /v1/campaigns/{id} | Get a campaign |
PATCH /v1/campaigns/{id} | Update a campaign |
POST /v1/campaigns/{id}/archive | Archive a campaign |
GET /v1/campaigns/{id}/runs | List campaign runs |
POST /v1/campaigns/{id}/runs | Schedule a campaign run |
GET /v1/campaigns/{id}/runs/{runId} | Get a campaign run |
POST /v1/campaigns/{id}/runs/{runId}/cancel | Cancel a campaign run |
POST /v1/campaigns/{id}/runs/{runId}/pause | Pause a campaign run |
GET /v1/campaigns/{id}/runs/{runId}/recipients | List campaign recipients |
GET /v1/campaigns/{id}/runs/{runId}/report | Get a campaign run report |
POST /v1/campaigns/{id}/runs/{runId}/resume | Resume a campaign run |
POST /v1/campaigns/preview | Preview a campaign email |
POST /v1/campaigns/test-send | Send a campaign test |
Base URL, authentication, errors, and pagination are the same for every endpoint; see the REST API reference.