View as Markdown
BigMailer icon

BigMailer ACTION

Add or Update Contact

Creates or updates a contact within a brand. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BigMailer account once, then configure and run Add or 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: "bigmailer-add-update-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bigmailer: { authProvisionId: "apn_xxxxxxx" },
    brandId: "Brand ID",
    email: "Email",
  },
})

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.

Add or Update Contact inputs
Property Type Description
brandId Brand ID string
The ID of the brand
Required Dynamic
email Email string
Email address of the contact. If the specified email does not exist, a new contact is created. If the specified email exists, the existing contact is updated.
Required
listIds List ID string[]
The ID of the list
Required Dynamic

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
bigmailer-add-update-contact
Version
0.0.2
App
BigMailer
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes