← Omnisend

Update Contact with Omnisend API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Update Contact with the Omnisend API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Update Contact with the Omnisend API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Update Contact action
    1. Connect your Omnisend account
    2. Select a Contact ID
    3. Optional- Configure First Name
    4. Optional- Configure Last Name
    5. Optional- Configure Tags
    6. Optional- Configure Country
    7. Optional- Configure Country Code
    8. Optional- Configure State
    9. Optional- Configure City
    10. Optional- Configure Address
    11. Optional- Configure Postal Code
    12. Optional- Select a Gender
    13. Optional- Configure Birthdate
    14. Optional- Configure Custom Properties
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Update Contact with Omnisend API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Omnisend
 
Try it
Update Contact with Omnisend API on New Submission from Typeform API
Typeform + Omnisend
 
Try it
Update Contact with Omnisend API on Custom Events from Zoom API
Zoom + Omnisend
 
Try it
Update Contact with Omnisend API on New Submission (Instant) from Jotform API
Jotform + Omnisend
 
Try it
Update Contact with Omnisend API on New Scheduled Tasks from Pipedream API
Pipedream + Omnisend
 
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.

Update Contact on Omnisend
Description:Modify subscriber information or update their subscription status. [See the documentation](https://api-docs.omnisend.com/reference/patch_contacts-contactid)
Version:0.0.1
Key:omnisend-update-contact

Code

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

export default {
  key: "omnisend-update-contact",
  name: "Update Contact",
  description: "Modify subscriber information or update their subscription status. [See the documentation](https://api-docs.omnisend.com/reference/patch_contacts-contactid)",
  version: "0.0.1",
  type: "action",
  props: {
    omnisend,
    contactId: {
      propDefinition: [
        omnisend,
        "contactId",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the contact.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the contact.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Tags are labels you create to organize and manage your audience.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The country of the contact.",
      optional: true,
    },
    countryCode: {
      type: "string",
      label: "Country Code",
      description: "The ISO country code (2 characters).",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "The state of the contact.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "The city of the contact.",
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "The street address of the contact.",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "The postal or zip code of the contact.",
      optional: true,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "The gender of the contact ('m' for male, 'f' for female).",
      options: [
        "m",
        "f",
      ],
      optional: true,
    },
    birthdate: {
      type: "string",
      label: "Birthdate",
      description: "The birthdate of the contact in YYYY-MM-DD format.",
      optional: true,
    },
    customProperties: {
      type: "object",
      label: "Custom Properties",
      description: "Custom properties for the contact.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      omnisend,
      contactId,
      ...data
    } = this;

    const response = await omnisend.updateContact({
      $,
      contactId,
      data,
    });

    $.export("$summary", `Successfully updated contact with ID ${contactId}`);
    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.
LabelPropTypeDescription
OmnisendomnisendappThis component uses the Omnisend app.
Contact IDcontactIdstringSelect a value from the drop down menu.
First NamefirstNamestring

The first name of the contact.

Last NamelastNamestring

The last name of the contact.

Tagstagsstring[]

Tags are labels you create to organize and manage your audience.

Countrycountrystring

The country of the contact.

Country CodecountryCodestring

The ISO country code (2 characters).

Statestatestring

The state of the contact.

Citycitystring

The city of the contact.

Addressaddressstring

The street address of the contact.

Postal CodepostalCodestring

The postal or zip code of the contact.

GendergenderstringSelect a value from the drop down menu:mf
Birthdatebirthdatestring

The birthdate of the contact in YYYY-MM-DD format.

Custom PropertiescustomPropertiesobject

Custom properties for the contact.

Authentication

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

You can get your API Key under Store Settings > API Keys page.

About Omnisend

Marketing automation built for ecommerce. Increase your sales, not your workload.

More Ways to Use Omnisend

Triggers

New Contact Created from the Omnisend API

Emit new event each time a new contact is created in Omnisend.

 
Try it
New Order Completed from the Omnisend API

Emit new event for each new completed order in Omnisend.

 
Try it

Actions

Start Campaign with the Omnisend API

Starts a marketing campaign for selected subscribers. See the documentation

 
Try it
Trigger Custom Event with the Omnisend API

Trigger custom event to Omnisend. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.