Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
What can you do with it?

Manage and automate document workflows with DocuSign, including creating envelopes, collecting eSignatures, updating documents, sending signature requests, and tracking document status for efficient digital signing processes.

​
How to use it?

​
Basic Command Structure

/your-docusign-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:
  • action - The operation to perform (create-envelope, get-envelope, update-envelope, send-envelope, search-envelopes, get-custom-fields)
Optional:
  • envelope-id - DocuSign envelope ID
  • email-subject - Email subject for the envelope
  • document-name - Name of the document
  • recipient-email - Email address of the recipient
  • recipient-name - Name of the recipient
  • status - Envelope status (created, sent, delivered, completed)

​
Tools

​
Create Envelope

Create a new envelope to collect eSignatures Parameters:
  • email-subject (required) - Email subject for signature request
  • document-base64 (required) - Base64 encoded document content
  • document-name (required) - Name of the document
  • document-extension (required) - File extension (pdf, docx, etc.)
  • recipient-email (required) - Signer’s email address
  • recipient-name (required) - Signer’s name
  • anchor-string (optional) - Text anchor for signature placement
  • anchor-y-offset (optional) - Y offset for signature placement
Example: 
/your-docusign-connection
action: create-envelope
email-subject: Please sign this document
document-base64: BASE64_ENCODED_DOCUMENT
document-name: Contract.pdf
document-extension: pdf
recipient-email: john.doe@example.com
recipient-name: John Doe
anchor-string: /sn1/
anchor-y-offset: -10
Response: 
{
  "envelopeId": "12345678-1234-1234-1234-123456789012",
  "status": "created"
}

​
Get Envelope

Retrieve details of an envelope using its unique ID Parameters:
  • envelope-id (required) - DocuSign envelope ID
Example: 
/your-docusign-connection
action: get-envelope
envelope-id: 12345678-1234-1234-1234-123456789012
Response: 
{
  "envelopeId": "12345678-1234-1234-1234-123456789012",
  "status": "created",
  "emailSubject": "Please sign this document",
  "recipients": {
    "signers": [
      {
        "email": "john.doe@example.com",
        "name": "John Doe",
        "recipientId": "1",
        "status": "created"
      }
    ]
  },
  "documents": [
    {
      "documentId": "1",
      "name": "Contract.pdf"
    }
  ]
}

​
Update Envelope

Update the details of an existing envelope Parameters:
  • envelope-id (required) - DocuSign envelope ID to update
  • email-subject (optional) - Updated email subject
  • status (optional) - Updated envelope status
Example: 
/your-docusign-connection
action: update-envelope
envelope-id: 12345678-1234-1234-1234-123456789012
email-subject: Updated Subject: Please review and sign
status: created
Response: 
{
  "envelopeId": "12345678-1234-1234-1234-123456789012",
  "status": "created"
}

​
Send Envelope

Send an envelope that was previously created Parameters:
  • envelope-id (required) - DocuSign envelope ID to send
Example: 
/your-docusign-connection
action: send-envelope
envelope-id: 12345678-1234-1234-1234-123456789012
Response: 
{
  "envelopeId": "12345678-1234-1234-1234-123456789012",
  "status": "sent"
}

​
Search Envelopes

Search for envelopes based on query parameters Parameters:
  • status (optional) - Filter by envelope status (created, sent, delivered, completed)
  • search-text (optional) - Search text to filter envelopes
Example: 
/your-docusign-connection
action: search-envelopes
status: completed
Response: 
{
  "envelopes": [
    {
      "envelopeId": "12345678-1234-1234-1234-123456789012",
      "status": "completed",
      "emailSubject": "Contract Signed"
    },
    {
      "envelopeId": "98765432-4321-4321-4321-987654321098",
      "status": "completed",
      "emailSubject": "NDA Agreement Signed"
    }
  ]
}

​
Get Custom Fields

Retrieve custom fields for an envelope Parameters:
  • envelope-id (required) - DocuSign envelope ID
Example: 
/your-docusign-connection
action: get-custom-fields
envelope-id: 12345678-1234-1234-1234-123456789012
Response: 
{
  "textCustomFields": [
    {
      "name": "Project",
      "value": "Confidential Project",
      "required": false,
      "show": true
    }
  ],
  "listCustomFields": []
}

​
Notes

DocuSign requires a valid account ID before using the API. Envelope statuses include created, sent, delivered, completed, declined, and voided. Document files must be base64 encoded for upload. Anchor strings are used to position signature fields automatically. Recipients must have valid email addresses for notifications.