⚠️ Legacy Notice

This version of the API (v1) is now considered legacy and is no longer actively maintained. We recommend migrating to [API v2](/content/api-documentation/v2 "API v2"/index.html) for new features, improvements, and ongoing support.

Use our API to give an application or website permission to interact with your EmailOctopus account.

Requests

• All requests require a valid API key.
• Requests should be made using HTTPS.
• JSON objects are recommended for POST requests, but form parameters are also accepted.
• If you're making a JSON request, include a Content-Type: application/json header.
• All parameters are required unless otherwise specified.

Response

• Data returned in JSON.
• Any non-200 HTTP response code can be considered an error.

Methods

Automations

• Start automation

Campaigns

• Get campaign

• Get all campaigns

• Get campaign report: summary

• Get campaign report: links

• Get campaign report: bounced

• Get campaign report: clicked

• Get campaign report: complained

• Get campaign report: opened

• Get campaign report: sent

• Get campaign report: unsubscribed

• Get campaign report: not clicked

• Get campaign report: not opened

Lists

• Get list

• Get all lists

• Create list

• Update list

• Delete list

• Get all tags on list

• Get contact of list

• Get all contacts of list

• Get subscribed contacts of list

• Get unsubscribed contacts of list

• Get contacts of list by tag

• Create contact of list

• Update contact of list

• Delete contact of list

• Update multiple contacts of list

• Create list field

• Update list field

• Delete list field

• Create list tag

• Update list tag

• Delete list tag