- Category: email newsletters
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 20
- Triggers: 0
- Slug:
EMAILOCTOPUS - Version: 20261101_00
Tools
Create Contact
Create Contact
Slug:
EMAILOCTOPUS_CREATE_CONTACTThis tool creates a new contact in EmailOctopus. The tool will add a contact to a specified list with the provided information.Input Parameters
Custom field values for the contact. Keys should be field tags (e.g., ‘FirstName’, ‘LastName’). Use the ‘Get All Lists’ action to see available field tags for a list.
The subscription status of the contact. Accepted values: ‘subscribed’, ‘unsubscribed’, or ‘pending’ (case-insensitive). Defaults to ‘subscribed’ if not provided.
The unique identifier (UUID) of the EmailOctopus list to add the contact to. Use the ‘Get All Lists’ action to retrieve available list IDs.
Output
Create Field
Create Field
Slug:
EMAILOCTOPUS_CREATE_FIELDTool to create a new custom field on an EmailOctopus mailing list. Use when you need to add additional data fields beyond the default Email, First Name, and Last Name fields.Input Parameters
The tag used to reference this field in templates and API calls (e.g., ‘Company’, ‘PhoneNumber’). Should be unique within the list.
The data type of the custom field. Use ‘text’ for strings, ‘number’ for numeric values, or ‘date’ for dates.
The display label for the custom field (e.g., ‘Company’, ‘Phone Number’). This is what users will see in forms and settings.
The unique identifier (UUID) of the EmailOctopus list to add the custom field to. Use the ‘Get All Lists’ action to retrieve available list IDs.
Default value to use when the field is empty. This value will be used in email templates when no value is provided for a contact.
Output
Create List
Create List
Create Tag
Create Tag
Slug:
EMAILOCTOPUS_CREATE_TAGTool to create a new tag on an EmailOctopus mailing list. Use when you need to add a new tag for contact segmentation and filtering purposes.Input Parameters
The name of the tag to create. Used for segmentation and filtering contacts within the list.
The unique identifier (UUID) of the EmailOctopus list to create the tag in. Use the ‘Get All Lists’ action to retrieve available list IDs.
Output
Delete Contact
Delete Contact
Slug:
EMAILOCTOPUS_DELETE_CONTACTPermanently deletes a contact from a specified EmailOctopus list. This action is irreversible - once deleted, the contact and all associated data will be removed from the list. Use this for list management, honoring deletion requests, and data privacy compliance (e.g., GDPR right to erasure).Input Parameters
The unique identifier (UUID) of the EmailOctopus list containing the contact. Use the ‘Get All Lists’ action to retrieve available list IDs.
The unique identifier (UUID) of the contact to delete, or an MD5 hash of the lowercase version of the contact’s email address. Use the ‘Create Contact’ action response or list contacts to find contact IDs.
Output
Delete Field
Delete Field
Slug:
EMAILOCTOPUS_DELETE_FIELDPermanently deletes a custom field from a specified EmailOctopus list. This action is irreversible - once deleted, the field and all associated data will be removed from the list. Use this for list customization and field management.Input Parameters
A unique identifier for the custom field to delete (e.g., ‘Hometown’, ‘TestDeleteField’). This is the field tag, not the field name.
The unique identifier (UUID) of the EmailOctopus list containing the field. Use the ‘Get All Lists’ action to retrieve available list IDs.
Output
Delete List
Delete List
Slug:
EMAILOCTOPUS_DELETE_LISTThis tool allows you to delete an existing mailing list from your EmailOctopus account. Once a list is deleted, it cannot be recovered, and all contacts within the list will be permanently removed. Note: Lists can only be deleted if no contacts within the list have received an email in the last 7 days.Input Parameters
Output
Delete Tag
Delete Tag
Get All Lists
Get All Lists
Slug:
EMAILOCTOPUS_GET_ALL_LISTSRetrieves a page of mailing lists associated with the EmailOctopus account. Use the returned pagination cursor to fetch further pages.Input Parameters
Cursor for pagination. Use the ‘starting_after’ value from the previous response’s paging.next object to retrieve the next page of results.
Output
Get Contact
Get Contact
Slug:
EMAILOCTOPUS_GET_CONTACTTool to retrieve details of a specific contact from an EmailOctopus list. Use when you need to fetch contact information including email, fields, tags, and subscription status.Input Parameters
The unique identifier (UUID) of the EmailOctopus list containing the contact. Use the ‘Get All Lists’ action to retrieve available list IDs.
The unique identifier (UUID) of the contact, or an MD5 hash of the lowercase version of the contact’s email address.
Output
Get List
Get List
Get Recent Campaigns
Get Recent Campaigns
List Contacts
List Contacts
Slug:
EMAILOCTOPUS_LIST_CONTACTSTool to retrieve contacts from an EmailOctopus list. Returns a paginated list of contacts with optional filtering by tag, status, and date ranges.Input Parameters
Filter contacts by subscription status. Defaults to ‘subscribed’ if not specified.
The unique identifier (UUID) of the EmailOctopus list. Use the ‘Get All Lists’ action to retrieve available list IDs.
Filter by creation date - greater than or equal to. Must be in ISO 8601 format (e.g., 2024-01-19T12:14:28Z).
Filter by creation date - less than or equal to. Must be in ISO 8601 format (e.g., 2024-01-19T12:14:28Z).
Cursor token for pagination. Use the ‘starting_after’ value from the previous response’s paging.next to fetch the next page.
Filter by last update date - greater than or equal to. Must be in ISO 8601 format (e.g., 2024-01-19T12:14:28Z).
Filter by last update date - less than or equal to. Must be in ISO 8601 format (e.g., 2024-01-19T12:14:28Z).
Output
Unsubscribe Contact
Unsubscribe Contact
Slug:
EMAILOCTOPUS_UNSUBSCRIBE_CONTACTUnsubscribes a contact from an EmailOctopus mailing list. This tool updates the contact’s subscription status to ‘unsubscribed’, which stops them from receiving future emails from the specified list. The contact record is preserved but marked as unsubscribed.Input Parameters
The unique identifier (UUID) of the EmailOctopus list containing the contact. Use ‘Get All Lists’ to retrieve available list IDs.
The unique identifier (UUID) of the contact to unsubscribe. Use ‘Get All Contacts’ or ‘Create Contact’ to obtain contact IDs.
Output
Batch Update Contacts
Batch Update Contacts
Slug:
EMAILOCTOPUS_UPDATE_CONTACTS_BATCHTool to update multiple contacts in an EmailOctopus list in a single batch operation. Use when you need to efficiently update multiple contacts at once with changes to their email, fields, status, or tags.Input Parameters
The unique identifier (UUID) of the EmailOctopus list containing the contacts to update. Use ‘Get All Lists’ to retrieve available list IDs.
Array of contacts to update. Each contact must have an ‘id’ field. Other fields (email_address, fields, status, tags) are optional and will only update if provided.
Output
Update Field
Update Field
Slug:
EMAILOCTOPUS_UPDATE_FIELDUpdates an existing custom field on an EmailOctopus list including its label, tag, type, and fallback value. Use this action to modify field properties or rename field tags. Note that changing the tag will affect how the field is referenced in email templates.Input Parameters
The tag identifier for the field. This can be the same as current_tag to keep it unchanged, or a new value to rename the field tag. Must be a unique identifier.
The type of the field. Determines what kind of data can be stored.
A human-readable label for the field. This is what users will see when filling out forms.
The unique identifier (UUID) of the list containing the field to update. Use the ‘Get All Lists’ action to retrieve available list IDs.
A default value for the field, used in campaigns when there is no other value available. Set to null or omit to remove the fallback value.
The current tag identifier of the field to update (e.g., ‘Hometown’, ‘TestUpdateField’). This identifies which field to update.
Output
Update List
Update List
Update Tag
Update Tag
Create or Update Contact
Create or Update Contact
Slug:
EMAILOCTOPUS_UPSERT_CONTACTTool to create or update a contact in EmailOctopus. If the contact does not exist, it will be created. If the contact already exists, it will be updated. Use when you need to ensure a contact exists with specific information regardless of whether they’re already in the list.Input Parameters
An object containing key/value pairs for tag management. Set tag name as key and true to add the tag or false to remove it. Tags not referenced in this object will not be updated.
Custom field values for the contact. Keys should be field tags (e.g., ‘FirstName’, ‘LastName’). Values can be text (string), number (integer), date (string in ISO format), or null to unset a field. Use the ‘Get All Lists’ action to see available field tags for a list.
The subscription status of the contact. Accepted values: ‘subscribed’, ‘unsubscribed’, or ‘pending’ (case-insensitive). If not provided, defaults to the contact’s current status (for updates) or ‘subscribed’ (for new contacts).
The unique identifier (UUID) of the EmailOctopus list. Use the ‘Get All Lists’ action to retrieve available list IDs.