View as Markdown
Universal API icon

Universal API ACTION

Delete Consumer

Permanently delete a consumer via the Platform API on Universal API. This is irreversible. Run List Consumers first to find the consumer ID. See the documentation.
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Universal API account once, then configure and run Delete Consumer 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: "universal_api-delete-consumer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    universal_api: { authProvisionId: "apn_xxxxxxx" },
    consumerId: "Consumer 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.

Delete Consumer inputs
Property Type Description
consumerId Consumer ID string
The consumer ID. Run List Consumers first to find valid IDs.
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
universal_api-delete-consumer
Version
0.0.2
App
Universal API
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes