View as Markdown
Userlist icon

Userlist ACTION

Create or Update Relationship

Establishes or modifies a relationship with the given user and company identifiers. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Userlist account once, then configure and run Create or Update Relationship 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: "userlist-create-update-relationship",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    userlist: { authProvisionId: "apn_xxxxxxx" },
    user: "User ID",
    company: "Company 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.

Create or Update Relationship inputs
Property Type Description
user User ID string
The unique identifier of a user
Required
company Company ID string
Unique identifier for a company
Required
properties Relationship Properties object
Custom relationship properties. Example: {{ { "role": "admin" } }}
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
userlist-create-update-relationship
Version
0.0.2
App
Userlist
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes