API reference
campaigns
11 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| GET | /v1/campaigns/segments | Your saved audience segments. | campaigns.view |
| POST | /v1/campaigns/segments | Save a new audience segment. | campaigns.manage |
| GET | /v1/campaigns/segments/fields | The filter vocabulary, its value lists and the magic tags. | campaigns.view |
| POST | /v1/campaigns/segments/preview | How many people this reaches, who they are, and who it leaves out. | campaigns.view |
| DELETE | /v1/campaigns/segments/{segmentId} | Archive a segment. | campaigns.manage |
| GET | /v1/campaigns/segments/{segmentId} | One saved segment. | campaigns.view |
| PATCH | /v1/campaigns/segments/{segmentId} | Rename a segment or change its filters. | campaigns.manage |
| GET | /v1/campaigns/suppressions | Addresses that must not receive marketing. | campaigns.view |
| POST | /v1/campaigns/suppressions | Add an address to the suppression list. | campaigns.manage |
| POST | /v1/campaigns/unsubscribe | Leave a marketing list. No account needed. | No API key |
| POST | /v1/webhooks/campaign-events | Ingest a signed delivery event from the e-mail provider. | No API key |