> ## 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.

# Sender

> Email marketing platform for creating campaigns, automating workflows, and tracking results

![Sender logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/sender.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=a55487fa30694ef95000667e5f222c2d)

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

## Tools

> [accordion] Create Field
>
> **Slug:** `SENDER_CREATE_FIELD`
>
> Tool to create a new custom subscriber field in Sender.net. Use when you need to add custom fields for email personalization, segmentation, or storing additional subscriber information like company name, birthday, job title, or other custom attributes.
>
> #### Input Parameters
>
> **type** `string` *required*
>
> The data type of the field. Common types include 'text' for string values, 'number' for numeric values, 'date' for dates, and 'money' for currency values.
>
> **title** `string` *required*
>
> The display name/title of the custom field. This will be visible when managing subscriber data.
>
> #### 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] Create Or Update Subscriber
>
> **Slug:** `SENDER_CREATE_OR_UPDATE_SUBSCRIBER`
>
> Tool to create a new subscriber or update an existing one in Sender.net. Use when you need to add new subscribers to your email list or update existing subscriber information. This performs an upsert operation - creates if the email doesn't exist, updates if it does.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Subscriber's email address. This is required and will be used to identify existing subscribers.
>
> **phone** `string`
>
> Subscriber's phone number.
>
> **fields** `object`
>
> Custom fields object for additional subscriber attributes such as birthday, gender, location, company, title, or other relevant data.
>
> **groups** `array`
>
> Array of group IDs to assign the subscriber to.
>
> **lastname** `string`
>
> Subscriber's last name.
>
> **firstname** `string`
>
> Subscriber's first name.
>
> **trigger\_automation** `boolean`
>
> Whether to trigger email automations for this subscriber. Default is true when not specified.
>
> #### 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 All Fields
>
> **Slug:** `SENDER_GET_ALL_FIELDS`
>
> Tool to retrieve a list of all custom subscriber fields configured in the Sender.net account. Use when you need to view available fields for email personalization, segmentation, or managing subscriber data.
>
> #### 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 All Workflows
>
> **Slug:** `SENDER_GET_ALL_WORKFLOWS`
>
> Tool to retrieve a list of all automation workflows in the Sender account. Use when you need to view or manage automation workflows.
>
> #### 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 Campaign By ID
>
> **Slug:** `SENDER_GET_CAMPAIGN_BY_ID`
>
> Tool to retrieve a specific campaign by its unique ID from Sender. Use when you need detailed information about a campaign including delivery metrics and engagement statistics.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> The unique identifier of the campaign to retrieve. Example: '1'
>
> #### 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 Group By ID
>
> **Slug:** `SENDER_GET_GROUP_BY_ID`
>
> Tool to retrieve a specific subscriber group by its unique ID from Sender. Use when you need detailed information about a single group including subscriber counts.
>
> #### Input Parameters
>
> **group\_id** `string` *required*
>
> The unique identifier of the group to retrieve. Example: 'dBEVzJ'
>
> #### 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 Subscriber By ID
>
> **Slug:** `SENDER_GET_SUBSCRIBER_BY_ID`
>
> Retrieve a specific Sender subscriber by their unique ID. Use this to fetch the subscriber's profile, including status, groups, and custom fields.
>
> #### Input Parameters
>
> **subscriber\_id** `string` *required*
>
> The unique identifier of the subscriber to retrieve. Example: 'MJABNBP'
>
> #### 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 Subscriber Events
>
> **Slug:** `SENDER_GET_SUBSCRIBER_EVENTS`
>
> Return filtered event history and campaign activity totals for a subscriber.
>
> #### Input Parameters
>
> **actions** `array` *required*
>
> Event action types to return: opened, bounced, clicked, unsubscribed, or got.
>
> **subscriber\_identifier** `string` *required*
>
> Subscriber email address, phone number, or Sender subscriber ID.
>
> #### 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] List Groups
>
> **Slug:** `SENDER_LIST_GROUPS`
>
> Return one paginated page of groups from the connected Sender account.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return, starting at 1.
>
> **limit** `integer`
>
> Maximum number of groups to request for this page.
>
> **order** `string ("id" | "title" | "recipient_count" | "active_subscribers" | "unsubscribed_count" | "bounced_count" | "phone_count" | "active_phone_count" | "account_id" | "user_id" | "created" | "modified" | "is_recalculating_subscribers" | "is_favourite" | "used_in_integration")`
>
> Group resource field to order by.
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction used with order.
>
> #### 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] List Subscribers
>
> **Slug:** `SENDER_LIST_SUBSCRIBERS`
>
> Return one paginated page of subscribers from the connected Sender account.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to return, starting at 1.
>
> **limit** `integer`
>
> Maximum number of subscribers to request for this page.
>
> **order** `string`
>
> Subscriber resource field to order by.
>
> **direction** `string ("asc" | "desc")`
>
> Sort direction used with order.
>
> #### 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 Subscriber Fields
>
> **Slug:** `SENDER_UPDATE_SUBSCRIBER_FIELDS`
>
> Update an existing Sender subscriber's email, first name, last name, or group assignments.
>
> #### Input Parameters
>
> **email** `string`
>
> The subscriber's email address
>
> **groups** `array`
>
> Array of group IDs to assign the subscriber to
>
> **lastname** `string`
>
> The subscriber's last name
>
> **firstname** `string`
>
> The subscriber's first name
>
> **subscriber\_id** `string` *required*
>
> The unique identifier of the subscriber to update
>
> #### 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
