Add or Update Contact with Freshmarketer API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

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

Configure the Add or Update Contact action
1. Connect your Freshmarketer account
2. Configure Contact Email
3. Optional- Configure First Name
4. Optional- Configure Last Name
5. Optional- Select a Subscription Status
6. Optional- Configure Job Title
7. Optional- Configure Work Number
8. Optional- Configure External Id
9. Optional- Configure Mobile Number
10. Optional- Configure Address
11. Optional- Configure City
12. Optional- Configure State
13. Optional- Configure Zipcode
14. Optional- Configure Country
15. Optional- Select a Territory ID
16. Optional- Select a Lead Source ID
17. Optional- Select a Owner ID
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 Contact with Freshmarketer API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Freshmarketer

Try it

Add or Update Contact with Freshmarketer API on New Submission from Typeform API

Typeform + Freshmarketer

Try it

Add or Update Contact with Freshmarketer API on New Submission (Instant) from Jotform API

Jotform + Freshmarketer

Try it

Add or Update Contact with Freshmarketer API on New Scheduled Tasks from Pipedream API

Pipedream + Freshmarketer

Try it

Add or Update Contact with Freshmarketer API on npm Download Counts from npm API

npm + Freshmarketer

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 Contact on Freshmarketer

Description:Create a new contact or updates an existing one.

Version:0.0.1710419079

Key:freshmarketer-add-update-contact

View on GitHub

Code#

import { ConfigurationError } from "@pipedream/platform";
import { SUBSCRIPTION_STATUS_OPTIONS } from "../../common/constants.mjs";
import freshmarketer from "../../freshmarketer.app.mjs";

export default {
  key: "freshmarketer-add-update-contact",
  name: "Add or Update Contact",
  description: "Create a new contact or updates an existing one.",
  version: "0.0.{{ts}}",
  type: "action",
  props: {
    freshmarketer,
    email: {
      propDefinition: [
        freshmarketer,
        "contactEmail",
      ],
      description: "Email on which enttity needs to be created or updated.",
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the contact.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the contact.",
      optional: true,
    },
    subscriptionStatus: {
      type: "string",
      label: "Subscription Status",
      description: "Status of subscription that the contact is in.",
      optional: true,
      options: SUBSCRIPTION_STATUS_OPTIONS,
    },
    jobTitle: {
      type: "string",
      label: "Job Title",
      description: "Designation of the contact in the account he belongs to.",
      optional: true,
    },
    workNumber: {
      type: "string",
      label: "Work Number",
      description: "Work phone number of the contact.",
      optional: true,
    },
    externalId: {
      type: "string",
      label: "External Id",
      description: "External ID of the contact.",
      optional: true,
    },
    mobileNumber: {
      type: "string",
      label: "Mobile Number",
      description: "Mobile phone number of the contact.",
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "Address of the contact.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City that the contact belongs to.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State that the contact belongs to.",
      optional: true,
    },
    zipcode: {
      type: "string",
      label: "Zipcode",
      description: "Zipcode of the region that the contact belongs to.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country that the contact belongs to.",
      optional: true,
    },
    territoryId: {
      propDefinition: [
        freshmarketer,
        "territoryId",
      ],
      optional: true,
    },
    leadSourceId: {
      propDefinition: [
        freshmarketer,
        "leadSourceId",
      ],
      optional: true,
    },
    ownerId: {
      propDefinition: [
        freshmarketer,
        "ownerId",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.email && !this.mobileNumber && ! this.externalId) {
      throw new ConfigurationError("Either Email/Mobile/Twitter ID is required to create a contact.");
    }
    const response = await this.freshmarketer.upsertContact({
      $,
      data: {
        unique_identifier: {
          emails: this.email,
        },
        contact: {
          first_name: this.firstName,
          last_name: this.lastName,
          subscription_status: this.subscriptionStatus,
          job_title: this.jobTitle,
          emails: this.email,
          work_number: this.workNumber,
          external_id: this.externalId,
          mobile_number: this.mobileNumber,
          address: this.address,
          city: this.city,
          state: this.state,
          zipcode: this.zipcode,
          country: this.country,
          territory_id: this.territoryId,
          lead_source_id: this.leadSourceId && this.leadSourceId.toString(),
          owner_id: this.ownerId && this.ownerId.toString(),
        },
      },
    });

    $.export("$summary", `The contact was successfully created/updated with Id: ${response.contact.id}`);
    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
Freshmarketer	`freshmarketer`	`app`	This component uses the Freshmarketer app.
Contact Email	`email`	`string`	Email on which enttity needs to be created or updated.
First Name	`firstName`	`string`	First name of the contact.
Last Name	`lastName`	`string`	Last name of the contact.
Subscription Status	`subscriptionStatus`	`string`	Select a value from the drop down menu:`{ "value": "0", "label": "Unsubscribed" }{ "value": "1", "label": "Subscribed" }{ "value": "2", "label": "Not Subscribed" }{ "value": "3", "label": "Reported as Spam" }{ "value": "4", "label": "Bounced" }`
Job Title	`jobTitle`	`string`	Designation of the contact in the account he belongs to.
Work Number	`workNumber`	`string`	Work phone number of the contact.
External Id	`externalId`	`string`	External ID of the contact.
Mobile Number	`mobileNumber`	`string`	Mobile phone number of the contact.
Address	`address`	`string`	Address of the contact.
City	`city`	`string`	City that the contact belongs to.
State	`state`	`string`	State that the contact belongs to.
Zipcode	`zipcode`	`string`	Zipcode of the region that the contact belongs to.
Country	`country`	`string`	Country that the contact belongs to.
Territory ID	`territoryId`	`string`	Select a value from the drop down menu.
Lead Source ID	`leadSourceId`	`string`	Select a value from the drop down menu.
Owner ID	`ownerId`	`string`	Select a value from the drop down menu.

Authentication#

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

About Freshmarketer#

Freshmarketer is a complete marketing automation suite that helps you manage your contacts and lists, design, and deliver compelling marketing campaigns and automate your email marketing.