Update Campaign with Elastic Email API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Update Campaign 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 Update Campaign with the Elastic Email API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Update Campaign action
1. Connect your Elastic Email account
2. Select a Campaign
3. Optional- Configure Campaign Name
4. Optional- Configure From
5. Optional- Select one or more Recipient List Names
6. Optional- Select one or more Recipient Segment Names
7. Optional- Configure Reply To
8. Optional- Configure Subject
9. Optional- Select a Template Name
10. Optional- Select a Campaign Status
11. Optional- Select one or more Exclude Recipient List Names
12. Optional- Select one or more Exclude Recipient Segment Names
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

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.

Update Campaign on Elastic Email

Description:Update a campaign in an Elastic Email account. [See the documentation](https://elasticemail.com/developers/api-documentation/rest-api#operation/campaignsByNamePut)

Version:0.0.1

Key:elastic_email-update-campaign

View on GitHub

Code#

import app from "../../elastic_email.app.mjs";
import { isValidEmailFormat } from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "elastic_email-update-campaign",
  name: "Update Campaign",
  description: "Update a campaign in an Elastic Email account. [See the documentation](https://elasticemail.com/developers/api-documentation/rest-api#operation/campaignsByNamePut)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    campaign: {
      propDefinition: [
        app,
        "campaign",
      ],
    },
    name: {
      type: "string",
      label: "Campaign Name",
      description: "The name of the campaign",
      optional: true,
    },
    from: {
      type: "string",
      label: "From",
      description: "Your e-mail with an optional name (e.g.: `email@domain.com` or `John Doe <email@domain.com>`)",
      optional: true,
    },
    recipientListNames: {
      propDefinition: [
        app,
        "listNames",
      ],
      label: "Recipient List Names",
      description: "Names of lists from your Account to read recipients from",
    },
    recipientSegmentNames: {
      propDefinition: [
        app,
        "segmentNames",
      ],
      label: "Recipient Segment Names",
      description: "Names of segments from your Account to read recipients from",
      optional: true,
    },
    replyTo: {
      type: "string",
      label: "Reply To",
      description: "To what address should the recipients reply to (e.g. `email@domain.com` or `John Doe <email@domain.com>`)",
      optional: true,
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "Default subject of email",
      optional: true,
    },
    templateName: {
      propDefinition: [
        app,
        "templateName",
      ],
      optional: true,
    },
    status: {
      propDefinition: [
        app,
        "campaignStatus",
      ],
      optional: true,
    },
    excludeRecipientListNames: {
      propDefinition: [
        app,
        "listNames",
      ],
      label: "Exclude Recipient List Names",
      description: "Names of lists from your Account to exclude from the campaign",
    },
    excludeRecipientSegmentNames: {
      propDefinition: [
        app,
        "segmentNames",
      ],
      label: "Exclude Recipient Segment Names",
      description: "Names of segments from your Account to exclude from the campaign",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.from && !isValidEmailFormat(this.from)) {
      throw new ConfigurationError("Invalid email format for 'From'");
    }
    if (this.replyTo && !isValidEmailFormat(this.replyTo)) {
      throw new ConfigurationError("Invalid email format for 'Reply To'");
    }

    const campaign = await this.app.getCampaign({
      $,
      campaign: this.campaign,
    });

    const response = await this.app.updateCampaign({
      $,
      campaign: this.campaign,
      data: {
        Name: this.name || campaign.Name,
        Recipients: {
          ListNames: this.recipientListNames || campaign.Recipients.ListNames || undefined,
          SegmentNames: this.recipientSegmentNames || campaign.Recipients.SegmentNames || undefined,
        },
        Content: [
          {
            From: this.from || campaign.Content[0].From,
            ReplyTo: this.replyTo || campaign.Content[0].ReplyTo,
            Subject: this.subject || campaign.Content[0].Subject,
            TemplateName: this.templateName || campaign.Content[0].TemplateName,
          },
        ],
        Status: this.status || campaign.Status,
        ExcludeRecipients: this.excludeRecipientListNames || this.excludeRecipientSegmentNames
          ? {
            ListNames: this.excludeRecipientListNames
              || campaign.ExcludeRecipients.ListNames
              || undefined,
            SegmentNames: this.excludeRecipientSegmentNames
              || campaign.ExcludeRecipients.SegmentNames
              || undefined,
          }
          : undefined,
      },
    });
    $.export("$summary", "Campaign updated successfully");
    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.
Campaign	`campaign`	`string`	Select a value from the drop down menu.
Campaign Name	`name`	`string`	The name of the campaign
From	`from`	`string`	Your e-mail with an optional name (e.g.: `email@domain.com` or `John Doe <email@domain.com>`)
Recipient List Names	`recipientListNames`	`string[]`	Select a value from the drop down menu.
Recipient Segment Names	`recipientSegmentNames`	`string[]`	Select a value from the drop down menu.
Reply To	`replyTo`	`string`	To what address should the recipients reply to (e.g. `email@domain.com` or `John Doe <email@domain.com>`)
Subject	`subject`	`string`	Default subject of email
Template Name	`templateName`	`string`	Select a value from the drop down menu.
Campaign Status	`status`	`string`	Select a value from the drop down menu:`DeletedActiveProcessingSendingCompletedPausedCancelledDraft`
Exclude Recipient List Names	`excludeRecipientListNames`	`string[]`	Select a value from the drop down menu.
Exclude Recipient Segment Names	`excludeRecipientSegmentNames`	`string[]`	Select a value from the drop down menu.