View as Markdown
Plain icon

Plain ACTION

Add Customer to Group

Adds a customer to a customer group. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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 to Group inputs
Property Type Description
customerId Customer ID string
Identifier of a customer
Required Dynamic
groupKey Group Key string
Key identifier of a customer group
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
plain-add-customer-to-group
Version
0.0.2
App
Plain
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes