View as Markdown
Ayrshare icon

Ayrshare ACTION

Delete User

Delete a user profile you are the owner of. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ayrshare account once, then configure and run Delete 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: "ayrshare-delete-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ayrshare: { authProvisionId: "apn_xxxxxxx" },
    profileToDelete: "Title",
    profileKey: "Profile 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.

Delete User inputs
Property Type Description
profileToDelete Title string
Unique title of the profile that will be deleted. Must be informed only if profileKey is not provided
Optional Dynamic
profileKey Profile Key string
Unique key returned after profile creation. Must be informed only if title is not provided
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
ayrshare-delete-user
Version
0.0.2
App
Ayrshare
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes