API reference
zinn-campaigns
8 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/email-marketing | Zinn® Campaigns overview for one organisation. | email_marketing.view |
| GET | /v1/email-marketing/contacts | The organisation's contacts, one keyset page at a time. | email_marketing.view |
| GET | /v1/email-marketing/imports | Past contact imports, newest first, one keyset page at a time. | email_marketing.view |
| POST | /v1/email-marketing/imports | Import one chunk of contacts with its consent attestation. | email_marketing.manage |
| GET | /v1/email-marketing/senders | The organisation's sending connections. | email_marketing.view |
| POST | /v1/email-marketing/senders | Connect the customer's own SMTP server for campaigns. | email_marketing.manage |
| DELETE | /v1/email-marketing/senders/{sender_id} | Remove a sending connection and its stored password. | email_marketing.manage |
| POST | /v1/email-marketing/senders/{sender_id}/verify | Prove a sending connection works, without sending anything. | email_marketing.manage |