View as Markdown
Ayrshare icon

Ayrshare ACTION

Update User

Update an existing profile. 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 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: "ayrshare-update-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ayrshare: { authProvisionId: "apn_xxxxxxx" },
    profileKey: "Profile Key",
    title: "Title",
  },
})

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.

Update User inputs
Property Type Description
profileKey Profile Key string
Unique key returned after profile creation
Required
title Title string
Unique title of the profile that will be updated
Required
messagingActive Messaging Active boolean
Enable messaging functionality for this profile
Optional
hideTopHeader Hide Top Header boolean
Hide the top header text on the account linking page
Optional
topHeader Top Header string
Custom header text shown on the social linking page
Optional
disableSocial Disable Social string[]
List of social platforms to disable for this profile
Optional
tags Tags string[]
Custom internal tags to help categorize the profile
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-update-user
Version
0.0.2
App
Ayrshare
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes