View as Markdown
Superdocu icon

Superdocu ACTION

Invite Contact

Invite a Superdocu contact: emails them an invitation covering ALL workflows currently assigned to them. The Superdocu API endpoint takes only a contactId and dispatches notifications for every assigned workflow — it is not possible to invite to a single dossier in isolation. Run List Contacts first to obtain a valid contactId. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Superdocu account once, then configure and run Invite Contact 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: "superdocu-invite-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    superdocu: { authProvisionId: "apn_xxxxxxx" },
    contactId: "Contact 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.

Invite Contact inputs
Property Type Description
contactId Contact ID string
The ID of the contact to invite. The invitation covers all workflows assigned to this contact. Run List Contacts first to obtain a valid contact ID.
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
superdocu-invite-contact
Version
0.0.2
App
Superdocu
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes