View as Markdown
Ayrshare icon

Ayrshare ACTION

Create User

Create a new User Profile under your Primary Profile. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ayrshare account once, then configure and run Create 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-create-user",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ayrshare: { authProvisionId: "apn_xxxxxxx" },
    title: "Title",
    messagingActive: true,
  },
})

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 User inputs
Property Type Description
title Title string
Unique title for the new profile
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
subHeader Sub Header string
Custom sub-header text shown below the header on the linking page
Optional
disableSocial Disable Social string[]
List of social platforms to disable for this profile
Optional
team Team boolean
Set to true to invite the user as a team member
Optional
email Email string
Email address to send the team invitation to
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-create-user
Version
0.0.2
App
Ayrshare
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes