> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Campayn

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

![Campayn logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/campayn.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=99b8852726e29071ff4c5db738dc66bd)

* **Category:** email newsletters
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `CAMPAYN`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Contact
>
> **Slug:** `CAMPAYN_CREATE_CONTACT`
>
> Tool to create a new contact in a specific list. Use when you need to add a contact after gathering details.
>
> #### Input Parameters
>
> **zip** `string`
>
> ZIP or postal code
>
> **city** `string`
>
> City of the contact
>
> **email** `string` *required*
>
> Contact's email address
>
> **sites** `array`
>
> List of website objects for the contact
>
> **state** `string`
>
> State or province of the contact
>
> **title** `string`
>
> Contact's title or position
>
> **phones** `array`
>
> List of phone objects for the contact
>
> **social** `array`
>
> List of social account objects for the contact
>
> **address** `string`
>
> Mailing address of the contact
>
> **company** `string`
>
> Company name of the contact
>
> **country** `string`
>
> Country of the contact
>
> **list\_id** `integer` *required*
>
> ID of the list to which the contact will be added
>
> **last\_name** `string`
>
> Contact's last name
>
> **first\_name** `string`
>
> Contact's first name
>
> **custom\_fields** `array`
>
> List of custom field objects
>
> **failOnDuplicate** `boolean`
>
> If true, the API will return an error when a duplicate contact exists
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact
>
> **Slug:** `CAMPAYN_DELETE_CONTACT`
>
> 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".
>
> #### Input Parameters
>
> **contact\_id** `integer` *required*
>
> The unique numeric ID of the contact to delete. Can be obtained from the Get Contacts action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete List
>
> **Slug:** `CAMPAYN_DELETE_LIST`
>
> Tool 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
>
> **list\_id** `integer` *required*
>
> ID of the contact list to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete webform
>
> **Slug:** `CAMPAYN_DELETE_WEBFORM`
>
> Deletes 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
>
> **list\_id** `integer` *required*
>
> ID of the contact list the webform belongs to. Get this from the Get Lists or Get Webforms action.
>
> **webform\_id** `integer` *required*
>
> ID of the webform to delete. Get this from the Get Webforms action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact
>
> **Slug:** `CAMPAYN_GET_CONTACT`
>
> Tool to retrieve a specific contact by ID. Use when you need to fetch full contact details after confirming the contact ID.
>
> #### Input Parameters
>
> **contact\_id** `integer` *required*
>
> ID of the contact to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contacts
>
> **Slug:** `CAMPAYN_GET_CONTACTS`
>
> Retrieves 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
>
> **list\_id** `integer` *required*
>
> The unique ID of the contact list to retrieve contacts from. Use 'Get Lists' action first to obtain valid list IDs.
>
> **filter\_contact** `string`
>
> Optional keyword to filter contacts by name, email, or company. Case-insensitive partial match.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Lists
>
> **Slug:** `CAMPAYN_GET_LISTS`
>
> 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".
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Message Statistics
>
> **Slug:** `CAMPAYN_GET_MESSAGE`
>
> Retrieves 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
>
> **message\_id** `integer` *required*
>
> The unique ID of the email message to retrieve statistics for. Use GET\_MESSAGES to find available message IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Messages
>
> **Slug:** `CAMPAYN_GET_MESSAGES`
>
> Tool to retrieve all email messages. Use when you need to list all messages visible to the authenticated user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Reports
>
> **Slug:** `CAMPAYN_GET_REPORTS`
>
> 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.
>
> #### Input Parameters
>
> **to** `integer`
>
> End date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter 'to'.
>
> **from\_time** `integer`
>
> Start date filter as Unix timestamp in seconds (microtime), UTC. Corresponds to query parameter 'from'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webform
>
> **Slug:** `CAMPAYN_GET_WEBFORM`
>
> Retrieves 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
>
> **list\_id** `integer` *required*
>
> The unique identifier of the contact list that contains the webform. Use CAMPAYN\_GET\_LISTS to find available list IDs.
>
> **webform\_id** `integer` *required*
>
> The unique identifier of the webform to retrieve. Use CAMPAYN\_GET\_WEBFORMS to find available webform IDs for a list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webforms
>
> **Slug:** `CAMPAYN_GET_WEBFORMS`
>
> 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".
>
> #### Input Parameters
>
> **list\_id** `integer` *required*
>
> ID of the list to retrieve webforms from.
>
> **filter\_form\_type** `string ("0" | "1" | "2" | "3")`
>
> Filter forms by type: 0=Signup Page, 1=Embed Signup, 2=WordPress Signup, 3=Facebook Signup.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unsubscribe Contact
>
> **Slug:** `CAMPAYN_UNSUBSCRIBE_CONTACT`
>
> Tool 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
>
> **id** `string`
>
> The contact ID to unsubscribe. Use this to unsubscribe a specific single contact. Provide either id or email, not both.
>
> **email** `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.
>
> **list\_id** `integer` *required*
>
> The ID of the list from which to unsubscribe contacts
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update List
>
> **Slug:** `CAMPAYN_UPDATE_LIST`
>
> Tool to update a contact list. Use after confirming list ID and desired changes. Example: Update list 123 name to 'Newsletter Subscribers'.
>
> #### Input Parameters
>
> **tags** `string`
>
> Comma-separated tags to assign to the list. Omit if not changing tags.
>
> **list\_id** `integer` *required*
>
> ID of the contact list to update.
>
> **list\_name** `string`
>
> New name for the contact list. Omit if not changing the name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
