View as Markdown
Userflow icon

Userflow ACTION

Create or Update User

Creates or updates a user in Userflow. If the user does not already exist in Userflow, it will be created. If it already exists, the given attributes will be merged into the existing user's attributes. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Userflow account once, then configure and run Create or Update 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: "userflow-create-update-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    userflow: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    numberOfGroups: 10,
  },
})

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 or Update User inputs
Property Type Description
userId User ID string
The unique identifier for the user.
Required Dynamic
numberOfGroups Number Of Groups integer
The number of groups to create/update for the user.
Optional
numberOfMemberships Number Of Memberships integer
The number of memberships to create/update for the user.
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
userflow-create-update-user
Version
0.0.2
App
Userflow
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes