DocuSign
API actions for the DocuSign integration.
DocuSign
Send documents for signature, track envelope status, and manage templates in DocuSign.
Create draft envelope
Prepare a draft envelope with your documents and signers. The draft is not sent yet — use 'Send envelope' when it is ready.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email_subject | string | Yes | The subject line signers see in the email asking them to sign. |
documents | array | Yes | The documents to be signed. Each document needs its file contents as Base64 text, a name, a file extension, and an ID you choose (for example "1"). |
recipients | object | Yes | Who should receive the envelope. Put the people who must sign under 'signers', each with a name, email, and a unique recipient ID you choose (for example "1"). |
Response
{
"envelope_id": "abc123-def456-ghi789"
}Get envelope status
Check where an envelope is in the signing process (for example sent, delivered, or completed).
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
envelope_id | string | Yes | The ID of the envelope to check. |
Response
{
"status": "completed"
}List envelopes
List the documents you have sent for signature (DocuSign calls these envelopes), newest first. You can narrow the list by status or start date.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Only show envelopes with this status. Leave blank to include every status. |
from_date | string | No | Only show envelopes created on or after this date. Leave blank to show envelopes from the last 90 days. |
count | number | No | The maximum number of envelopes to return (up to 1000). |
Response
{
"envelopes": [
{
"emailSubject": "Please sign this document",
"envelopeId": "abc123-def456-ghi789",
"status": "sent"
}
]
}List templates
List the reusable envelope templates in your DocuSign account, optionally filtered by name.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
search_text | string | No | Only show templates whose name contains this text. Leave blank to list all templates. |
Response
{
"templates": [
{
"description": "Standard Non-Disclosure Agreement",
"name": "NDA Template",
"templateId": "tmpl-abc123"
}
]
}Send envelope
Send a draft envelope to its recipients for signature.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
envelope_id | string | Yes | The ID of the draft envelope to send. |
Response
{
"status": "sent"
}Void envelope
Cancel an envelope that has already been sent so it can no longer be signed. You must give a reason.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
envelope_id | string | Yes | The ID of the envelope to cancel. |
void_reason | string | Yes | Why the envelope is being cancelled (shown to recipients, up to 200 characters). |
Response
{
"status": "voided"
}