EmailOctopus API
14 endpoints for EmailOctopus, each at its own method and path, called with your API key. Open an endpoint for its inputs, examples and response.
- Base URL
- https://cotlet.dev/api/v1/emailoctopus
- Connects with
- Your own EmailOctopus login. What your agent can do follows your access level: an Analyst can only view reports. You sign in in your own browser and keep your 2-step verification.
- Integration page
- EmailOctopus
Read (6)
Return data and change nothing in the account.
| Endpoint | Description |
|---|---|
| GET | Lists of your EmailOctopus account with their subscribed, pending and unsubscribed counts. |
| GET | Contacts of one list with status, tags and dates, filtered by status, tag, segment or email address. |
| GET | Saved segments of a list with the conditions each one is built from. |
| GET | Campaigns with status, subject, list, how many contacts they were sent to and open and click rates. |
| GET | Report of one sent campaign: sent, opened, clicked, unsubscribed, bounced and complained, plus links clicked. |
| GET | Contacts who opened, clicked, unsubscribed, bounced or complained on a campaign, or did not open or click. |
Write (8)
Change the account. Calls marked Confirm wait for the user to approve them.
| Endpoint | Description |
|---|---|
| POST | Create a reusable segment on a list from conditions on tags, fields, dates, source or campaign and contact activity. |
| POST | Make a draft copy of a campaign, like Duplicate in the Campaigns tab. |
| PATCH | Change the name, subject, preview text or sender of a draft campaign. |
| PUT | Choose who a draft campaign goes to: a whole list, a saved segment or a tag. |
| POST | Schedule a draft campaign for a date, time and timezone. |
| POST | Send a draft campaign right away. |
| POST | Stop a scheduled campaign from sending, like Unschedule in the Campaigns tab. |
| POST | Mark contacts as unsubscribed in bulk, by segment, tag or email addresses. |