Add or Update User with AcyMailing API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Add or Update User action
1. Connect your AcyMailing account
2. Configure Email
3. Optional- Configure Name
4. Optional- Configure Active
5. Optional- Configure Confirmed
6. Optional- Configure CMS Id
7. Optional- Configure Custom Fields
8. Optional- Configure Triggers
9. Optional- Configure Send Conf
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 or Update User with AcyMailing API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + AcyMailing

Try it

Add or Update User with AcyMailing API on New Submission from Typeform API

Typeform + AcyMailing

Try it

Add or Update User with AcyMailing API on New Submission (Instant) from Jotform API

Jotform + AcyMailing

Try it

Add or Update User with AcyMailing API on New Scheduled Tasks from Pipedream API

Pipedream + AcyMailing

Try it

Add or Update User with AcyMailing API on npm Download Counts from npm API

npm + AcyMailing

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 or Update User on AcyMailing

Description:Creates a new user or updates an existing user in AcyMailing. If the user exists, will update the user's data with provided information. [See the documentation](https://docs.acymailing.com/v/rest-api/users#create-or-update-a-user)

Version:0.0.1

Key:acymailing-add-update-user

View on GitHub

Code#

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

export default {
  key: "acymailing-add-update-user",
  name: "Add or Update User",
  description: "Creates a new user or updates an existing user in AcyMailing. If the user exists, will update the user's data with provided information. [See the documentation](https://docs.acymailing.com/v/rest-api/users#create-or-update-a-user)",
  version: "0.0.1",
  type: "action",
  props: {
    acymailing,
    email: {
      type: "string",
      label: "Email",
      description: "The email address is used when updating an existing user.",
    },
    name: {
      type: "string",
      label: "Name",
      description: "Any character should be available.",
      optional: true,
    },
    active: {
      type: "boolean",
      label: "Active",
      description: "Defaults to true.",
      optional: true,
    },
    confirmed: {
      type: "boolean",
      label: "Confirmed",
      description: "The confirmation is related to the \"Require confirmation\" option in the configuration, tab \"Subscription\".",
      optional: true,
    },
    cmsId: {
      type: "integer",
      label: "CMS Id",
      description: "The cms_id must match the ID of the corresponding Joomla/WordPress user.",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "An object of field Ids and values.",
      optional: true,
    },
    triggers: {
      type: "boolean",
      label: "Triggers",
      description: "Defaults to true. Defines if the saving of the user triggers automated tasks like follow-up campaigns and automations.",
      optional: true,
    },
    sendConf: {
      type: "boolean",
      label: "Send Conf",
      description: "Defaults to true. Defines if the confirmation email should be sent when a new user is created.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.acymailing.createUserOrUpdate({
      $,
      data: {
        email: this.email,
        name: this.name,
        active: this.active,
        confirmed: this.confirmed,
        cmsId: this.cmsId,
        customFields: parseObject(this.customFields),
        triggers: this.triggers,
        sendConf: this.sendConf,
      },
    });
    $.export("$summary", `Successfully added or updated user with email with Id: ${response.userId}`);
    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
AcyMailing	`acymailing`	`app`	This component uses the AcyMailing app.
Email	`email`	`string`	The email address is used when updating an existing user.
Name	`name`	`string`	Any character should be available.
Active	`active`	`boolean`	Defaults to true.
Confirmed	`confirmed`	`boolean`	The confirmation is related to the "Require confirmation" option in the configuration, tab "Subscription".
CMS Id	`cmsId`	`integer`	The cms_id must match the ID of the corresponding Joomla/WordPress user.
Custom Fields	`customFields`	`object`	An object of field Ids and values.
Triggers	`triggers`	`boolean`	Defaults to true. Defines if the saving of the user triggers automated tasks like follow-up campaigns and automations.
Send Conf	`sendConf`	`boolean`	Defaults to true. Defines if the confirmation email should be sent when a new user is created.