Create or Update Contact with Regal API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Create or Update Contact action
1. Connect your Regal account
2. Optional- Configure User ID
3. Optional- Configure Phone
4. Optional- Configure SMS Opt-In
5. Optional- Configure Voice Opt-In
6. Optional- Configure Email
7. Optional- Configure Email Opt-In
8. Optional- Configure First Name
9. Optional- Configure Last Name
10. Optional- Configure Street Address
11. Optional- Configure City
12. Optional- Configure State
13. Optional- Configure Zip
14. Optional- Configure Country
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#

Create or Update Contact with Regal API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Regal

Try it

Create or Update Contact with Regal API on New Submission from Typeform API

Typeform + Regal

Try it

Create or Update Contact with Regal API on New Submission (Instant) from Jotform API

Jotform + Regal

Try it

Create or Update Contact with Regal API on New Scheduled Tasks from Pipedream API

Pipedream + Regal

Try it

Create or Update Contact with Regal API on New Download Counts from npm API

npm + Regal

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.

Create or Update Contact on Regal

Description:Create or update a contacts. [See the documentation](https://developer.regal.io/reference/api)

Version:0.0.1

Key:regal-create-or-update-contact

View on GitHub

Code#

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

export default {
  key: "regal-create-or-update-contact",
  name: "Create or Update Contact",
  description: "Create or update a contacts. [See the documentation](https://developer.regal.io/reference/api)",
  version: "0.0.1",
  type: "action",
  props: {
    regal,
    userId: {
      propDefinition: [
        regal,
        "userId",
      ],
    },
    phone: {
      propDefinition: [
        regal,
        "phone",
      ],
    },
    smsOptIn: {
      type: "boolean",
      label: "SMS Opt-In",
      description: "SMS subscription status. Defaults to `true`",
      default: true,
      optional: true,
    },
    voiceOptIn: {
      type: "boolean",
      label: "Voice Opt-In",
      description: "Voice subscription status. Defaults to `true`",
      default: true,
      optional: true,
    },
    email: {
      propDefinition: [
        regal,
        "email",
      ],
    },
    emailOptIn: {
      type: "boolean",
      label: "Email Opt-In",
      description: "Email subscription status. Defaults to `true`",
      default: true,
      optional: true,
    },
    firstName: {
      propDefinition: [
        regal,
        "firstName",
      ],
    },
    lastName: {
      propDefinition: [
        regal,
        "lastName",
      ],
    },
    streetAddress: {
      type: "string",
      label: "Street Address",
      description: "Street address of the contact",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City of the contact",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State/Region of the contact",
      optional: true,
    },
    zip: {
      type: "string",
      label: "Zip",
      description: "Zip code of the contact",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country of the contact. Example: `United States`",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.regal.customEvent({
      $,
      data: {
        userId: this.userId,
        traits: {
          firstName: this.firstName,
          lastName: this.lastName,
          phones: this.phone
            ? {
              [this.phone]: {
                voiceOptIn: {
                  subscribed: this.voiceOptIn,
                },
                smsOptIn: {
                  subscribed: this.smsOptIn,
                },
              },
            }
            : undefined,
          emails: this.email
            ? {
              [this.email]: {
                emailOptIn: {
                  subscribed: this.emailOptIn,
                },
              },
            }
            : undefined,
          address: {
            street: this.streetAddress,
            city: this.city,
            state: this.state,
            zipcode: this.zip,
            country: this.country,
          },
        },
      },
    });
    if (response?.message === "ok") {
      $.export("$summary", "Successfully created or updated contact");
    }
    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
Regal	`regal`	`app`	This component uses the Regal app.
User ID	`userId`	`string`	Unique identifier for your contact
Phone	`phone`	`string`	Phone number of the contact. Example: `+1 (954) 555-2399`
SMS Opt-In	`smsOptIn`	`boolean`	SMS subscription status. Defaults to `true`
Voice Opt-In	`voiceOptIn`	`boolean`	Voice subscription status. Defaults to `true`
Email	`email`	`string`	Email address of the contact
Email Opt-In	`emailOptIn`	`boolean`	Email subscription status. Defaults to `true`
First Name	`firstName`	`string`	First name of the contact
Last Name	`lastName`	`string`	Last name of the contact
Street Address	`streetAddress`	`string`	Street address of the contact
City	`city`	`string`	City of the contact
State	`state`	`string`	State/Region of the contact
Zip	`zip`	`string`	Zip code of the contact
Country	`country`	`string`	Country of the contact. Example: `United States`