Create Or Update Subscriber with Drip API on Custom Interval from Schedule API

Pipedream makes it easy to connect APIs for Drip, Schedule and 2,400+ other apps remarkably fast.

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Or Update Subscriber with the Drip API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Drip action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Or Update Subscriber action
1. Connect your Drip account
2. Optional- Select a Email
3. Optional- Configure Visitor UUID
4. Optional- Configure New Email
5. Optional- Configure First Name
6. Optional- Configure Last Name
7. Optional- Configure Address 1
8. Optional- Configure Address 2
9. Optional- Configure City
10. Optional- Configure State
11. Optional- Configure ZIP
12. Optional- Configure Country
13. Optional- Configure Phone
14. Optional- Configure SMS Number
15. Optional- Configure SMS Consent
16. Optional- Configure User Id
17. Optional- Configure Timezone
18. Optional- Configure Lifetime Value
19. Optional- Configure IP Address
20. Optional- Configure Custom Fields
21. Optional- Configure Tags
22. Optional- Configure Remove Tags
23. Optional- Configure Prospect
24. Optional- Configure Base Lead Score
25. Optional- Select a EU Consent
26. Optional- Configure EU Consent Message
27. Optional- Select a Status
28. Optional- Select a Initial Status
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Or Update Subscriber on Drip

