← Klaviyo

Add Member To List with Klaviyo API

Pipedream makes it easy to connect APIs for Klaviyo and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add Member To List with the Klaviyo API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜

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

Adyen logo
Brex logo
Carta logo
Checkr logo
Chameleon logo
DevRev logo
LinkedIn logo
Netflix logo
New Relic logo
OnDeck logo
Replicated logo
Scale AI logo
Teamwork logo
Warner Bros. logo
Xendit logo

Developers Pipedream

Getting Started

Create a workflow to Add Member To List with the Klaviyo API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add Member To List action
    1. Connect your Klaviyo account
    2. Select a List
    3. Configure Email
    4. Optional- Configure Phone Number
    5. Optional- Configure External Id
    6. Optional- Configure Title
    7. Optional- Configure Organization
    8. Optional- Configure First Name
    9. Optional- Configure Last Name
    10. Optional- Configure Image
    11. Optional- Configure Address 1
    12. Optional- Configure Address 2
    13. Optional- Configure City
    14. Optional- Configure Country
    15. Optional- Configure Latitude
    16. Optional- Configure Longitude
    17. Optional- Configure Region
    18. Optional- Configure Zip
    19. Optional- Configure Timezone
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Add Member To List with Klaviyo API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Klaviyo
 
Try it
Add Member To List with Klaviyo API on New Item in Feed from RSS API
RSS + Klaviyo
 
Try it
Add Member To List with Klaviyo API on New Submission from Typeform API
Typeform + Klaviyo
 
Try it
Add Member To List with Klaviyo API on Custom Events from Zoom API
Zoom + Klaviyo
 
Try it
Add Member To List with Klaviyo API on New Submission (Instant) from Jotform API
Jotform + Klaviyo
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Add Member To List on Klaviyo
Description:Add member to a specific list. [See the docs here](https://developers.klaviyo.com/en/v1-2/reference/add-members)
Version:0.0.1
Key:klaviyo-add-member-to-list

Code

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

export default {
  key: "klaviyo-add-member-to-list",
  name: "Add Member To List",
  description: "Add member to a specific list. [See the docs here](https://developers.klaviyo.com/en/v1-2/reference/add-members)",
  version: "0.0.1",
  type: "action",
  props: {
    klaviyo,
    list: {
      propDefinition: [
        klaviyo,
        "list",
      ],
    },
    email: {
      propDefinition: [
        klaviyo,
        "email",
      ],
    },
    phone: {
      propDefinition: [
        klaviyo,
        "phone",
      ],
      optional: true,
    },
    externalId: {
      propDefinition: [
        klaviyo,
        "externalId",
      ],
      optional: true,
    },
    title: {
      propDefinition: [
        klaviyo,
        "title",
      ],
      optional: true,
    },
    organization: {
      propDefinition: [
        klaviyo,
        "organization",
      ],
      optional: true,
    },
    firstName: {
      propDefinition: [
        klaviyo,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        klaviyo,
        "lastName",
      ],
      optional: true,
    },
    image: {
      propDefinition: [
        klaviyo,
        "image",
      ],
      optional: true,
    },
    address1: {
      propDefinition: [
        klaviyo,
        "address1",
      ],
      optional: true,
    },
    address2: {
      propDefinition: [
        klaviyo,
        "address2",
      ],
      optional: true,
    },
    city: {
      propDefinition: [
        klaviyo,
        "city",
      ],
      optional: true,
    },
    country: {
      propDefinition: [
        klaviyo,
        "country",
      ],
      optional: true,
    },
    latitude: {
      propDefinition: [
        klaviyo,
        "latitude",
      ],
      optional: true,
    },
    longitude: {
      propDefinition: [
        klaviyo,
        "longitude",
      ],
      optional: true,
    },
    region: {
      propDefinition: [
        klaviyo,
        "region",
      ],
      optional: true,
    },
    zip: {
      propDefinition: [
        klaviyo,
        "zip",
      ],
      optional: true,
    },
    timezone: {
      propDefinition: [
        klaviyo,
        "timezone",
      ],
      optional: true,
    },
  },
  methods: {
    getSummary() {
      return `${this.email || this.phone
       || this.externalId} successfully added to "${this.list.label}"!`;
    },
  },
  async run({ $ }) {
    const {
      list,
      email,
      phone,
      externalId,
      title,
      organization,
      firstName,
      lastName,
      image,
      address1,
      address2,
      city,
      country,
      latitude,
      longitude,
      region,
      zip,
      timezone,
    } = this;

    const opts = {
      email,
      id: externalId,
      title,
      organization,
      first_name: firstName,
      last_name: lastName,
      image,
      location: {
        address1,
        address2,
        city,
        country,
        latitude,
        longitude,
        region,
        zip,
        timezone,
      },
    };

    if (phone) opts.phone_number = phone;

    const [
      response,
    ] = await this.klaviyo.addMemberToList(list.value, {
      body: {
        profiles: [
          opts,
        ],
      },
    });

    $.export("$summary", response || this.getSummary(response));
    return response;
  },
};

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.
LabelPropTypeDescription
KlaviyoklaviyoappThis component uses the Klaviyo app.
ListliststringSelect a value from the drop down menu.
Emailemailstring

The contact's email.

Phone Numberphonestring

The contact's phone number.

External IdexternalIdstring

A unique external Id which identifies the profile.

Titletitlestring

The member's title.

Organizationorganizationstring

The member's organization.

First NamefirstNamestring

The member's first name.

Last NamelastNamestring

The member's last name.

Imageimagestring

A URL image to member's profile.

Address 1address1string

The member's address.

Address 2address2string

The member's address 2.

Citycitystring

The member's city.

Countrycountrystring

The member's country.

Latitudelatitudestring

The member's latitude.

Longitudelongitudestring

The member's longitude.

Regionregionstring

The member's region.

Zipzipstring

The member's zip.

Timezonetimezonestring

The member's timezone.

Authentication

Klaviyo uses API keys for authentication. When you connect your Klaviyo account, Pipedream securely stores the keys so you can easily authenticate to Klaviyo APIs in both code and no-code steps.

About Klaviyo

Email Marketing and SMS Marketing Platform

More Ways to Use Klaviyo

Actions

Create New List with the Klaviyo API

Creates a new list in an account. See the docs here

 
Try it
Get Lists with the Klaviyo API

Get a listing of all of the lists in an account. See the docs here

 
Try it