> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/sender.md).

# Sender

Sender is an email and SMS marketing platform. Manage subscribers and groups, create and send campaigns, and send transactional email from your AI workflows.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication   |
| --------- | ---------------- |
| Sender    | API Access Token |

### Sender

Connect to Sender to manage subscribers, groups, campaigns and transactional email.

#### Set up in Sender

1. Prepare the Sender account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Access Token:** Create a token in Sender under Settings, then API access tokens. The token carries full access to the account; there are no scopes to choose.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Sender**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field    | Required | What to enter                                                                                                                                                                                                  |
| ---------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Access Token | Yes      | Create a token in Sender under Settings, then API access tokens. The token carries full access to the account; there are no scopes to choose. [Provider instructions](https://app.sender.net/settings/tokens). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Sender** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create Subscriber

Add a contact to your Sender account, optionally placing them in one or more groups.

#### Inputs

| Field               | Type            | Required | Description                                                                             |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------------------- |
| Email               | string          | Yes      | The contact's email address. This is how Sender identifies the subscriber.              |
| First name          | string          | No       | The contact's first name, used to personalize emails.                                   |
| Last name           | string          | No       | The contact's last name, used to personalize emails.                                    |
| Groups              | select (string) | No       | The groups (lists) this contact should join. Options load from the selected connection. |
| Phone               | string          | No       | The contact's phone number, needed only if you send SMS from Sender.                    |
| Custom fields       | textarea        | No       | Values for the custom fields you have set up in Sender, as JSON.                        |
| Trigger automations | boolean         | No       | Let Sender run any automation attached to the groups this contact joins.                |

#### Outputs

| Field         | Type   | Description                        |
| ------------- | ------ | ---------------------------------- |
| Subscriber ID | string | Sender's id for the new contact.   |
| Email         | string | The email address that was stored. |
| First name    | string | The stored first name.             |
| Last name     | string | The stored last name.              |
| Created at    | string | When the contact was created.      |

### Update Subscriber

Change a contact's details, group membership, or subscription status.

#### Inputs

| Field                      | Type            | Required | Description                                                                                                                                      |
| -------------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Subscriber                 | string          | Yes      | The contact to update, by email address or Sender id.                                                                                            |
| First name                 | string          | No       | New first name. Leave empty to keep the current one.                                                                                             |
| Last name                  | string          | No       | New last name. Leave empty to keep the current one.                                                                                              |
| Groups                     | select (string) | No       | The complete set of groups this contact should belong to. Options load from the selected connection.                                             |
| Subscription status        | select (string) | No       | Whether this contact still receives your emails. Available values: Active, Unsubscribed, Bounced, Spam reported.                                 |
| Phone                      | string          | No       | New phone number in international format.                                                                                                        |
| Custom fields              | textarea        | No       | Values for the custom fields you have set up in Sender, as JSON.                                                                                 |
| SMS status                 | select (string) | No       | Whether this contact still receives your SMS messages. Available values: Active, Unsubscribed, Bounced, Spam reported.                           |
| Transactional email status | select (string) | No       | Whether this contact still receives your transactional emails, such as receipts. Available values: Active, Unsubscribed, Bounced, Spam reported. |
| Trigger automations        | boolean         | No       | Let Sender run any automation attached to groups this contact newly joins.                                                                       |

#### Outputs

| Field      | Type   | Description                    |
| ---------- | ------ | ------------------------------ |
| Subscriber | string | The contact that was updated.  |
| Result     | string | Sender's confirmation message. |

### Get Subscriber

Look up one contact by email address and see their details, groups, and status.

#### Inputs

| Field      | Type   | Required | Description                                            |
| ---------- | ------ | -------- | ------------------------------------------------------ |
| Subscriber | string | Yes      | The contact to look up, by email address or Sender id. |

#### Outputs

| Field           | Type          | Description                                      |
| --------------- | ------------- | ------------------------------------------------ |
| Subscriber ID   | string        | Sender's id for this contact.                    |
| Email           | string        | The contact's email address.                     |
| First name      | string        | The contact's first name.                        |
| Last name       | string        | The contact's last name.                         |
| Phone           | string        | The contact's phone number.                      |
| Email status    | string        | Whether this contact still receives your emails. |
| Groups          | object\_array | The groups this contact belongs to.              |
| Custom fields   | object\_array | This contact's custom field values.              |
| Created at      | string        | When the contact was added.                      |
| Unsubscribed at | string        | When the contact opted out, if they did.         |

### List Subscribers

Browse your contacts, optionally only those in one group.

#### Inputs

| Field           | Type            | Required | Description                                                                                                   |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Group           | select (string) | No       | Limit the results to one group. Leave empty to list every contact. Options load from the selected connection. |
| Maximum results | integer         | No       | The most contacts to return in one run. Minimum: 1. Default: 50.                                              |
| Page            | integer         | No       | Which page of results to fetch. Starts at 1. Minimum: 1.                                                      |

#### Outputs

| Field       | Type          | Description                                                         |
| ----------- | ------------- | ------------------------------------------------------------------- |
| Subscribers | object\_array | The contacts on this page.                                          |
| Next page   | integer       | The page number to request next, empty when this was the last page. |
| Total       | integer       | How many contacts match in total.                                   |

### Create Group

Create a new group (contact list) in Sender.

#### Inputs

| Field      | Type   | Required | Description                                                      |
| ---------- | ------ | -------- | ---------------------------------------------------------------- |
| Group name | string | Yes      | What to call this group, for example the audience it represents. |

#### Outputs

| Field      | Type   | Description                    |
| ---------- | ------ | ------------------------------ |
| Group ID   | string | Sender's id for the new group. |
| Group name | string | The group's name.              |
| Created at | string | When the group was created.    |

### List Groups

See the groups in your Sender account and how many contacts each has.

#### Inputs

| Field           | Type    | Required | Description                                                    |
| --------------- | ------- | -------- | -------------------------------------------------------------- |
| Maximum results | integer | No       | The most groups to return in one run. Minimum: 1. Default: 50. |
| Page            | integer | No       | Which page of results to fetch. Starts at 1. Minimum: 1.       |

#### Outputs

| Field     | Type          | Description                                                         |
| --------- | ------------- | ------------------------------------------------------------------- |
| Groups    | object\_array | The groups on this page.                                            |
| Next page | integer       | The page number to request next, empty when this was the last page. |
| Total     | integer       | How many groups exist in total.                                     |

### Add Subscribers to Group

Add existing contacts to a group, by email address.

#### Inputs

| Field               | Type            | Required | Description                                                                    |
| ------------------- | --------------- | -------- | ------------------------------------------------------------------------------ |
| Group               | select (string) | Yes      | The group the contacts should join. Options load from the selected connection. |
| Email addresses     | string          | Yes      | The contacts to add, as a comma-separated list of email addresses.             |
| Trigger automations | boolean         | No       | Let Sender run any automation attached to this group.                          |

#### Outputs

| Field       | Type          | Description                                                           |
| ----------- | ------------- | --------------------------------------------------------------------- |
| Added       | string\_array | The email addresses that were added to the group.                     |
| Not found   | string\_array | Addresses that are not contacts in Sender yet, so could not be added. |
| Added count | integer       | How many contacts were added.                                         |

### Remove Subscribers from Group

Take contacts out of a group without deleting them from your account.

#### Inputs

| Field           | Type            | Required | Description                                                                       |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------- |
| Group           | select (string) | Yes      | The group to take the contacts out of. Options load from the selected connection. |
| Email addresses | string          | Yes      | The contacts to remove, as a comma-separated list of email addresses.             |

#### Outputs

| Field        | Type          | Description                                                 |
| ------------ | ------------- | ----------------------------------------------------------- |
| Group ID     | string        | The group the contacts were removed from.                   |
| Result       | string        | A summary of what the removal did.                          |
| Removed      | string\_array | The email addresses that were removed from the group.       |
| Not in group | string\_array | Addresses that were not members of the group to begin with. |
| Not found    | string\_array | Addresses that are not contacts in Sender at all.           |

### Create Campaign

Draft an email campaign for one or more groups. It is not sent until you send it.

#### Inputs

| Field                     | Type            | Required | Description                                                                                                                                        |
| ------------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Subject                   | string          | Yes      | The subject line recipients will see.                                                                                                              |
| From name                 | string          | Yes      | The sender name shown in the recipient's inbox.                                                                                                    |
| Reply-to address          | string          | Yes      | The email address replies go to. It must be verified in your Sender account.                                                                       |
| Content type              | select (string) | Yes      | Whether the body is HTML, plain text, or built in Sender's drag-and-drop editor. Available values: Sender editor, HTML, Plain text. Default: html. |
| Content                   | textarea        | No       | The body of the email, matching the content type you chose.                                                                                        |
| Groups                    | select (string) | No       | The groups that will receive this campaign. Options load from the selected connection.                                                             |
| Internal name             | string          | No       | A name for your own reference. Recipients never see it.                                                                                            |
| Preview text              | string          | No       | The short preview line inboxes show after the subject.                                                                                             |
| Segments                  | select (string) | No       | Segments that will receive this campaign, in addition to any groups. Options load from the selected connection.                                    |
| Google Analytics tracking | boolean         | No       | Tag links in this campaign so visits show up in Google Analytics.                                                                                  |

#### Outputs

| Field            | Type   | Description                                                |
| ---------------- | ------ | ---------------------------------------------------------- |
| Campaign ID      | string | Sender's id for the new draft campaign.                    |
| Subject          | string | The stored subject line.                                   |
| Status           | string | The campaign's state, which is DRAFT right after creation. |
| Recipient groups | string | The groups the campaign will go to.                        |
| Created at       | string | When the draft was created.                                |

### Send Campaign

Send a draft campaign now, or schedule it for a later date and time.

#### Inputs

| Field    | Type            | Required | Description                                                            |
| -------- | --------------- | -------- | ---------------------------------------------------------------------- |
| Campaign | select (string) | Yes      | The draft campaign to send. Options load from the selected connection. |
| Send at  | datetime        | No       | When to send it. Leave empty to send right away.                       |

#### Outputs

| Field         | Type   | Description                                                   |
| ------------- | ------ | ------------------------------------------------------------- |
| Campaign ID   | string | The campaign that was sent or scheduled.                      |
| Scheduled for | string | The time it will be sent, empty when it was sent immediately. |
| Result        | string | Sender's confirmation message.                                |

### List Campaigns

See your campaigns and how they performed, optionally filtered by state.

#### Inputs

| Field           | Type            | Required | Description                                                                                                |
| --------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
| Status          | select (string) | No       | Show only campaigns in this state. Leave empty for all. Available values: Draft, Scheduled, Sending, Sent. |
| Maximum results | integer         | No       | The most campaigns to return in one run. Minimum: 1. Default: 25.                                          |
| Page            | integer         | No       | Which page of results to fetch. Starts at 1. Minimum: 1.                                                   |

#### Outputs

| Field     | Type          | Description                                                         |
| --------- | ------------- | ------------------------------------------------------------------- |
| Campaigns | object\_array | The campaigns on this page.                                         |
| Next page | integer       | The page number to request next, empty when this was the last page. |
| Total     | integer       | How many campaigns match in total.                                  |

### Send Transactional Email

Send a one-off email to a single person, such as a receipt or a notification.

#### Inputs

| Field           | Type     | Required | Description                                                                     |
| --------------- | -------- | -------- | ------------------------------------------------------------------------------- |
| To              | string   | Yes      | Who the email goes to.                                                          |
| Subject         | string   | Yes      | The subject line of the email.                                                  |
| From address    | string   | Yes      | The address the email is sent from. It must be verified in your Sender account. |
| From name       | string   | Yes      | The sender name shown in the recipient's inbox.                                 |
| HTML body       | textarea | No       | The formatted body of the email.                                                |
| To name         | string   | No       | The recipient's name, shown alongside their address.                            |
| Plain text body | textarea | No       | A plain-text version for clients that do not show HTML.                         |
| Variables       | textarea | No       | Values to substitute into the body, as JSON.                                    |
| Attachments     | textarea | No       | Files to attach, given as a filename and a public download link, as JSON.       |
| Custom headers  | textarea | No       | Extra email headers, as JSON. Most workflows need none.                         |

#### Outputs

| Field    | Type   | Description                                |
| -------- | ------ | ------------------------------------------ |
| Email ID | string | Sender's id for the message that was sent. |
| To       | string | The address the email was sent to.         |
| Result   | string | Sender's confirmation message.             |

### List Custom Fields

See the custom fields your Sender account defines, and the placeholder to use for each.

#### Inputs

| Field           | Type    | Required | Description                                                    |
| --------------- | ------- | -------- | -------------------------------------------------------------- |
| Maximum results | integer | No       | The most fields to return in one run. Minimum: 1. Default: 50. |
| Page            | integer | No       | Which page of results to fetch. Starts at 1. Minimum: 1.       |

#### Outputs

| Field         | Type          | Description                                                           |
| ------------- | ------------- | --------------------------------------------------------------------- |
| Custom fields | object\_array | The custom fields on this page, with the placeholder to use for each. |
| Next page     | integer       | The page number to request next, empty when this was the last page.   |
| Total         | integer       | How many custom fields exist in total.                                |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Subscriber

Starts the workflow when a new contact is added to your Sender account, optionally only when the new contact lands in one specific group.

Optionally pick a group to only fire for new contacts created in that group. Note: adding an already-existing contact to the group does not fire, since Sender does not report when a contact joined a group. Leave it empty to fire for every new contact in your account, however they were added: a signup form, an import, or another workflow.

#### Configuration

| Field | Type            | Required | Description                                                                                                                                                                                                                                                                |
| ----- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Group | select (string) | No       | Only fire for new contacts that are created in this group. Adding an already-existing contact to the group does not fire, because Sender does not report when a contact joined a group. Leave empty to watch the whole account. Options load from the selected connection. |

#### Event inputs

| Field         | Type          | Required | Description                                                      |
| ------------- | ------------- | -------- | ---------------------------------------------------------------- |
| Subscriber ID | string        | Yes      | Sender's id for the new contact. Default: .                      |
| Email         | string        | Yes      | The new contact's email address. Default: .                      |
| First name    | string        | No       | The new contact's first name.                                    |
| Last name     | string        | No       | The new contact's last name.                                     |
| Email status  | string        | No       | Whether this contact is subscribed to your emails.               |
| Custom fields | object\_array | No       | The custom field values captured for this contact. Default: \[]. |
| Created at    | datetime      | Yes      | When the contact was added. Default: 0001-01-01 00:00:00.        |

#### Outputs

| Field         | Type          | Description                                        |
| ------------- | ------------- | -------------------------------------------------- |
| Subscriber ID | string        | Sender's id for the new contact.                   |
| Email         | string        | The new contact's email address.                   |
| First name    | string        | The new contact's first name.                      |
| Last name     | string        | The new contact's last name.                       |
| Email status  | string        | Whether this contact is subscribed to your emails. |
| Custom fields | object\_array | The custom field values captured for this contact. |
| Created at    | datetime      | When the contact was added.                        |

### Campaign Sent

Starts the workflow when a campaign finishes sending, so you can log results or notify your team. Fires once per campaign, when it first reaches the sent state.

This trigger fires once for every campaign the moment it finishes sending, for the whole account. There is nothing to configure.

#### Event inputs

| Field            | Type     | Required | Description                                 |
| ---------------- | -------- | -------- | ------------------------------------------- |
| Campaign ID      | string   | Yes      | Sender's id for the campaign. Default: .    |
| Subject          | string   | Yes      | The subject line recipients saw. Default: . |
| Internal name    | string   | No       | The campaign's internal name in Sender.     |
| Sent count       | integer  | No       | How many emails went out.                   |
| Opens            | integer  | No       | How many opens Sender has recorded so far.  |
| Clicks           | integer  | No       | How many clicks Sender has recorded so far. |
| Recipient groups | string   | No       | The groups the campaign went to.            |
| Sent at          | datetime | No       | When the campaign was sent.                 |

#### Outputs

| Field            | Type     | Description                                 |
| ---------------- | -------- | ------------------------------------------- |
| Campaign ID      | string   | Sender's id for the campaign.               |
| Subject          | string   | The subject line recipients saw.            |
| Internal name    | string   | The campaign's internal name in Sender.     |
| Sent count       | integer  | How many emails went out.                   |
| Opens            | integer  | How many opens Sender has recorded so far.  |
| Clicks           | integer  | How many clicks Sender has recorded so far. |
| Recipient groups | string   | The groups the campaign went to.            |
| Sent at          | datetime | When the campaign was sent.                 |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/sender.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
