Emailoctopus

Learn how to use Emailoctopus with Composio

Overview

Enum

EMAILOCTOPUS

Description

EmailOctopus is an email marketing platform founded in 2015, offering affordable and intuitive solutions for individuals and businesses to connect with their subscribers.

Authentication Details

api_key
stringRequired

Actions

This tool creates a new contact in emailoctopus. the tool will add a contact to a specified list with the provided information.

Action Parameters

email_address
stringRequired
fields
object
list_id
stringRequired
status
string
tags
array

Action Response

data
object
error
successful
boolean

This tool creates a new mailing list in emailoctopus. it allows users to create a new list where contacts can be added and managed.

Action Parameters

name
stringRequired

Action Response

data
object
error
successful
boolean

This tool allows you to delete a contact from a specified list in emailoctopus. it uses the delete /api/1.6/lists/{list_id}/contacts/{contact_id} endpoint to permanently remove the contact from the list. this action is irreversible and is essential for list management and data privacy compliance.

Action Parameters

contact_id
stringRequired
list_id
stringRequired

Action Response

data
object
error
successful
boolean

This 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.

Action Parameters

list_id
stringRequired

Action Response

data
object
error
successful
boolean

This tool retrieves all the mailing lists associated with the emailoctopus account.

Action Parameters

limit
integer
page
integer

Action Response

data
array
error
paging
object
successful
boolean

This tool retrieves a list of recent campaigns from the emailoctopus account. it uses the get endpoint at https://emailoctopus.com/api/1.6/campaigns and allows filtering by parameters like limit and page.

Action Parameters

limit
integer
page
integer

Action Response

data
array
error
paging
object
successful
boolean

This tool unsubscribes a contact from an emailoctopus list. it takes an email address as input, retrieves the contact’s details using the find contact functionality, and unsubscribes the contact from the associated list.

Action Parameters

email
stringRequired
list_id
stringRequired

Action Response

data
object
error
successful
boolean