View as Markdown
Superdocu icon

Superdocu ACTION

Create Dossier

Create a dossier by assigning a workflow to an existing Superdocu contact (the API calls this a contact workflow). Run List Contacts (or Create Contact) first to obtain a contactId, and List Templates to obtain a workflowId. Returns the created dossier with its id and initial status. The API returns 422 if the workflow is disabled, or 409 if a non-repeatable workflow is already assigned. 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 Create Dossier 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-create-dossier",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    superdocu: { authProvisionId: "apn_xxxxxxx" },
    contactId: "Contact ID",
    workflowId: 10,
  },
})

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 Dossier inputs
Property Type Description
contactId Contact ID string
The numeric ID of the contact, as a string (e.g. "56031"). Run List Contacts first to obtain a valid contact ID — it is the id field on each returned contact (do NOT pass the contact's email here).
Required
workflowId Workflow ID integer
The integer ID of the workflow template (e.g. 5740). Run List Templates first to obtain a valid workflow ID — it is the numeric id on each returned template.
Required
notify Notify boolean
When true, sends an invitation email to the contact upon assignment. Defaults to false.
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
superdocu-create-dossier
Version
0.0.2
App
Superdocu
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes