View as Markdown
Docusign icon

Docusign ACTION

Create Envelope From File

Create and optionally send a single-document DocuSign envelope from a file path or URL. This action places a SignHere tab by anchor text, such as /sn1/, in the uploaded document. Set Client User ID when you need embedded signing, then use Create Recipient View with the same value. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Docusign account once, then configure and run Create Envelope From File 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: "docusign-create-envelope-from-file",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    docusign: { authProvisionId: "apn_xxxxxxx" },
    account: "Account",
    filePath: "File Path or URL",
  },
})

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 Envelope From File inputs
Property Type Description
account Account string
Your DocuSign account. Leave blank to automatically use your default account, or provide an Account ID (you can use List Accounts to retrieve available accounts).
Optional Dynamic
filePath File Path or URL string
The document to send. Provide either a file URL or a path to a file in /tmp, for example /tmp/contract.pdf.
Required
syncDir SyncDir dir
Optional
emailSubject Email Subject string
Subject line of email
Required
signerName Signer Name string
The full name of the recipient
Required
signerEmail Signer Email string
Email address of signature request recipient
Required
status Status string
Use sent to send immediately or created to save as a draft.
Required
documentName Document Name string
Optional document name shown in DocuSign. Defaults to the uploaded file name.
Optional
fileExtension File Extension string
Optional file extension. Defaults to the uploaded file extension, or pdf if one cannot be detected.
Optional
signerRecipientId Signer Recipient ID string
Recipient ID to assign to the new signer in this envelope.
Optional
routingOrder Routing Order string
Routing order for the signer.
Optional
clientUserId Client User ID string
Set this for embedded signing recipients. The same value is required when creating a recipient view URL.
Optional
signHereAnchorString Sign Here Anchor String string
Text in the document where DocuSign should place the signature tab. The text is not shown to signers. Example: /sn1/.
Required
anchorXOffset Anchor X Offset string
Horizontal offset in pixels for the signature tab relative to the anchor text.
Optional
anchorYOffset Anchor Y Offset string
Vertical offset in pixels for the signature tab relative to the anchor text.
Optional
signerOverridesJson Signer Overrides JSON string
Optional JSON object merged into the signer object using ...signerOverrides for advanced recipient settings. Example: {"note":"Please sign by Friday"}. If signerOverridesJson includes a tabs key, it overwrites the generated signHereTabs from signHereAnchorString; omit tabs or include signHereTabs in the override to preserve anchor signing.
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
docusign-create-envelope-from-file
Version
0.0.4
App
Docusign
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes