- Category: email newsletters
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 14
- Triggers: 0
- Slug:
CAMPAYN - Version: 20261101_00
Tools
Create Contact
Create Contact
Delete Contact
Delete Contact
Delete List
Delete List
Delete webform
Delete webform
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
ID of the contact list the webform belongs to. Get this from the Get Lists or Get Webforms action.
Output
Get Contact
Get Contact
Get Contacts
Get Contacts
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
The unique ID of the contact list to retrieve contacts from. Use ‘Get Lists’ action first to obtain valid list IDs.
Optional keyword to filter contacts by name, email, or company. Case-insensitive partial match.
Output
Get Lists
Get Lists
Get Message Statistics
Get Message Statistics
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
The unique ID of the email message to retrieve statistics for. Use GET_MESSAGES to find available message IDs.
Output
Get Messages
Get Messages
Get Reports
Get Reports
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
End date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter ‘to’.
Start date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter ‘from’.
Output
Get Webform
Get Webform
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
The unique identifier of the contact list that contains the webform. Use CAMPAYN_GET_LISTS to find available list IDs.
The unique identifier of the webform to retrieve. Use CAMPAYN_GET_WEBFORMS to find available webform IDs for a list.
Output
Get Webforms
Get Webforms
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
Filter forms by type: 0=Signup Page, 1=Embed Signup, 2=WordPress Signup, 3=Facebook Signup.
Output
Unsubscribe Contact
Unsubscribe Contact
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
The contact ID to unsubscribe. Use this to unsubscribe a specific single contact. Provide either id or email, not both.
The email address to unsubscribe. Use this to unsubscribe all contacts on the list with this email. Provide either id or email, not both.