View as Markdown
Engage icon

Engage ACTION

Add Customer

Adds Customer to Accounts. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Engage account once, then configure and run Add Customer 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: "engage-add-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    engage: { authProvisionId: "apn_xxxxxxx" },
    uid: "User ID",
    customerId: "Customer ID",
  },
})

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 Customer inputs
Property Type Description
uid User ID string
ID of the user
Required Dynamic
customerId Customer ID string
ID of the customer that will be added to the user
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
engage-add-customer
Version
0.0.2
App
Engage
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes