Add Contact to Mailing List with Elastic Email API

Pipedream makes it easy to connect APIs for Elastic Email and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Add Contact to Mailing List with the Elastic Email 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#

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

Configure the Add Contact to Mailing List action
1. Connect your Elastic Email account
2. Configure Email
3. Optional- Select one or more List Names
4. Optional- Select a Status
5. Optional- Configure First Name
6. Optional- Configure Last Name
7. Optional- Configure Custom Fields
8. Optional- Configure Consent IP
9. Optional- Configure Consent Date
10. Optional- Select a Consent Tracking
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Add Contact to Mailing List with Elastic Email API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Elastic Email

Try it

Add Contact to Mailing List with Elastic Email API on New Submission from Typeform API

Typeform + Elastic Email

Try it

Add Contact to Mailing List with Elastic Email API on New Submission (Instant) from Jotform API

Jotform + Elastic Email

Try it

Add Contact to Mailing List with Elastic Email API on New Scheduled Tasks from Pipedream API

Pipedream + Elastic Email

Try it

Add Contact to Mailing List with Elastic Email API on New Download Counts from npm API

npm + Elastic Email

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 Contact to Mailing List on Elastic Email

Description:Adds a new contact to a mailing list. [See the documentation](https://elasticemail.com/developers/api-documentation/rest-api#operation/contactsPost)

Version:0.0.1

Key:elastic_email-add-contact

View on GitHub

Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  CONSENT_TRACKING_OPTIONS,
  STATUS_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import app from "../../elastic_email.app.mjs";

export default {
  key: "elastic_email-add-contact",
  name: "Add Contact to Mailing List",
  description: "Adds a new contact to a mailing list. [See the documentation](https://elasticemail.com/developers/api-documentation/rest-api#operation/contactsPost)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    listNames: {
      propDefinition: [
        app,
        "listNames",
      ],
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "The initial status of the contact.",
      options: STATUS_OPTIONS,
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The contact's first name.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The contact's last name.",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "A key-value collection of custom contact fields which can be used in the system. Only already existing custom fields will be saved.",
      optional: true,
    },
    consentIP: {
      type: "string",
      label: "Consent IP",
      description: "IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent.",
      optional: true,
    },
    consentDate: {
      type: "string",
      label: "Consent Date",
      description: "Date of consent to send this contact(s) your email. If not provided current date is used for consent.",
      optional: true,
    },
    consentTracking: {
      type: "string",
      label: "Consent Tracking",
      description: "Tracking of consent to send this contact(s) your email. Defaults to \"Unknown\".",
      options: CONSENT_TRACKING_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.addContact({
      $,
      params: {
        listnames: parseObject(this.listNames),
      },
      data: [
        {
          Email: this.email,
          Status: this.status,
          FirstName: this.firstName,
          LastName: this.lastName,
          CustomFields: parseObject(this.customFields),
          Consent: {
            ConsentIP: this.consentIP,
            ConsentDate: this.consentDate,
            ConsentTracking: this.consentTracking,
          },
        },
      ],
    });

    if (("success" in response) && response.success === "false") {
      throw new ConfigurationError(response.error);
    }

    $.export("$summary", `Successfully added contact ${this.email} to the mailing list`);
    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.

Label	Prop	Type	Description
Elastic Email	`app`	`app`	This component uses the Elastic Email app.
Email	`email`	`string`	The contact's email
List Names	`listNames`	`string[]`	Select a value from the drop down menu.
Status	`status`	`string`	Select a value from the drop down menu:`TransactionalEngagedActiveBouncedUnsubscribedAbuseInactiveStaleNotConfirmed`
First Name	`firstName`	`string`	The contact's first name.
Last Name	`lastName`	`string`	The contact's last name.
Custom Fields	`customFields`	`object`	A key-value collection of custom contact fields which can be used in the system. Only already existing custom fields will be saved.
Consent IP	`consentIP`	`string`	IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent.
Consent Date	`consentDate`	`string`	Date of consent to send this contact(s) your email. If not provided current date is used for consent.
Consent Tracking	`consentTracking`	`string`	Select a value from the drop down menu:`UnknownAllowDeny`