Lodol Docs

DocuSign

API actions for the DocuSign integration.

DocuSign

Manage DocuSign envelopes, status, and templates with an API token.


Create draft envelope

Create a new draft envelope with documents and recipients.

Parameters

ParameterTypeRequiredDescription
account_idstringYesDocuSign account ID
email_subjectstringYesSubject line of the envelope email
documentsarrayYesList of document objects to include in the envelope
recipientsobjectYesRecipients object containing signers, carbon copies, etc.

Response

{
  "envelope_id": "abc123-def456-ghi789"
}

Get envelope status

Retrieve the current status of an envelope.

Parameters

ParameterTypeRequiredDescription
account_idstringYesDocuSign account ID
envelope_idstringYesID of the envelope

Response

{
  "status": "completed"
}

List envelopes

Retrieve a list of envelopes from the DocuSign account with optional filters.

Parameters

ParameterTypeRequiredDescription
account_idstringYesDocuSign account ID
statusstringNoFilter envelopes by status (e.g., 'sent', 'completed', 'voided')
from_datestringNoFilter envelopes created on or after this date (ISO 8601 format)
countnumberNoMaximum number of envelopes to return

Response

[
  {
    "emailSubject": "Please sign this document",
    "envelopeId": "abc123-def456-ghi789",
    "status": "sent"
  }
]

List templates

Retrieve a list of templates from the DocuSign account.

Parameters

ParameterTypeRequiredDescription
account_idstringYesDocuSign account ID
search_textstringNoFilter templates by name

Response

[
  {
    "description": "Standard Non-Disclosure Agreement",
    "name": "NDA Template",
    "templateId": "tmpl-abc123"
  }
]

Send envelope

Send a draft envelope to its recipients.

Parameters

ParameterTypeRequiredDescription
account_idstringYesDocuSign account ID
envelope_idstringYesID of the envelope to send

Response

{
  "status": "sent"
}

Void envelope

Void an envelope with a specified reason.

Parameters

ParameterTypeRequiredDescription
account_idstringYesDocuSign account ID
envelope_idstringYesID of the envelope to void
void_reasonstringYesReason for voiding the envelope

Response

{
  "status": "voided"
}

On this page