AI agents for EmailOctopus

Get a contact

Reads one contact on a list by contact ID (or the MD5 hash of the lowercase email).

List contacts

Lists a list's contacts with one status, optionally only those with a tag or created or updated in a date range, 100 at a time.

List lists

Lists the account's lists, 100 at a time.

Get a list

Reads one list, including its fields (the tags to use as keys in fields).

List tags

Lists the tags used on a list.

List campaigns

Lists campaigns, 100 at a time.

Get campaign results

Reads a campaign's summary report.

Get campaign recipients by outcome

Lists the contacts who were sent, opened, clicked, bounced, complained, unsubscribed, or did not open or click a campaign, 100 at a time.

Create or update a contact

Creates a contact on a list by email, or updates the one with that email, with field values (keyed by field tag, like FirstName), tags to add (true) or remove (false), and a status.

Unsubscribe a contact

Marks the contact with an email address as unsubscribed on a list, so campaigns and automations to that list stop (an unknown email is added as unsubscribed).

Start an automation for a contact

Starts an automation whose trigger is "Started via API" for one contact (contact ID, or the MD5 hash of the lowercase email).