Email Marketing

Emailoctopus

Learn how to use Emailoctopus with Composio

Overview

SLUG: 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

generic_api_key
stringRequired

Connecting to Emailoctopus

Create an auth config

Use the dashboard to create an auth config for the Emailoctopus toolkit. This allows you to connect multiple Emailoctopus accounts to Composio for agents to use.

1

Select App

Navigate to the Emailoctopus toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5emailoctopus_auth_config_id = "ac_YOUR_EMAILOCTOPUS_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000"  # UUID from database/app
7
8composio = Composio()
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11    # Replace this with a method to retrieve an API key from the user.
12    # Or supply your own.
13    user_api_key = input("[!] Enter API key")
14
15    connection_request = composio.connected_accounts.initiate(
16        user_id=user_id,
17        auth_config_id=auth_config_id,
18        config={"auth_scheme": "API_KEY", "val": user_api_key}
19    )
20
21    # API Key authentication is immediate - no redirect needed
22    print(f"Successfully connected Emailoctopus for user {user_id}")
23    print(f"Connection status: {connection_request.status}")
24    
25    return connection_request.id
26
27
28connection_id = authenticate_toolkit(user_id, emailoctopus_auth_config_id)
29
30# You can verify the connection using:
31connected_account = composio.connected_accounts.get(connection_id)
32print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Emailoctopus toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["EMAILOCTOPUS"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Contact

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Create List

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Contact

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete List

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Lists

Description

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

Action Parameters

limit
integer
page
integer

Action Response

data
arrayRequired
error
string
paging
objectRequired
successful
booleanRequired

Tool Name: Get Recent Campaigns

Description

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
arrayRequired
error
string
paging
objectRequired
successful
booleanRequired

Tool Name: Unsubscribe Contact

Description

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
objectRequired
error
string
successful
booleanRequired