get_campaign
Get Campaign
Retrieve details of a specific campaign including status, subject, sender info, target lists, and HTML content.
get_campaign
Retrieve details of a specific campaign including status, subject, sender info, target lists, and HTML content.
manage_fields
Create, update, or delete custom fields on a contact list. Custom fields store additional contact data (e.g., first name, company). Supported types: TEXT, NUMBER, DATE. Use **action** to specify the operation: `create`, `update`, or `delete`. Existing fields can be viewed using the Get List tool.
list_campaigns
Retrieve all email campaigns. Returns campaign details including status, subject, sender info, and target lists. Campaigns are read-only via the API.
get_campaign_report
Retrieve performance reports for a sent campaign. Get aggregate summary metrics (opens, clicks, bounces, complaints, unsubscribes), per-link click data, or contact-level interaction reports filtered by status.
list_lists
Retrieve all contact lists in the account. Returns list details including name, custom fields, tags, and contact counts by status (pending, subscribed, unsubscribed). Supports cursor-based pagination.
create_contact
Add a new contact to a list with an email address, optional custom field values, tags, and subscription status. If the list has double opt-in enabled, the contact will receive a confirmation email.
batch_update_contacts
Update multiple contacts in a single request. Each contact update can modify email address, custom fields, tags, and status. Returns both succeeded and failed updates with error details.
get_list
Retrieve details of a specific contact list by its ID. Returns list configuration including name, custom fields, tags, and contact counts.
get_contact
Retrieve a specific contact from a list by contact ID or MD5 hash of their lowercase email address.
delete_contact
Permanently remove a contact from a list. This action cannot be undone.
update_list
Update an existing contact list's name.
trigger_automation
Start an automation sequence for a specific contact. The automation must be configured with a "Started via API" trigger type in the EmailOctopus dashboard.
upsert_contact
Create a contact if it doesn't exist, or update it if it does (matched by email address). Useful for syncing contacts from external sources without needing to check existence first.
list_contacts
Retrieve contacts from a list. Supports filtering by subscription status, tag, and creation/update dates. Returns paginated results with up to 100 contacts per page.
manage_tags
Create, rename, delete, or list tags on a contact list. Tags are labels used for segmenting and targeting contacts. Use **action** to specify the operation: `list`, `create`, `rename`, or `delete`.
delete_list
Permanently delete a contact list and all its contacts, custom fields, and tags. This action cannot be undone.
update_contact
Update an existing contact's email address, custom field values, tags, or subscription status. Tags use a boolean map where `true` adds and `false` removes a tag.
create_list
Create a new contact list. Each list is an independent collection of contacts with its own custom fields and tags.
Manage email marketing lists, contacts, campaigns, and automations. Create, update, and delete contact lists and contacts with custom fields and tags. Bulk update contacts and upsert contacts by email. Retrieve campaign details and access campaign performance reports including opens, clicks, bounces, complaints, and unsubscribes. View contact-level and link-level campaign analytics. Trigger API-based automations for specific contacts. Receive webhooks for contact events such as creation, updates, deletions, bounces, clicks, complaints, opens, and unsubscribes.
Common questions about connecting Emailoctopus to AI agents with Metorial.