Send documents for e-signature via DocuSign
Create and send envelopes for e-signature, use templates, check signing status, download signed documents, and manage recipients with DocuSign.
Create and send a DocuSign envelope with a document for e-signature
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
emailSubject | string | Ja | Email subject for the envelope |
emailBody | string | Nein | Email body message |
signerEmail | string | Ja | Email address of the signer |
signerName | string | Ja | Full name of the signer |
ccEmail | string | Nein | Email address of carbon copy recipient |
ccName | string | Nein | Full name of carbon copy recipient |
file | file | Nein | Document file to send for signature |
status | string | Nein | Envelope status: "sent" to send immediately, "created" for draft (default: "sent") |
| Parameter | Typ | Beschreibung |
|---|
envelopeId | string | Created envelope ID |
status | string | Envelope status |
statusDateTime | string | Status change datetime |
uri | string | Envelope URI |
Create and send a DocuSign envelope using a pre-built template
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
templateId | string | Ja | DocuSign template ID to use |
emailSubject | string | Nein | Override email subject (uses template default if not set) |
emailBody | string | Nein | Override email body message |
templateRoles | string | Ja | JSON array of template roles, e.g. [{"roleName":"Signer","name":"John","email":"john@example.com"}] |
status | string | Nein | Envelope status: "sent" to send immediately, "created" for draft (default: "sent") |
| Parameter | Typ | Beschreibung |
|---|
envelopeId | string | Created envelope ID |
status | string | Envelope status |
statusDateTime | string | Status change datetime |
uri | string | Envelope URI |
Get the details and status of a DocuSign envelope
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
envelopeId | string | Ja | The envelope ID to retrieve |
| Parameter | Typ | Beschreibung |
|---|
envelopeId | string | Envelope ID |
status | string | Envelope status (created, sent, delivered, completed, declined, voided) |
emailSubject | string | Email subject line |
sentDateTime | string | When the envelope was sent |
completedDateTime | string | When all recipients completed signing |
createdDateTime | string | When the envelope was created |
statusChangedDateTime | string | When the status last changed |
voidedReason | string | Reason the envelope was voided |
signerCount | number | Number of signers |
documentCount | number | Number of documents |
List envelopes from your DocuSign account with optional filters
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
fromDate | string | Nein | Start date filter (ISO 8601). Defaults to 30 days ago |
toDate | string | Nein | End date filter (ISO 8601) |
envelopeStatus | string | Nein | Filter by status: created, sent, delivered, completed, declined, voided |
searchText | string | Nein | Search text to filter envelopes |
count | string | Nein | Maximum number of envelopes to return (default: 25) |
| Parameter | Typ | Beschreibung |
|---|
envelopes | array | Array of DocuSign envelopes |
↳ envelopeId | string | Unique envelope identifier |
↳ status | string | Envelope status (created, sent, delivered, completed, declined, voided) |
↳ emailSubject | string | Email subject line |
↳ sentDateTime | string | ISO 8601 datetime when envelope was sent |
↳ completedDateTime | string | ISO 8601 datetime when envelope was completed |
↳ createdDateTime | string | ISO 8601 datetime when envelope was created |
↳ statusChangedDateTime | string | ISO 8601 datetime of last status change |
totalSetSize | number | Total number of matching envelopes |
resultSetSize | number | Number of envelopes returned in this response |
Void (cancel) a sent DocuSign envelope that has not yet been completed
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
envelopeId | string | Ja | The envelope ID to void |
voidedReason | string | Ja | Reason for voiding the envelope |
| Parameter | Typ | Beschreibung |
|---|
envelopeId | string | Voided envelope ID |
status | string | Envelope status (voided) |
Download a signed document from a completed DocuSign envelope
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
envelopeId | string | Ja | The envelope ID containing the document |
documentId | string | Nein | Specific document ID to download, or "combined" for all documents merged (default: "combined") |
| Parameter | Typ | Beschreibung |
|---|
base64Content | string | Base64-encoded document content |
mimeType | string | MIME type of the document |
fileName | string | Original file name |
List available templates in your DocuSign account
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
searchText | string | Nein | Search text to filter templates by name |
count | string | Nein | Maximum number of templates to return |
| Parameter | Typ | Beschreibung |
|---|
templates | array | Array of DocuSign templates |
↳ templateId | string | Template identifier |
↳ name | string | Template name |
↳ description | string | Template description |
↳ shared | boolean | Whether template is shared |
↳ created | string | ISO 8601 creation date |
↳ lastModified | string | ISO 8601 last modified date |
totalSetSize | number | Total number of matching templates |
resultSetSize | number | Number of templates returned in this response |
Get the recipient status details for a DocuSign envelope
| Parameter | Typ | Erforderlich | Beschreibung |
|---|
envelopeId | string | Ja | The envelope ID to get recipients for |
| Parameter | Typ | Beschreibung |
|---|
signers | array | Array of DocuSign recipients |
↳ recipientId | string | Recipient identifier |
↳ name | string | Recipient name |
↳ email | string | Recipient email address |
↳ status | string | Recipient signing status (sent, delivered, completed, declined) |
↳ signedDateTime | string | ISO 8601 datetime when recipient signed |
↳ deliveredDateTime | string | ISO 8601 datetime when delivered to recipient |
carbonCopies | array | Array of carbon copy recipients |
↳ recipientId | string | Recipient ID |
↳ name | string | Recipient name |
↳ email | string | Recipient email |
↳ status | string | Recipient status |