View as Markdown
Superdocu icon

Superdocu ACTION

Create Contact

Create a new contact in Superdocu. Returns the created contact including its id, which you can then pass as contactId to Create Dossier to assign a workflow. 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 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-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    superdocu: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last Name",
  },
})

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 Contact inputs
Property Type Description
firstName First Name string
The contact's first name.
Required
lastName Last Name string
The contact's last name.
Required
email Email string
The contact's email address, e.g. jane.doe@acme.com.
Required
phone Phone string
The contact's phone number.
Optional
companyName Company Name string
The contact's company name.
Optional
companySiret Company SIRET string
14-digit SIRET identifier for the contact's company, e.g. 73282932000074. Find the SIRET on a company's detail page in Superdocu or from an official business registry.
Optional
companySiren Company SIREN string
9-digit SIREN identifier for the contact's company, e.g. 732829320 (the first 9 digits of the SIRET). Find the SIREN on a company's detail page in Superdocu or from an official business registry.
Optional
locale Locale string
The contact's locale. One of: en, fr, de, nl, pt, es.
Optional
notes Notes string
Free-text notes about the contact.
Optional
tagIds Tag IDs string[]
Integer IDs of tags to assign to the contact, e.g. [123, 456]. Find tag IDs in the Tags section of your Superdocu account settings.
Optional
trackingParams Tracking Params object
Arbitrary tracking parameters as a JSON object, e.g. {"utm_source": "newsletter"}.
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-contact
Version
0.0.2
App
Superdocu
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes