View as Markdown
Engage icon

Engage ACTION

Create User

Adds a new user to your Engage account. Use this to sync customer data with Engage. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Engage account once, then configure and run Create User 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-create-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    engage: { authProvisionId: "apn_xxxxxxx" },
    userId: "User 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.

Create User inputs
Property Type Description
userId User ID string
Unique identifier for the user
Required
firstName First name string
The user's first name
Required
lastName Last name string
The user's last name
Required
isAccount Is account boolean
Indicates whether the user is also an account
Required
number Number string
A contact number associated with the user
Required
email Email string
The user's email address
Required

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-create-user
Version
0.0.2
App
Engage
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes