Create/Update Contact with Simplero API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Create/Update Contact action
1. Connect your Simplero account
2. Configure Email
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure IP Address
6. Optional- Configure Referrer
7. Optional- Configure Ref
8. Optional- Configure Landing Page ID
9. Optional- Configure Tags
10. Optional- Configure Note
11. Optional- Configure Phone
12. Optional- Configure GDPR Consent
13. Optional- Configure GDPR Consent Text
14. Optional- Configure Custom 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.

Create/Update Contact on Simplero

Description:Create a new contact or update an existing contact with the same email. [See the documentation](https://github.com/Simplero/Simplero-API?tab=readme-ov-file#createupdate-contact)

Version:0.0.1

Key:simplero-create-update-contact

View on GitHub

Code#

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

export default {
  type: "action",
  key: "simplero-create-update-contact",
  name: "Create/Update Contact",
  description: "Create a new contact or update an existing contact with the same email. [See the documentation](https://github.com/Simplero/Simplero-API?tab=readme-ov-file#createupdate-contact)",
  version: "0.0.1",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    firstName: {
      propDefinition: [
        app,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        app,
        "lastName",
      ],
      optional: true,
    },
    ipAddress: {
      propDefinition: [
        app,
        "ipAddress",
      ],
      optional: true,
    },
    referrer: {
      propDefinition: [
        app,
        "referrer",
      ],
      optional: true,
    },
    ref: {
      propDefinition: [
        app,
        "ref",
      ],
      optional: true,
    },
    landingPageId: {
      propDefinition: [
        app,
        "landingPageId",
      ],
      optional: true,
    },
    tags: {
      propDefinition: [
        app,
        "tags",
      ],
      optional: true,
    },
    note: {
      type: "string",
      label: "Note",
      description: "A note to add to the contact",
      optional: true,
    },
    phone: {
      propDefinition: [
        app,
        "phone",
      ],
      optional: true,
    },
    gdprConsent: {
      propDefinition: [
        app,
        "gdprConsent",
      ],
      optional: true,
    },
    gdprConsentText: {
      type: "string",
      label: "GDPR Consent Text",
      description: "The text of the GDPR consent request (e.g. Subscribe to our newsletter)",
      optional: true,
    },
    customFields: {
      type: "object",
      label: "Custom Fields",
      description: "Custom fields to add to the contact. Keys are custom field ID. [See the documentation](https://github.com/Simplero/Simplero-API?tab=readme-ov-file#custom-contact-fields) for more information.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.app.createOrUpdateContact({
      $,
      data: {
        track: "Pipedream",
        override: "yes",
        email: this.email,
        first_name: this.firstName,
        last_name: this.lastName,
        ip_address: this.ipAddress,
        referrer: this.referrer,
        phone: this.phone,
        tags: this.tags && parseObject(this.tags) || [],
        note: this.note,
        gdpr_consent: +this.gdprConsent,
        gdpr_consent_text: this.gdprConsentText,
        ...(this.customFields && parseObject(this.customFields)),
      },
    });

    const action = response.contact_since === "less than a minute"
      ? "created"
      : "updated";

    $.export("$summary", `Successfully ${action} contact: ${this.email}`);

    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
Simplero	`app`	`app`	This component uses the Simplero app.
Email	`email`	`string`	The email address of the contact
First Name	`firstName`	`string`	The first name of the contact
Last Name	`lastName`	`string`	The last name of the contact
IP Address	`ipAddress`	`string`	The IP address of the contact
Referrer	`referrer`	`string`	The referrer URL
Ref	`ref`	`integer`	The ref of the contact
Landing Page ID	`landingPageId`	`integer`	The landing page ID to track the contact from
Tags	`tags`	`string[]`	A list of tags to add to the contact
Note	`note`	`string`	A note to add to the contact
Phone	`phone`	`string`	Sanitized phone number with country code first, e.g. '15551231234'
GDPR Consent	`gdprConsent`	`boolean`	Whether the contact has given GDPR consent
GDPR Consent Text	`gdprConsentText`	`string`	The text of the GDPR consent request (e.g. Subscribe to our newsletter)
Custom Fields	`customFields`	`object`	Custom fields to add to the contact. Keys are custom field ID. See the documentation for more information.

Authentication#

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

To access your API key,

Select "Settings" from your Simplero Dashboard
Select "Integrations"
Click the "+ Create new API Key" button to get started
Set your application_info by following the instructions here: https://github.com/Simplero/Simplero-API#identify-your-application-in-the-user-agent-string