View as Markdown
Omnisend icon

Omnisend ACTION

Update Contact

Modify subscriber information or update their subscription status. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Omnisend account once, then configure and run Update Contact from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "omnisend-update-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    omnisend: { authProvisionId: "apn_xxxxxxx" },
    contactId: "Contact ID",
    firstName: "First Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Update Contact inputs
Property Type Description
contactId Contact ID string
The unique identifier of the contact to update.
Required Dynamic
firstName First Name string
The first name of the contact.
Optional
lastName Last Name string
The last name of the contact.
Optional
tags Tags string[]
Tags are labels you create to organize and manage your audience.
Optional
country Country string
The country of the contact.
Optional
countryCode Country Code string
The ISO country code (2 characters).
Optional
state State string
The state of the contact.
Optional
city City string
The city of the contact.
Optional
address Address string
The street address of the contact.
Optional
postalCode Postal Code string
The postal or zip code of the contact.
Optional
gender Gender string
The gender of the contact ('m' for male, 'f' for female).
Optional
birthdate Birthdate string
The birthdate of the contact in YYYY-MM-DD format.
Optional
customProperties Custom Properties object
Custom properties for the contact.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
omnisend-update-contact
Version
0.0.2
App
Omnisend
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes