# Mailchimp
URL: https://docs.awellhealth.com/docs/marketplace/mailchimp

> For the complete documentation index, see [llms.txt](https://docs.awellhealth.com/llms.txt).



<img src="/marketplace/mailchimp.png" width="48" height="48" />

Mailchimp is an all-in-one marketing platform that helps businesses to design, send, and manage email campaigns.

Category: Communication. Adds 2 actions to a care flow.

## What to configure [#what-to-configure]

Set these once, on the extension in Awell Studio. An action fails at run time if a
required setting is missing.

| Setting    | Required | Notes                                                                                                |
| ---------- | -------- | ---------------------------------------------------------------------------------------------------- |
| API Key    | Yes      | Your Mailchimp API Key so the extension can authenticate with the Mailchimp API. Stored as a secret. |
| From email | Yes      | The email address that will be used for the "From" header.                                           |
| From name  | Yes      | The name that will be used for the "From" header.                                                    |

## Actions [#actions]

Mailchimp adds these 2 actions to a care flow. Add one to a step, then fill in its inputs.

### Send email [#send-email]

Send an email.

| Input   | Type     | Required | Description                         |
| ------- | -------- | -------- | ----------------------------------- |
| To      | `string` | Yes      | The email address of the recipient. |
| Subject | `string` | Yes      | The subject of your email.          |
| Body    | `html`   | Yes      | The content of your message.        |

Allows for sending a plain email to a recipient.

### Send email with template [#send-email-with-template]

Send an email based on a template to a recipient of your choice.

| Input            | Type     | Required | Description                                                                                                                                                                                                       |
| ---------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| To               | `string` | Yes      | The email address of the recipient.                                                                                                                                                                               |
| Template name    | `string` | Yes      | The immutable name or slug of a template that exists in your account.                                                                                                                                             |
| Subject          | `string` | Yes      | The subject of your email.                                                                                                                                                                                        |
| Template content | `json`   | No       | An array of template content to send. Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block |

## Setup and notes [#setup-and-notes]

Mailchimp is an all-in-one marketing platform that helps businesses of all sizes to design, send, and manage email campaigns, automate marketing tasks, and build customer relationships.

It offers a user-friendly interface that allows users to create custom email templates, segment their audience, and track their email campaign's performance with real-time analytics.

### Extension settings [#extension-settings]

In order to set up this extension, you will need to provide a:

1. API key
2. From name
3. From email

#### Send email with a template [#send-email-with-a-template]

Allows for sending an email based on a template to a recipient. You can also insert variables so they are rendered in your template.

## Changelog [#changelog]

## Mailchimp changelog [#mailchimp-changelog]

## Where this page comes from [#where-this-page-comes-from]

The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at `@awell-health/awell-extensions` v2.1.159. They match what the
platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action.
Something wrong or missing? Email [support@awellhealth.com](mailto:support@awellhealth.com).
