Add or Update Subscriber with Acumbamail API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Add or Update Subscriber action
1. Connect your Acumbamail account
2. Select a List ID
3. Optional- Configure Double Opt-in
4. Optional- Configure Update Subscriber
5. Optional- Configure Merge Fields
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.

Add or Update Subscriber on Acumbamail

Description:Adds a new subscriber to a list or updates an existing subscriber. [See the documentation](https://acumbamail.com/en/apidoc/function/addSubscriber/)

Version:0.0.1

Key:acumbamail-add-or-update-subscriber

View on GitHub

Code#

import acumbamail from "../../acumbamail.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "acumbamail-add-or-update-subscriber",
  name: "Add or Update Subscriber",
  description: "Adds a new subscriber to a list or updates an existing subscriber. [See the documentation](https://acumbamail.com/en/apidoc/function/addSubscriber/)",
  version: "0.0.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    acumbamail,
    listId: {
      propDefinition: [
        acumbamail,
        "listId",
      ],
      reloadProps: true,
    },
    doubleOptin: {
      type: "boolean",
      label: "Double Opt-in",
      description: "Activates sending of confirmation email when adding the subscriber",
      optional: true,
    },
    updateSubscriber: {
      type: "boolean",
      label: "Update Subscriber",
      description: "Modifies the fields in the case of a subscriber who is already on the list",
      optional: true,
    },
    mergeFields: {
      type: "object",
      label: "Merge Fields",
      description: "Optionally, add merge fields as a single object. This is a Dictionary that contains the merge tags of the subscriber as keys and the value that will be added to the subscriber",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.listId) {
      return props;
    }
    const fields = await this.acumbamail.getFields({
      params: {
        list_id: this.listId,
      },
    });
    for (const key of Object.keys(fields)) {
      props[key] = {
        type: "string",
        label: key,
        optional: true,
      };
    }
    return props;
  },
  async run({ $ }) {
    const mergeFields = parseObject(this.mergeFields);
    const fields = await this.acumbamail.getFields({
      params: {
        list_id: this.listId,
      },
    });
    for (const key of Object.keys(fields)) {
      if (!this[key]) continue;
      mergeFields[key] = this[key];
    }

    const response = await this.acumbamail.addOrUpdateSubscriber({
      $,
      data: {
        list_id: this.listId,
        double_optin: this.doubleOptin,
        update_subscriber: this.updateSubscriber,
        merge_fields: mergeFields,
        complete_json: true,
      },
    });

    $.export("$summary", "Successfully added or updated subscriber.");
    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
Acumbamail	`acumbamail`	`app`	This component uses the Acumbamail app.
List ID	`listId`	`string`	Select a value from the drop down menu.
Double Opt-in	`doubleOptin`	`boolean`	Activates sending of confirmation email when adding the subscriber
Update Subscriber	`updateSubscriber`	`boolean`	Modifies the fields in the case of a subscriber who is already on the list
Merge Fields	`mergeFields`	`object`	Optionally, add merge fields as a single object. This is a Dictionary that contains the merge tags of the subscriber as keys and the value that will be added to the subscriber

Authentication#

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

To retrieve your Auth Token,