Skip to main content
Campayn logo
  • Category: email newsletters
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: CAMPAYN
  • Version: 20261101_00

Tools

Slug: CAMPAYN_CREATE_CONTACTTool to create a new contact in a specific list. Use when you need to add a contact after gathering details.

Input Parameters

string
ZIP or postal code
string
City of the contact
string
required
Contact’s email address
array
List of website objects for the contact
string
State or province of the contact
string
Contact’s title or position
array
List of phone objects for the contact
array
List of social account objects for the contact
string
Mailing address of the contact
string
Company name of the contact
string
Country of the contact
integer
required
ID of the list to which the contact will be added
string
Contact’s last name
string
Contact’s first name
array
List of custom field objects
boolean
If true, the API will return an error when a duplicate contact exists

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_DELETE_CONTACTTool to delete a specific contact. Use when you need to remove a contact permanently after confirming it should be deleted. Example: “Delete contact 123”.

Input Parameters

integer
required
The unique numeric ID of the contact to delete. Can be obtained from the Get Contacts action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_DELETE_LISTTool to delete a specific contact list. Use when cleaning up unused lists after confirming they are no longer needed. Example: “Delete list 123”.

Input Parameters

integer
required
ID of the contact list to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_DELETE_WEBFORMDeletes a specified webform from a Campayn contact list using the list ID and webform ID. Use Get Webforms to find these IDs. The API may report success even if the webform does not exist.

Input Parameters

integer
required
ID of the contact list the webform belongs to. Get this from the Get Lists or Get Webforms action.
integer
required
ID of the webform to delete. Get this from the Get Webforms action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_CONTACTTool to retrieve a specific contact by ID. Use when you need to fetch full contact details after confirming the contact ID.

Input Parameters

integer
required
ID of the contact to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_CONTACTSRetrieves all contacts from a specific contact list in Campayn. Returns contact details including email, name, address, and confirmation status. Use ‘Get Lists’ action first to obtain the list_id. Supports optional filtering by contact name/email/company.

Input Parameters

integer
required
The unique ID of the contact list to retrieve contacts from. Use ‘Get Lists’ action first to obtain valid list IDs.
string
Optional keyword to filter contacts by name, email, or company. Case-insensitive partial match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_LISTSTool 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”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_MESSAGERetrieves engagement statistics for a specific email message by ID, including views, positive responses, and negative responses. It reports an error when all statistics are absent or null.

Input Parameters

integer
required
The unique ID of the email message to retrieve statistics for. Use GET_MESSAGES to find available message IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_MESSAGESTool to retrieve all email messages. Use when you need to list all messages visible to the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_REPORTSTool 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.

Input Parameters

integer
End date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter ‘to’.
integer
Start date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter ‘from’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_WEBFORMRetrieves a specific webform within a contact list using the list ID and webform ID. Returns details including title, type, HTML, and signup count.

Input Parameters

integer
required
The unique identifier of the contact list that contains the webform. Use CAMPAYN_GET_LISTS to find available list IDs.
integer
required
The unique identifier of the webform to retrieve. Use CAMPAYN_GET_WEBFORMS to find available webform IDs for a list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_GET_WEBFORMSTool 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”.

Input Parameters

integer
required
ID of the list to retrieve webforms from.
string ("0" | "1" | "2" | "3")
Filter forms by type: 0=Signup Page, 1=Embed Signup, 2=WordPress Signup, 3=Facebook Signup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_UNSUBSCRIBE_CONTACTTool to unsubscribe contacts from a list by contact id or email address. Use when you need to remove contacts from a mailing list. If id is provided, only that specific contact will be unsubscribed. If email is provided, all contacts on that list with that email will be unsubscribed.

Input Parameters

string
The contact ID to unsubscribe. Use this to unsubscribe a specific single contact. Provide either id or email, not both.
string
The email address to unsubscribe. Use this to unsubscribe all contacts on the list with this email. Provide either id or email, not both.
integer
required
The ID of the list from which to unsubscribe contacts

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CAMPAYN_UPDATE_LISTTool to update a contact list. Use after confirming list ID and desired changes. Example: Update list 123 name to ‘Newsletter Subscribers’.

Input Parameters

string
Comma-separated tags to assign to the list. Omit if not changing tags.
integer
required
ID of the contact list to update.
string
New name for the contact list. Omit if not changing the name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not