Description:Creates a new subscriber. If the email already exists, it will update the existing subscriber. [See the docs here](https://developer.drip.com/?javascript#create-or-update-a-subscriber)

Version:0.0.2

Key:drip-create-or-update-subscriber

View on GitHub

Drip Overview#

The Drip API allows for powerful email marketing automation, providing tools to craft every interaction with your leads, trial users, and customers. With the Drip API on Pipedream, you can manage subscribers, send emails, track user actions, and more. This integration opens up possibilities for syncing subscriber data, triggering communication based on user behavior, and connecting your email marketing to a wider ecosystem of tools.

Action Code#

import drip from "../../drip.app.mjs";

export default {
  key: "drip-create-or-update-subscriber",
  name: "Create Or Update Subscriber",
  version: "0.0.2",
  description: "Creates a new subscriber. If the email already exists, it will update the existing subscriber. [See the docs here](https://developer.drip.com/?javascript#create-or-update-a-subscriber)",
  type: "action",
  props: {
    drip,
    email: {
      propDefinition: [
        drip,
        "email",
      ],
    },
    visitorUuid: {
      type: "string",
      label: "Visitor UUID",
      description: "The `uuid` for a subscriber's visitor record. Either `email` or `visitor_uuid` must be included.",
      optional: true,
    },
    newEmail: {
      type: "string",
      label: "New Email",
      description: "A new email address for the subscriber. If provided and a subscriber with the `email` above does not exist, this address will be used to create a new subscriber.",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The subscriber's first name.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The subscriber's last name.",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "The subscriber's mailing address.",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "An additional field for the subscriber's mailing address.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The city, town, or village in which the subscriber resides.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "The region in which the subscriber resides. Typically a province, a state, or a prefecture.",
      optional: true,
    },
    zip: {
      type: "string",
      label: "ZIP",
      description: "The postal code in which the subscriber resides, also known as zip, postcode, Eircode, etc.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The country in which the subscriber resides.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The subscriber's primary phone number.",
      optional: true,
    },
    smsNumber: {
      type: "string",
      label: "SMS Number",
      description: "The subscriber's mobile phone number in E.164 formatting. E.g. \"+16125551212\". Only US-based numbers are supported at this time.",
      optional: true,
    },
    smsConsent: {
      type: "boolean",
      label: "SMS Consent",
      description: "`true` if the person has granted consent to receive marketing and other communication via SMS; `false` otherwise. Default: false. If you're unsure whether or not you have gained legal SMS consent, check out our [*TCPA requirements article*](https://my.drip.com/docs/manual/sms/compliance-manage-sms-compliance).",
      optional: true,
    },
    userId: {
      type: "string",
      label: "User Id",
      description: "A unique identifier for the user in your database, such as a primary key.",
      optional: true,
    },
    timezone: {
      type: "string",
      label: "Timezone",
      description: "The subscriber's time zone (in Olson format). Defaults to `Etc/UTC`",
      optional: true,
    },
    lifetimeValue: {
      type: "string",
      label: "Lifetime Value",
      description: "The lifetime value of the subscriber (in cents).",
      optional: true,
    },
    ipAddress: {
      type: "string",
      label: "IP Address",
      description: "The subscriber's ip address E.g. \"111.111.111.11\"",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "An Object containing custom field data. E.g. { \"shirt_size\": \"Medium\" }",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "An Array containing one or more tags. E.g. [\"Customer\", \"SEO\"].",
      optional: true,
    },
    removeTags: {
      type: "string[]",
      label: "Remove Tags",
      description: "An Array containing one or more tags to be removed from the subscriber. E.g. [\"Customer\", \"SEO\"].",
      optional: true,
    },
    prospect: {
      type: "boolean",
      label: "Prospect",
      description: "A Boolean specifiying whether we should attach a lead score to the subscriber (when lead scoring is enabled). Defaults to `true`. *Note:* This flag used to be called `potential_lead`, which we will continue to accept for backwards compatibility.",
      optional: true,
    },
    baseLeadScore: {
      type: "integer",
      label: "Base Lead Score",
      description: "An Integer specifying the starting value for lead score calculation for this subscriber. Defaults to `30`.",
      optional: true,
    },
    euConsent: {
      type: "string",
      label: "EU Consent",
      description: "A String specifying whether the subscriber `granted` or `denied` *GDPR* consent.",
      optional: true,
      options: [
        "granted",
        "denied",
      ],
    },
    euConsentMessage: {
      type: "string",
      label: "EU Consent Message",
      description: "A String containing the message the subscriber granted or denied their consent to.",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "A String specifying the subscriber's status: either `active` or `unsubscribed`.",
      optional: true,
      options: [
        "active",
        "unsubscribed",
      ],
    },
    initialStatus: {
      type: "string",
      label: "Initial Status",
      description: "A String specifying the subscriber's known status: either `active` or `unsubscribed`. To be used if subscriber's status is unchanged.",
      optional: true,
      options: [
        "active",
        "unsubscribed",
      ],
    },
  },
  async run({ $ }) {
    const {
      email,
      visitorUuid,
      newEmail,
      firstName,
      lastName,
      address1,
      address2,
      city,
      state,
      zip,
      country,
      phone,
      smsNumber,
      smsConsent,
      userId,
      timezone,
      lifetimeValue,
      ipAddress,
      customFields,
      tags,
      removeTags,
      prospect,
      baseLeadScore,
      euConsent,
      euConsentMessage,
      status,
      initialStatus,
    } = this;

    const response = await this.drip.createOrUpdateSubscriber({
      $,
      data: {
        subscribers: [
          {
            email: email && email.label
              ? email.label
              : email,
            id: email?.value,
            visitor_uuid: visitorUuid,
            new_email: newEmail,
            first_name: firstName,
            last_name: lastName,
            address1,
            address2,
            city,
            state,
            zip,
            country,
            phone,
            sms_number: smsNumber,
            sms_consent: smsConsent,
            user_id: userId,
            time_zone: timezone,
            lifetime_value: lifetimeValue,
            ip_address: ipAddress,
            custom_fields: customFields,
            tags,
            remove_tags: removeTags,
            prospect,
            base_lead_score: baseLeadScore,
            eu_consent: euConsent,
            eu_consent_message: euConsentMessage,
            status,
            initial_status: initialStatus,
          },
        ],
      },
    });

    $.export("$summary", "Subscriber Successfully created/updated");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Drip	`drip`	`app`	This component uses the Drip app.
Email	`email`	`string`	Select a value from the drop down menu.
Visitor UUID	`visitorUuid`	`string`	The `uuid` for a subscriber's visitor record. Either `email` or `visitor_uuid` must be included.
New Email	`newEmail`	`string`	A new email address for the subscriber. If provided and a subscriber with the `email` above does not exist, this address will be used to create a new subscriber.
First Name	`firstName`	`string`	The subscriber's first name.
Last Name	`lastName`	`string`	The subscriber's last name.
Address 1	`address1`	`string`	The subscriber's mailing address.
Address 2	`address2`	`string`	An additional field for the subscriber's mailing address.
City	`city`	`string`	The city, town, or village in which the subscriber resides.
State	`state`	`string`	The region in which the subscriber resides. Typically a province, a state, or a prefecture.
ZIP	`zip`	`string`	The postal code in which the subscriber resides, also known as zip, postcode, Eircode, etc.
Country	`country`	`string`	The country in which the subscriber resides.
Phone	`phone`	`string`	The subscriber's primary phone number.
SMS Number	`smsNumber`	`string`	The subscriber's mobile phone number in E.164 formatting. E.g. "+16125551212". Only US-based numbers are supported at this time.
SMS Consent	`smsConsent`	`boolean`	`true` if the person has granted consent to receive marketing and other communication via SMS; `false` otherwise. Default: false. If you're unsure whether or not you have gained legal SMS consent, check out our TCPA requirements article.
User Id	`userId`	`string`	A unique identifier for the user in your database, such as a primary key.
Timezone	`timezone`	`string`	The subscriber's time zone (in Olson format). Defaults to `Etc/UTC`
Lifetime Value	`lifetimeValue`	`string`	The lifetime value of the subscriber (in cents).
IP Address	`ipAddress`	`string`	The subscriber's ip address E.g. "111.111.111.11"
Custom Fields	`customFields`	`object`	An Object containing custom field data. E.g. { "shirt_size": "Medium" }
Tags	`tags`	`string[]`	An Array containing one or more tags. E.g. ["Customer", "SEO"].
Remove Tags	`removeTags`	`string[]`	An Array containing one or more tags to be removed from the subscriber. E.g. ["Customer", "SEO"].
Prospect	`prospect`	`boolean`	A Boolean specifiying whether we should attach a lead score to the subscriber (when lead scoring is enabled). Defaults to `true`. Note: This flag used to be called `potential_lead`, which we will continue to accept for backwards compatibility.
Base Lead Score	`baseLeadScore`	`integer`	An Integer specifying the starting value for lead score calculation for this subscriber. Defaults to `30`.
EU Consent	`euConsent`	`string`	Select a value from the drop down menu:`granteddenied`
EU Consent Message	`euConsentMessage`	`string`	A String containing the message the subscriber granted or denied their consent to.
Status	`status`	`string`	Select a value from the drop down menu:`activeunsubscribed`
Initial Status	`initialStatus`	`string`	Select a value from the drop down menu:`activeunsubscribed`

Action Authentication#

Drip uses OAuth authentication. When you connect your Drip account, Pipedream will open a popup window where you can sign into Drip and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Drip API.

Pipedream requests the following authorization scopes when you connect your account: