Campayn

Learn how to use Campayn with Composio

Overview

Enum

CAMPAYN

Description

Campayn is an email marketing platform that allows users to create, send, and manage email campaigns.

Authentication Details

api_key
stringRequired

Actions

Tool to create a new contact in a specific list. use when you need to add a contact after gathering details.

Action Parameters

address
string
city
string
company
string
country
string
custom_fields
array
email
stringRequired
failOnDuplicate
boolean
first_name
string
last_name
string
list_id
integerRequired
phones
array
sites
array
social
array
state
string
title
string
zip
string

Action Response

data
object
error
string
successful
boolean
Tool to delete a specific contact. use when you need to remove a contact permanently after confirming it should be deleted. example: "delete contact 123".

Action Parameters

contact_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a specific contact list. use when cleaning up unused lists after confirming they are no longer needed. example: "delete list 123".

Action Parameters

list_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to delete a specific webform. use when removing outdated or unnecessary webforms after confirming they are no longer needed. example: "delete webform 123".

Action Parameters

list_id
integerRequired
webform_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve a specific contact by id. use when you need to fetch full contact details after confirming the contact id.

Action Parameters

contact_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve all contacts in a specified list. use when you need to fetch list contacts after confirming list id.

Action Parameters

filter[contact]
string
list_id
integerRequired

Action Response

data
array
error
string
successful
boolean
Tool to retrieve a specific contact list by id. use when you need to fetch list details like name, tags, and contact count after knowing the list id.

Action Parameters

list_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve all contact lists. use when you need to fetch available lists before performing list-specific actions. example prompt: "list all my contact lists".

Action Parameters

Action Response

data
array
error
string
successful
boolean
Tool to retrieve details of a specific message by id. use when you need to fetch full message details after confirming the message id.

Action Parameters

message_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve all email messages. use when you need to list all messages visible to the authenticated user.

Action Parameters

Action Response

data
array
error
string
successful
boolean
Tool to retrieve report urls and metadata for sent and scheduled emails. use when you need to fetch email delivery data, optionally filtered by a date range (unix timestamp in seconds, utc). note: scheduled emails will have report url set to null.

Action Parameters

from_time
integer
to
integer

Action Response

data
array
error
string
successful
boolean
Tool to retrieve details of a specific webform by id. use after confirming the webform id when you need to fetch form details like title, type, html, and signup count. example: "get webform 1550".

Action Parameters

list_id
integerRequired
webform_id
integerRequired

Action Response

data
object
error
string
successful
boolean
Tool to retrieve all webforms for a specific contact list. use when you need to list forms after confirming the list id. example prompt: "list all webforms in list 123".

Action Parameters

filter[form_type]
string
list_id
integerRequired

Action Response

data
array
error
string
successful
boolean
Tool to update a contact list. use after confirming list id and desired changes. example: update list 123 name to 'newsletter subscribers'.

Action Parameters

list_id
integerRequired
list_name
string
tags
string

Action Response

data
object
error
string
successful
boolean