Campaign cleaner

Learn how to use Campaign cleaner with Composio

Overview

SLUG: CAMPAIGN_CLEANER

Description

Campaign Cleaner is a tool designed to optimize email campaigns by ensuring compatibility across email clients, improving deliverability, and enhancing overall performance.

Authentication Details

generic_api_key
stringRequired

Connecting to Campaign cleaner

Create an auth config

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

1

Select App

Navigate to [Campaign cleaner](https://platform.composio.dev/marketplace/Campaign cleaner).

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

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Campaign cleaner toolkit’s playground](https://app.composio.dev/app/Campaign cleaner)

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=["CAMPAIGN_CLEANER"])
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: Delete Campaign

Description

Tool to delete a saved campaign by id. use when you need to remove a campaign after confirming its id.

Action Parameters

campaign
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign List

Description

Tool to list all campaigns in the account. use when you need to retrieve campaign listings for reporting or management.

Action Parameters

page
integer
page_size
integer
search
string
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Download Campaign PDF Analysis

Description

Tool to download a pdf analysis report for a processed campaign. use after a campaign has been processed.

Action Parameters

campaign
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Status

Description

Tool to check the processing status of a submitted campaign. use after submitting a campaign to monitor its progress.

Action Parameters

campaign
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired