> 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/drip.md).

# Drip

Drip is an ecommerce CRM and email-marketing automation platform. Manage subscribers, tags, and Email Series Campaigns, record custom events, and sync orders from your AI workflows.

### Connectors

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

| Connector      | Authentication |
| -------------- | -------------- |
| Drip (API Key) | API Token      |

#### Drip (API Key)

Connect to Drip to manage subscribers, campaigns, tags, and events.

**Set up in Drip**

1. Prepare the Drip account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Token:** Your personal API token (Drip -> Settings -> User Settings -> API Token).

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Drip (API Key)**.
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 Token     | Yes      | Your personal API token (Drip -> Settings -> User Settings -> API Token). [Provider instructions](https://www.getdrip.com/user/edit). |
| Account ID    | Yes      | The numeric Drip account ID, visible in the app URL after signing in (e.g. 9999999).                                                  |

#### 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 **Drip** 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 or Update Subscriber

Create a new Drip subscriber or update an existing one by email.

**Inputs**

| Field                  | Type            | Required | Description                                                                           |
| ---------------------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Email                  | string          | No       | The person's email address (the upsert key).                                          |
| Subscriber ID          | string          | No       | The person's Drip id, to update without an email.                                     |
| New Email              | string          | No       | A new email address for the person.                                                   |
| First Name             | string          | No       | The person's first name.                                                              |
| Last Name              | string          | No       | The person's last name.                                                               |
| Address Line 1         | string          | No       | The person's mailing address.                                                         |
| Address Line 2         | string          | No       | Additional mailing address line.                                                      |
| City                   | string          | No       | The person's city.                                                                    |
| State / Region         | string          | No       | The person's state, province, or region.                                              |
| Postal Code            | string          | No       | The person's postal or zip code.                                                      |
| Country                | string          | No       | The person's country.                                                                 |
| Phone                  | string          | No       | The person's primary phone number.                                                    |
| User ID                | string          | No       | Your own unique identifier for the person.                                            |
| Time Zone              | string          | No       | The person's time zone in Olson format.                                               |
| Status                 | select (string) | No       | Set the person's status. Available values: Active, Unsubscribed.                      |
| EU Consent             | select (string) | No       | Whether the person granted or denied GDPR consent. Available values: Granted, Denied. |
| EU Consent Message     | string          | No       | The consent message the person responded to.                                          |
| Lifetime Value (cents) | integer         | No       | The person's lifetime value, in cents.                                                |
| Prospect               | boolean         | No       | Whether to attach a lead score (when lead scoring is on).                             |
| Base Lead Score        | integer         | No       | Starting value for lead score calculation (Drip default 30).                          |
| Tags to Apply          | array           | No       | Tags to apply to the person.                                                          |
| Tags to Remove         | array           | No       | Tags to remove from the person.                                                       |
| Custom Fields          | object          | No       | Custom field data (JSON object).                                                      |

**Outputs**

| Field                  | Type          | Description                                          |
| ---------------------- | ------------- | ---------------------------------------------------- |
| Subscriber ID          | string        | The person's Drip id.                                |
| Email                  | string        | The person's email address as stored.                |
| Status                 | string        | The person's status.                                 |
| First Name             | string        | The stored first name.                               |
| Last Name              | string        | The stored last name.                                |
| Tags                   | string\_array | The person's tags after the update.                  |
| Custom Fields          | dict          | The person's custom fields after the update.         |
| Lifetime Value (cents) | number        | The person's lifetime value in cents.                |
| Created At             | string        | When the person record was first created (ISO-8601). |
| API URL                | string        | REST API URL of the subscriber record.               |

#### Subscribe to Campaign

Subscribe a person to a Drip Email Series Campaign.

**Inputs**

| Field                 | Type            | Required | Description                                                                                      |
| --------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------ |
| Campaign              | select (string) | Yes      | The Email Series Campaign to subscribe the person to. Options load from the selected connection. |
| Email                 | string          | Yes      | The person's email address.                                                                      |
| Time Zone             | string          | No       | The person's time zone in Olson format.                                                          |
| Double Opt-In         | boolean         | No       | Whether to send the double opt-in confirmation email.                                            |
| Starting Email Index  | integer         | No       | Zero-based index of the first email to send.                                                     |
| Reactivate If Removed | boolean         | No       | Re-subscribe the person if they were previously removed.                                         |
| Tags                  | array           | No       | Tags to apply while subscribing.                                                                 |
| Custom Fields         | object          | No       | Custom field data (JSON object).                                                                 |

**Outputs**

| Field         | Type   | Description                                |
| ------------- | ------ | ------------------------------------------ |
| Subscriber ID | string | The subscribed person's Drip id.           |
| Email         | string | The person's email address as stored.      |
| Status        | string | The person's status after subscribing.     |
| Campaign ID   | string | The campaign the person was subscribed to. |

#### Apply Tag to Subscriber

Apply a tag to a Drip subscriber by email.

**Inputs**

| Field | Type            | Required | Description                                                                               |
| ----- | --------------- | -------- | ----------------------------------------------------------------------------------------- |
| Email | string          | Yes      | The person's email address.                                                               |
| Tag   | select (string) | Yes      | The tag to apply. Free text creates a new tag. Options load from the selected connection. |

**Outputs**

| Field   | Type    | Description                                  |
| ------- | ------- | -------------------------------------------- |
| Email   | string  | The person the tag was applied to.           |
| Tag     | string  | The tag that was applied.                    |
| Applied | boolean | True when Drip accepted the tag application. |

#### Remove Tag from Subscriber

Remove a tag from a Drip subscriber.

**Inputs**

| Field                  | Type            | Required | Description                                                   |
| ---------------------- | --------------- | -------- | ------------------------------------------------------------- |
| Email or Subscriber ID | string          | Yes      | The person's email address or Drip id.                        |
| Tag                    | select (string) | Yes      | The tag to remove. Options load from the selected connection. |

**Outputs**

| Field                  | Type    | Description                              |
| ---------------------- | ------- | ---------------------------------------- |
| Email or Subscriber ID | string  | The person the tag was removed from.     |
| Tag                    | string  | The tag that was removed.                |
| Removed                | boolean | True when Drip accepted the tag removal. |

#### Record Custom Event

Record a custom event on a Drip subscriber's timeline.

**Inputs**

| Field         | Type            | Required | Description                                                                                             |
| ------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------- |
| Event Action  | select (string) | Yes      | The name of the event. Free text creates a new event action. Options load from the selected connection. |
| Email         | string          | No       | The person's email address.                                                                             |
| Subscriber ID | string          | No       | The person's Drip id.                                                                                   |
| Properties    | object          | No       | Custom event properties (JSON object).                                                                  |
| Occurred At   | datetime        | No       | When the event occurred. Defaults to now.                                                               |
| Prospect      | boolean         | No       | Whether to attach a lead score (when lead scoring is on).                                               |

**Outputs**

| Field        | Type    | Description                         |
| ------------ | ------- | ----------------------------------- |
| Event Action | string  | The event action that was recorded. |
| Recorded     | boolean | True when Drip accepted the event.  |

#### Create or Update Order

Record or update a customer order in Drip (Shopper Activity).

**Inputs**

| Field            | Type            | Required | Description                                                                                   |
| ---------------- | --------------- | -------- | --------------------------------------------------------------------------------------------- |
| Provider         | string          | Yes      | The ecommerce platform the order came from (snake\_case).                                     |
| Order Action     | select (string) | Yes      | The order event type. Available values: Placed, Updated, Paid, Fulfilled, Refunded, Canceled. |
| Order ID         | string          | Yes      | A unique internal id for the order.                                                           |
| Email            | string          | No       | The customer's email address.                                                                 |
| Person ID        | string          | No       | The customer's Drip person id.                                                                |
| Initial Status   | select (string) | No       | The person's status if newly created. Available values: Active, Unsubscribed.                 |
| Occurred At      | datetime        | No       | When the order event occurred. Defaults to now.                                               |
| Public Order ID  | string          | No       | A customer-facing order identifier.                                                           |
| Grand Total      | number          | No       | The order total, including discounts.                                                         |
| Total Discounts  | number          | No       | Discounts on the whole order.                                                                 |
| Total Taxes      | number          | No       | Taxes on the whole order.                                                                     |
| Total Fees       | number          | No       | Fees on the whole order.                                                                      |
| Total Shipping   | number          | No       | Shipping on the whole order.                                                                  |
| Refund Amount    | number          | No       | Refund amount, for refunds/cancellations.                                                     |
| Currency         | string          | No       | ISO 4217 currency code.                                                                       |
| Order URL        | string          | No       | A link back to the order on your platform.                                                    |
| Line Items       | array           | No       | Order line items (each needs a name).                                                         |
| Billing Address  | object          | No       | Billing address (JSON object).                                                                |
| Shipping Address | object          | No       | Shipping address (JSON object).                                                               |

**Outputs**

| Field        | Type   | Description                             |
| ------------ | ------ | --------------------------------------- |
| Request ID   | string | Drip's id for the queued order request. |
| Order ID     | string | The order id that was submitted.        |
| Order Action | string | The order action that was submitted.    |

#### Get Subscriber

Fetch a Drip subscriber by email, id, or visitor UUID.

**Inputs**

| Field                  | Type   | Required | Description                                           |
| ---------------------- | ------ | -------- | ----------------------------------------------------- |
| Email or Subscriber ID | string | Yes      | The person's email address, Drip id, or visitor UUID. |

**Outputs**

| Field                  | Type          | Description                                    |
| ---------------------- | ------------- | ---------------------------------------------- |
| Subscriber ID          | string        | The person's Drip id.                          |
| Email                  | string        | The person's email address.                    |
| Status                 | string        | The person's status.                           |
| First Name             | string        | The person's first name.                       |
| Last Name              | string        | The person's last name.                        |
| Tags                   | string\_array | The person's tags.                             |
| Custom Fields          | dict          | The person's custom fields.                    |
| Lifetime Value (cents) | number        | The person's lifetime value in cents.          |
| Created At             | string        | When the person record was created (ISO-8601). |
| API URL                | string        | REST API URL of the subscriber record.         |

#### List Subscribers

List Drip subscribers, optionally filtered by status, tag, or date.

**Inputs**

| Field          | Type            | Required | Description                                                                                                                            |
| -------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| Status Filter  | select (string) | No       | Filter people by status (Drip defaults to active). Available values: All, Active, Unsubscribed, Active or Unsubscribed, Undeliverable. |
| Tag Filter     | select (string) | No       | Return only people who have this tag. Options load from the selected connection.                                                       |
| Created Before | datetime        | No       | Return only people created before this time.                                                                                           |
| Created After  | datetime        | No       | Return only people created after this time.                                                                                            |
| Limit          | integer         | No       | Maximum people to return (default 1000).                                                                                               |

**Outputs**

| Field       | Type        | Description                                        |
| ----------- | ----------- | -------------------------------------------------- |
| Subscribers | dict\_array | The matching people.                               |
| Total Count | integer     | Total matching people reported by Drip.            |
| Has More    | boolean     | True if more people exist beyond the returned set. |

#### List Campaigns

List Drip Email Series Campaigns, optionally filtered and sorted.

**Inputs**

| Field          | Type            | Required | Description                                                               |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Status Filter  | select (string) | No       | Filter campaigns by status. Available values: All, Draft, Active, Paused. |
| Sort By        | select (string) | No       | Field to sort campaigns by. Available values: Created At, Name.           |
| Sort Direction | select (string) | No       | Sort direction. Available values: Ascending, Descending.                  |
| Limit          | integer         | No       | Maximum campaigns to return (default 1000).                               |

**Outputs**

| Field       | Type        | Description                                           |
| ----------- | ----------- | ----------------------------------------------------- |
| Campaigns   | dict\_array | Email Series campaigns returned by Drip.              |
| Total Count | integer     | Total matching campaigns reported by Drip.            |
| Has More    | boolean     | True if more campaigns exist beyond the returned set. |

#### Unsubscribe Subscriber

Unsubscribe a Drip person from all mailings, all campaigns, or one campaign.

**Inputs**

| Field                  | Type            | Required | Description                                                                                                                 |
| ---------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| Email or Subscriber ID | string          | Yes      | The person's email address or Drip id.                                                                                      |
| Unsubscribe Scope      | select (string) | Yes      | What to unsubscribe the person from. Available values: All mailings, All Email Series Campaigns, One Email Series Campaign. |
| Campaign               | select (string) | No       | The campaign to remove the person from (single-campaign scope). Options load from the selected connection.                  |

**Outputs**

| Field         | Type   | Description                           |
| ------------- | ------ | ------------------------------------- |
| Subscriber ID | string | The affected person's Drip id.        |
| Email         | string | The person's email address as stored. |
| Status        | string | The person's status after the change. |
| Scope         | string | The scope that was applied.           |

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