@@ -5,9 +5,9 @@ description: Send documents for e-signature via DocuSign
55
66import { BlockInfoCard } from " @/components/ui/block-info-card"
77
8- <BlockInfoCard
8+ <BlockInfoCard
99 type = " docusign"
10- color = " #4C00FF "
10+ color = " #FFFFFF "
1111/>
1212
1313{ /* MANUAL-CONTENT-START:intro */ }
@@ -26,6 +26,7 @@ With the DocuSign integration in Sim, you can:
2626In Sim, the DocuSign integration enables your agents to automate document workflows end-to-end. Agents can generate agreements, send them for signature, monitor completion, and retrieve signed copies—powering contract management, HR onboarding, sales closings, and compliance processes.
2727{ /* MANUAL-CONTENT-END */ }
2828
29+
2930## Usage Instructions
3031
3132Create and send envelopes for e-signature, use templates, check signing status, download signed documents, and manage recipients with DocuSign.
@@ -36,194 +37,194 @@ Create and send envelopes for e-signature, use templates, check signing status,
3637
3738### ` docusign_send_envelope `
3839
40+ Create and send a DocuSign envelope with a document for e-signature
41+
3942#### Input
4043
4144| Parameter | Type | Required | Description |
4245| --------- | ---- | -------- | ----------- |
46+ | ` emailSubject ` | string | Yes | Email subject for the envelope |
47+ | ` emailBody ` | string | No | Email body message |
48+ | ` signerEmail ` | string | Yes | Email address of the signer |
49+ | ` signerName ` | string | Yes | Full name of the signer |
50+ | ` ccEmail ` | string | No | Email address of carbon copy recipient |
51+ | ` ccName ` | string | No | Full name of carbon copy recipient |
52+ | ` file ` | file | No | Document file to send for signature |
53+ | ` status ` | string | No | Envelope status: "sent" to send immediately, "created" for draft \( default: "sent"\) |
4354
4455#### Output
4556
4657| Parameter | Type | Description |
4758| --------- | ---- | ----------- |
48- | ` envelopeId ` | string | Envelope ID |
49- | ` status ` | string | Envelope or operation status |
50- | ` envelopes ` | json | Array of envelopes |
51- | ` templates ` | json | Array of templates |
52- | ` signers ` | json | Array of signer recipients |
53- | ` carbonCopies ` | json | Array of CC recipients |
54- | ` base64Content ` | string | Base64-encoded document content |
55- | ` mimeType ` | string | Document MIME type |
56- | ` fileName ` | string | Document file name |
57- | ` emailSubject ` | string | Envelope email subject |
58- | ` totalSetSize ` | number | Total matching results |
59- | ` resultSetSize ` | number | Results returned |
59+ | ` envelopeId ` | string | Created envelope ID |
60+ | ` status ` | string | Envelope status |
61+ | ` statusDateTime ` | string | Status change datetime |
62+ | ` uri ` | string | Envelope URI |
6063
6164### ` docusign_create_from_template `
6265
66+ Create and send a DocuSign envelope using a pre-built template
67+
6368#### Input
6469
6570| Parameter | Type | Required | Description |
6671| --------- | ---- | -------- | ----------- |
72+ | ` templateId ` | string | Yes | DocuSign template ID to use |
73+ | ` emailSubject ` | string | No | Override email subject \( uses template default if not set\) |
74+ | ` emailBody ` | string | No | Override email body message |
75+ | ` templateRoles ` | string | Yes | JSON array of template roles, e.g. \[\{ "roleName":"Signer","name":"John","email":"john@example.com "\}\] |
76+ | ` status ` | string | No | Envelope status: "sent" to send immediately, "created" for draft \( default: "sent"\) |
6777
6878#### Output
6979
7080| Parameter | Type | Description |
7181| --------- | ---- | ----------- |
72- | ` envelopeId ` | string | Envelope ID |
73- | ` status ` | string | Envelope or operation status |
74- | ` envelopes ` | json | Array of envelopes |
75- | ` templates ` | json | Array of templates |
76- | ` signers ` | json | Array of signer recipients |
77- | ` carbonCopies ` | json | Array of CC recipients |
78- | ` base64Content ` | string | Base64-encoded document content |
79- | ` mimeType ` | string | Document MIME type |
80- | ` fileName ` | string | Document file name |
81- | ` emailSubject ` | string | Envelope email subject |
82- | ` totalSetSize ` | number | Total matching results |
83- | ` resultSetSize ` | number | Results returned |
82+ | ` envelopeId ` | string | Created envelope ID |
83+ | ` status ` | string | Envelope status |
84+ | ` statusDateTime ` | string | Status change datetime |
85+ | ` uri ` | string | Envelope URI |
8486
8587### ` docusign_get_envelope `
8688
89+ Get the details and status of a DocuSign envelope
90+
8791#### Input
8892
8993| Parameter | Type | Required | Description |
9094| --------- | ---- | -------- | ----------- |
95+ | ` envelopeId ` | string | Yes | The envelope ID to retrieve |
9196
9297#### Output
9398
9499| Parameter | Type | Description |
95100| --------- | ---- | ----------- |
96101| ` envelopeId ` | string | Envelope ID |
97- | ` status ` | string | Envelope or operation status |
98- | ` envelopes ` | json | Array of envelopes |
99- | ` templates ` | json | Array of templates |
100- | ` signers ` | json | Array of signer recipients |
101- | ` carbonCopies ` | json | Array of CC recipients |
102- | ` base64Content ` | string | Base64-encoded document content |
103- | ` mimeType ` | string | Document MIME type |
104- | ` fileName ` | string | Document file name |
105- | ` emailSubject ` | string | Envelope email subject |
106- | ` totalSetSize ` | number | Total matching results |
107- | ` resultSetSize ` | number | Results returned |
102+ | ` status ` | string | Envelope status \( created, sent, delivered, completed, declined, voided\) |
103+ | ` emailSubject ` | string | Email subject line |
104+ | ` sentDateTime ` | string | When the envelope was sent |
105+ | ` completedDateTime ` | string | When all recipients completed signing |
106+ | ` createdDateTime ` | string | When the envelope was created |
107+ | ` statusChangedDateTime ` | string | When the status last changed |
108+ | ` voidedReason ` | string | Reason the envelope was voided |
109+ | ` signerCount ` | number | Number of signers |
110+ | ` documentCount ` | number | Number of documents |
108111
109112### ` docusign_list_envelopes `
110113
114+ List envelopes from your DocuSign account with optional filters
115+
111116#### Input
112117
113118| Parameter | Type | Required | Description |
114119| --------- | ---- | -------- | ----------- |
120+ | ` fromDate ` | string | No | Start date filter \( ISO 8601\) . Defaults to 30 days ago |
121+ | ` toDate ` | string | No | End date filter \( ISO 8601\) |
122+ | ` envelopeStatus ` | string | No | Filter by status: created, sent, delivered, completed, declined, voided |
123+ | ` searchText ` | string | No | Search text to filter envelopes |
124+ | ` count ` | string | No | Maximum number of envelopes to return \( default: 25\) |
115125
116126#### Output
117127
118128| Parameter | Type | Description |
119129| --------- | ---- | ----------- |
120- | ` envelopeId ` | string | Envelope ID |
121- | ` status ` | string | Envelope or operation status |
122- | ` envelopes ` | json | Array of envelopes |
123- | ` templates ` | json | Array of templates |
124- | ` signers ` | json | Array of signer recipients |
125- | ` carbonCopies ` | json | Array of CC recipients |
126- | ` base64Content ` | string | Base64-encoded document content |
127- | ` mimeType ` | string | Document MIME type |
128- | ` fileName ` | string | Document file name |
129- | ` emailSubject ` | string | Envelope email subject |
130- | ` totalSetSize ` | number | Total matching results |
131- | ` resultSetSize ` | number | Results returned |
130+ | ` envelopes ` | array | Array of DocuSign envelopes |
131+ | ↳ ` envelopeId ` | string | Unique envelope identifier |
132+ | ↳ ` status ` | string | Envelope status \( created, sent, delivered, completed, declined, voided\) |
133+ | ↳ ` emailSubject ` | string | Email subject line |
134+ | ↳ ` sentDateTime ` | string | ISO 8601 datetime when envelope was sent |
135+ | ↳ ` completedDateTime ` | string | ISO 8601 datetime when envelope was completed |
136+ | ↳ ` createdDateTime ` | string | ISO 8601 datetime when envelope was created |
137+ | ↳ ` statusChangedDateTime ` | string | ISO 8601 datetime of last status change |
138+ | ` totalSetSize ` | number | Total number of matching envelopes |
139+ | ` resultSetSize ` | number | Number of envelopes returned in this response |
132140
133141### ` docusign_void_envelope `
134142
143+ Void (cancel) a sent DocuSign envelope that has not yet been completed
144+
135145#### Input
136146
137147| Parameter | Type | Required | Description |
138148| --------- | ---- | -------- | ----------- |
149+ | ` envelopeId ` | string | Yes | The envelope ID to void |
150+ | ` voidedReason ` | string | Yes | Reason for voiding the envelope |
139151
140152#### Output
141153
142154| Parameter | Type | Description |
143155| --------- | ---- | ----------- |
144- | ` envelopeId ` | string | Envelope ID |
145- | ` status ` | string | Envelope or operation status |
146- | ` envelopes ` | json | Array of envelopes |
147- | ` templates ` | json | Array of templates |
148- | ` signers ` | json | Array of signer recipients |
149- | ` carbonCopies ` | json | Array of CC recipients |
150- | ` base64Content ` | string | Base64-encoded document content |
151- | ` mimeType ` | string | Document MIME type |
152- | ` fileName ` | string | Document file name |
153- | ` emailSubject ` | string | Envelope email subject |
154- | ` totalSetSize ` | number | Total matching results |
155- | ` resultSetSize ` | number | Results returned |
156+ | ` envelopeId ` | string | Voided envelope ID |
157+ | ` status ` | string | Envelope status \( voided\) |
156158
157159### ` docusign_download_document `
158160
161+ Download a signed document from a completed DocuSign envelope
162+
159163#### Input
160164
161165| Parameter | Type | Required | Description |
162166| --------- | ---- | -------- | ----------- |
167+ | ` envelopeId ` | string | Yes | The envelope ID containing the document |
168+ | ` documentId ` | string | No | Specific document ID to download, or "combined" for all documents merged \( default: "combined"\) |
163169
164170#### Output
165171
166172| Parameter | Type | Description |
167173| --------- | ---- | ----------- |
168- | ` envelopeId ` | string | Envelope ID |
169- | ` status ` | string | Envelope or operation status |
170- | ` envelopes ` | json | Array of envelopes |
171- | ` templates ` | json | Array of templates |
172- | ` signers ` | json | Array of signer recipients |
173- | ` carbonCopies ` | json | Array of CC recipients |
174174| ` base64Content ` | string | Base64-encoded document content |
175- | ` mimeType ` | string | Document MIME type |
176- | ` fileName ` | string | Document file name |
177- | ` emailSubject ` | string | Envelope email subject |
178- | ` totalSetSize ` | number | Total matching results |
179- | ` resultSetSize ` | number | Results returned |
175+ | ` mimeType ` | string | MIME type of the document |
176+ | ` fileName ` | string | Original file name |
180177
181178### ` docusign_list_templates `
182179
180+ List available templates in your DocuSign account
181+
183182#### Input
184183
185184| Parameter | Type | Required | Description |
186185| --------- | ---- | -------- | ----------- |
186+ | ` searchText ` | string | No | Search text to filter templates by name |
187+ | ` count ` | string | No | Maximum number of templates to return |
187188
188189#### Output
189190
190191| Parameter | Type | Description |
191192| --------- | ---- | ----------- |
192- | ` envelopeId ` | string | Envelope ID |
193- | ` status ` | string | Envelope or operation status |
194- | ` envelopes ` | json | Array of envelopes |
195- | ` templates ` | json | Array of templates |
196- | ` signers ` | json | Array of signer recipients |
197- | ` carbonCopies ` | json | Array of CC recipients |
198- | ` base64Content ` | string | Base64-encoded document content |
199- | ` mimeType ` | string | Document MIME type |
200- | ` fileName ` | string | Document file name |
201- | ` emailSubject ` | string | Envelope email subject |
202- | ` totalSetSize ` | number | Total matching results |
203- | ` resultSetSize ` | number | Results returned |
193+ | ` templates ` | array | Array of DocuSign templates |
194+ | ↳ ` templateId ` | string | Template identifier |
195+ | ↳ ` name ` | string | Template name |
196+ | ↳ ` description ` | string | Template description |
197+ | ↳ ` shared ` | boolean | Whether template is shared |
198+ | ↳ ` created ` | string | ISO 8601 creation date |
199+ | ↳ ` lastModified ` | string | ISO 8601 last modified date |
200+ | ` totalSetSize ` | number | Total number of matching templates |
201+ | ` resultSetSize ` | number | Number of templates returned in this response |
204202
205203### ` docusign_list_recipients `
206204
205+ Get the recipient status details for a DocuSign envelope
206+
207207#### Input
208208
209209| Parameter | Type | Required | Description |
210210| --------- | ---- | -------- | ----------- |
211+ | ` envelopeId ` | string | Yes | The envelope ID to get recipients for |
211212
212213#### Output
213214
214215| Parameter | Type | Description |
215216| --------- | ---- | ----------- |
216- | ` envelopeId ` | string | Envelope ID |
217- | ` status ` | string | Envelope or operation status |
218- | ` envelopes ` | json | Array of envelopes |
219- | ` templates ` | json | Array of templates |
220- | ` signers ` | json | Array of signer recipients |
221- | ` carbonCopies ` | json | Array of CC recipients |
222- | ` base64Content ` | string | Base64-encoded document content |
223- | ` mimeType ` | string | Document MIME type |
224- | ` fileName ` | string | Document file name |
225- | ` emailSubject ` | string | Envelope email subject |
226- | ` totalSetSize ` | number | Total matching results |
227- | ` resultSetSize ` | number | Results returned |
217+ | ` signers ` | array | Array of DocuSign recipients |
218+ | ↳ ` recipientId ` | string | Recipient identifier |
219+ | ↳ ` name ` | string | Recipient name |
220+ | ↳ ` email ` | string | Recipient email address |
221+ | ↳ ` status ` | string | Recipient signing status \( sent, delivered, completed, declined \) |
222+ | ↳ ` signedDateTime ` | string | ISO 8601 datetime when recipient signed |
223+ | ↳ ` deliveredDateTime ` | string | ISO 8601 datetime when delivered to recipient |
224+ | ` carbonCopies ` | array | Array of carbon copy recipients |
225+ | ↳ ` recipientId ` | string | Recipient ID |
226+ | ↳ ` name ` | string | Recipient name |
227+ | ↳ ` email ` | string | Recipient email |
228+ | ↳ ` status ` | string | Recipient status |
228229
229230
0 commit comments