|
9 | 9 | <h2 class="mt-4">Basic examples</h2> |
10 | 10 | <% } %> |
11 | 11 |
|
12 | | -<h4 id="example001">1. <a href="eg001">Use embedded signing</a></h4> |
13 | | -<p>This example sends an envelope, then uses embedded signing for the first signer. |
14 | | - With embedded signing, DocuSign signing is initiated from your website. |
| 12 | +<h4 id="example001">1. <a href="eg001">Request a signature through your app (embedded signing)</a></h4> |
| 13 | +<p>Sends an envelope, then uses embedded signing for the first signer. With embedded signing, DocuSign signing is initiated from your website. |
15 | 14 | </p> |
16 | 15 | <p>API methods used: |
17 | 16 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a> |
|
20 | 19 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/">EnvelopeViews::createRecipient</a>. |
21 | 20 | </p> |
22 | 21 |
|
23 | | -<h4 id="example002">2. <a href="eg002">Send an envelope with a remote (email) signer and cc recipient</a></h4> |
| 22 | +<h4 id="example002">2. <a href="eg002">Request a signature by email (remote signing)</a></h4> |
24 | 23 | <p>The envelope includes a pdf, Word, and HTML document. Anchor text |
25 | 24 | (<a target='_blank' |
26 | 25 | href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/">AutoPlace</a>) |
|
30 | 29 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
31 | 30 | </p> |
32 | 31 |
|
33 | | -<h4 id="example003">3. <a href="eg003">List envelopes in the user's account</a></h4> |
34 | | -<p>List the envelopes created in the last 30 days. |
| 32 | +<h4 id="example003">3. <a href="eg003">List envelope status changes</a></h4> |
| 33 | +<p>The envelopes' current status is included |
35 | 34 | </p> |
36 | 35 | <p>API method used: |
37 | 36 | <a target='_blank' |
38 | 37 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/">Envelopes::listStatusChanges</a>. |
39 | 38 | </p> |
40 | 39 |
|
41 | | -<h4 id="example004">4. <a href="eg004">Get an envelope's basic information and status</a></h4> |
42 | | -<p>List the basic information about an envelope, including its overall status. |
43 | | - Additional API/SDK methods may be used to get additional information about the |
44 | | - envelope, its documents, recipients, etc. |
| 40 | +<h4 id="example004">4. <a href="eg004">Get envelope information</a></h4> |
| 41 | +<p>Lists basic information about an envelope, including its overall status. |
45 | 42 | </p> |
46 | 43 | <p>API method used: |
47 | 44 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/">Envelopes::get</a>. |
48 | 45 | </p> |
49 | 46 |
|
50 | | -<h4 id="example005">5. <a href="eg005">List an envelope's recipients and their status</a></h4> |
51 | | -<p>List the envelope's recipients, including their current status. |
| 47 | +<h4 id="example005">5. <a href="eg005">List envelope recipients</a></h4> |
| 48 | +<p>Includes current recipient status |
52 | 49 | </p> |
53 | 50 | <p>API method used: |
54 | 51 | <a target='_blank' |
55 | 52 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/">EnvelopeRecipients::list</a>. |
56 | 53 | </p> |
57 | 54 |
|
58 | | -<h4 id="example006">6. <a href="eg006">List an envelope's documents</a></h4> |
59 | | -<p>List the envelope's documents. A <i>Certificate of Completion</i> document |
60 | | - is also associated with every envelope. |
| 55 | +<h4 id="example006">6. <a href="eg006">List envelope documents</a></h4> |
| 56 | +<p>Includes current recipient status |
61 | 57 | </p> |
62 | 58 | <p>API method used: |
63 | 59 | <a target='_blank' |
64 | 60 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/list/">EnvelopeDocuments::list</a>. |
65 | 61 | </p> |
66 | 62 |
|
67 | | -<h4 id="example007">7. <a href="eg007">Download a document from an envelope</a></h4> |
68 | | -<p>An envelope's documents can be downloaded one by one or as a complete set. |
| 63 | +<h4 id="example007">7. <a href="eg007">Download envelope documents</a></h4> |
| 64 | +<p>Downloads individual documents, the documents concatenated together, or a ZIP file of the documents |
69 | 65 | </p> |
70 | 66 | <p>API method used: |
71 | 67 | <a target='_blank' |
|
79 | 75 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/">Templates::create</a>. |
80 | 76 | </p> |
81 | 77 |
|
82 | | -<h4 id="example009">9. <a href="eg009">Send an envelope using a template</a></h4> |
| 78 | +<h4 id="example009">9. <a href="eg009">Request a signature by email using a template</a></h4> |
83 | 79 | <p>The envelope is defined by the template. |
84 | 80 | The signer and cc recipient name and email are used to fill in the template's <i>roles</i>.</p> |
85 | 81 | <p>API method used: |
86 | 82 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
87 | 83 | </p> |
88 | 84 |
|
89 | | -<h4 id="example010">10. <a href="eg010">Send an envelope using binary document transfer</a></h4> |
90 | | -<p>The envelope includes a pdf, Word, and HTML document.</p> |
91 | | -<p>Multipart data transfer is used to send the documents in binary format to DocuSign. |
92 | | - Binary transfer is 33% more efficient than base64 encoding and is recommended for documents over 15M Bytes. |
93 | | - Binary transfer is not yet supported by the SDK. |
| 85 | +<h4 id="example010">10. <a href="eg010">Attach documents using binary transfer</a></h4> |
| 86 | +<p>Binary transfer is 33% more efficient than using Base64 encoding |
94 | 87 | </p> |
95 | 88 | <p>API method used: |
96 | 89 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
97 | 90 | </p> |
98 | 91 |
|
99 | | -<h4 id="example011">11. <a href="eg011">Use embedded sending</a></h4> |
100 | | -<p>An envelope will be created in draft mode. The DocuSign |
101 | | - web tool (NDSE) will then be shown, enabling further updates |
102 | | - to the envelope before it is sent. |
| 92 | +<h4 id="example011">11. <a href="eg011">Send an envelope in your app (embedded sending)</a></h4> |
| 93 | +<p>Embeds the DocuSign UI in your web app to finalize or update the envelope and documents before they are sent |
103 | 94 | </p> |
104 | 95 | <p>API methods used: |
105 | 96 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>, |
106 | 97 | <a target='_blank' |
107 | 98 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/">EnvelopeViews::createSender</a>. |
108 | 99 |
|
109 | | -<h4 id="example012">12. <a href="eg012">Embedded DocuSign web tool</a></h4> |
| 100 | +<h4 id="example012">12. <a href="eg012">Embed the DocuSign UI in your app</a></h4> |
110 | 101 | <p>Redirect the user to the DocuSign web tool.</p> |
111 | 102 | <p>API method used: |
112 | 103 | <a target='_blank' |
113 | 104 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/">EnvelopeViews::createConsole</a>. |
114 | 105 | </p> |
115 | 106 |
|
116 | | -<h4 id="example013">13. <a href="eg013">Use embedded signing from a template with an added document</a></h4> |
117 | | -<p>This example sends an envelope based on a template.</p> |
| 107 | +<h4 id="example013">13. <a href="eg013">Request a signature using a composite template</a></h4> |
| 108 | +<p>Sends an envelope based on a template.</p> |
118 | 109 | <p>In addition to the template's document(s), the example adds an |
119 | 110 | additional document to the envelope by using the |
120 | 111 | <a target='_blank' |
|
130 | 121 |
|
131 | 122 | <h2>Payments</h2> |
132 | 123 |
|
133 | | -<h4 id="example014">14. <a href="eg014">Send an envelope with an order form and payment field</a></h4> |
134 | | -<p>Anchor text |
| 124 | +<h4 id="example014">14. <a href="eg014">Send a request for Accept payments</a></h4> |
| 125 | +<p>Sends an order form with online payment by credit card. |
| 126 | + Anchor text |
135 | 127 | (<a target='_blank' |
136 | 128 | href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/">AutoPlace</a>) |
137 | 129 | is used to position the fields in the documents. |
|
142 | 134 |
|
143 | 135 | <h2>Tabs</h2> |
144 | 136 |
|
145 | | -<h4 id="example015">15. <a href="eg015">Get the tab data from an envelope</a></h4> |
146 | | -<p>This example retrieves the tab (field) values from an envelope.</p> |
| 137 | +<h4 id="example015">15. <a href="eg015">Get envelope tab values</a></h4> |
| 138 | +<p>Retrieves the tab (field) values for all of the envelope's recipients.</p> |
147 | 139 | <p>API method used: |
148 | 140 | <a target='_blank' |
149 | 141 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeformdata/get/">EnvelopeFormData::get</a>. |
150 | 142 | </p> |
151 | 143 |
|
152 | | -<h4 id="example016">16. <a href="eg016">Set tab values for a envelope</a></h4> |
153 | | -<p>This example sets the tab (field) values for an envelope including tabs that can and cannot be changed by the |
154 | | - signer.</p> |
| 144 | +<h4 id="example016">16. <a href="eg016">Set envelope tab values</a></h4> |
| 145 | +<p>Creates an envelope and sets the initial values for its tabs (fields). Some of the tabs are set to be read-only, others can be updated by the recipient. This example also stores metadata with the envelope.</p> |
155 | 146 | <p>API method used: |
156 | 147 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
157 | 148 | </p> |
158 | 149 |
|
159 | | -<h4 id="example017">17. <a href="eg017">Set template tab values</a></h4> |
160 | | -<p>This example sets the tab (field) values for a template being used by an envelope.</p> |
| 150 | +<h4 id="example017">17. <a href="eg017">Set tab values in a template</a></h4> |
| 151 | +<p>Creates an envelope using a template and sets the initial values for its tabs (fields). This example also stores metadata with the envelope.</p> |
161 | 152 | <p>API method used: |
162 | 153 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
163 | 154 | </p> |
164 | 155 |
|
165 | | -<h4 id="example018">18. <a href="eg018">List envelope custom metadata field values</a></h4> |
166 | | -<p>This example lists the envelope's custom metadata field values.</p> |
| 156 | +<h4 id="example018">18. <a href="eg018">Get envelope custom tab values</a></h4> |
| 157 | +<p>Retrieves the custom metadata (custom data fields) stored with the envelope.</p> |
167 | 158 | <p>API method used: |
168 | 159 | <a target='_blank' |
169 | 160 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/list/">EnvelopeCustomFields::list</a>. |
|
199 | 190 |
|
200 | 191 | <h2>Permissions</h2> |
201 | 192 |
|
202 | | -<h4 id="example024">24. <a href="eg024">Creating a permission profile</a></h4> |
| 193 | +<h4 id="example024">24. <a href="eg024">Create a permission profile</a></h4> |
203 | 194 | <p>This code example demonstrates how to create a permission profile with the eSignature REST API. </p> |
204 | 195 | <p>API methods used: |
205 | 196 | <a target='_blank' |
206 | 197 | href="https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/create/">AccountPermissionProfiles::create</a>. |
207 | 198 | </p> |
208 | 199 |
|
209 | | -<h4 id="example025">25. <a href="eg025">Setting a permission profile</a></h4> |
210 | | -<p>This code example demonstrates how to set a permission profile with the eSignature REST API. </p> |
| 200 | +<h4 id="example025">25. <a href="eg025">Set a permission profile</a></h4> |
| 201 | +<p>Demonstrates how to set a user group's permission profile. You must have already created a permission profile and a group of users.</p> |
211 | 202 | <p>API methods used: |
212 | 203 | <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groups/update/">Groups::update</a>. |
213 | 204 | </p> |
214 | 205 |
|
215 | | -<h4 id="example026">26. <a href="eg026">Updates the permission profile.</a></h4> |
216 | | -<p>This code example demonstrates how to update a permission profile with the eSignature REST API. </p> |
| 206 | +<h4 id="example026">26. <a href="eg026">Update individual permission settings</a></h4> |
| 207 | +<p>Demonstrates how to edit individual permission settings on a permission profile.</p> |
217 | 208 | <p>API method used: |
218 | 209 | <a target='_blank' |
219 | 210 | href="https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/update/">AccountPermissionProfiles::update</a>. |
220 | 211 | </p> |
221 | 212 |
|
222 | | -<h4 id="example027">27. <a href="eg027">Deleting a permission</a></h4> |
| 213 | +<h4 id="example027">27. <a href="eg027">Delete a permission profile</a></h4> |
223 | 214 | <p>This code example demonstrates how to delete a permission profile with the eSignature REST API. </p> |
224 | 215 | <p>API methods used: |
225 | 216 | <a target='_blank' |
|
236 | 227 | </p> |
237 | 228 |
|
238 | 229 | <h4 id="example029">29. <a href="eg029">Applying a brand to an envelope</a></h4> |
239 | | -<p>This code example demonstrates how to apply a brand to an envelope with the eSignature REST API.</p> |
| 230 | +<p>Demonstrates how to apply a brand you've created to an envelope.</p> |
240 | 231 | <p>API methods used: |
241 | 232 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a> |
242 | 233 | </p> |
243 | 234 |
|
244 | | -<h4 id="example030">30. <a href="eg030">Applying a brand to a template</a></h4> |
245 | | -<p>This code example demonstrates how to apply a brand to a template with the eSignature REST API. </p> |
| 235 | +<h4 id="example030">30. <a href="eg030">Apply a brand and template to an envelope</a></h4> |
| 236 | +<p>Demonstrates how to apply a brand you've created to a template. You must have at least one created template and brand</p> |
246 | 237 | <p>API methods used: |
247 | 238 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
248 | 239 | </p> |
249 | 240 |
|
250 | 241 | <h2>Bulk operations</h2> |
251 | 242 |
|
252 | | -<h4 id="example031">31. <a href="eg031">Bulk send envelopes</a></h4> |
| 243 | +<h4 id="example031">31. <a href="eg031">Bulk-send envelopes</a></h4> |
253 | 244 | <p> |
254 | 245 | Demonstrates how to send envelopes in bulk to multiple recipients. First, this example creates a bulk send recipients list, |
255 | 246 | then creates an envelope. After that, it initiates bulk envelope sending. |
|
265 | 256 |
|
266 | 257 | <h2>Advanced recipient routing</h2> |
267 | 258 |
|
268 | | -<h4 id="example032">32. <a href="eg032">Pausing a signature workflow</a></h4> |
| 259 | +<h4 id="example032">32. <a href="eg032">Pause a signature workflow</a></h4> |
269 | 260 | <p> |
270 | | - This example creates and envelope and then pauses the signature workflow |
| 261 | + Demonstrates how to create an envelope where the workflow is paused before the envelope is sent to a second recipient. |
271 | 262 | </p> |
272 | 263 | <p> |
273 | 264 | API methods used: |
274 | 265 | <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a> |
275 | 266 | </p> |
276 | 267 |
|
277 | | -<h4 id="example033">33. <a href="eg033">Resuming a signature workflow</a></h4> |
| 268 | +<h4 id="example033">33. <a href="eg033">Unpause a signature workflow</a></h4> |
278 | 269 | <p> |
279 | | - This example resumes a signature workflow for the previously created envelope that was paused. |
280 | | -</p> |
| 270 | + Demonstrates how to update an envelope to resume the workflow that has been paused using the Update Envelope method. You must have created at least one envelope with a paused signature workflow to run this example. |
281 | 271 | <p> |
282 | 272 | API methods used: |
283 | 273 | <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/">Envelopes::update</a> |
284 | 274 | </p> |
285 | 275 |
|
286 | | -<h4 id="example034">34. <a href="eg034">Using conditional recipients</a></h4> |
| 276 | +<h4 id="example034">34. <a href="eg034">Use conditional recipients</a></h4> |
287 | 277 | <p> |
288 | | - This example creates an envelope that is routed to different recipients based on a predefined condition. |
| 278 | + Demonstrates how to create an envelope where the workflow is routed to different recipients based on the value of a transaction |
289 | 279 | </p> |
290 | 280 | <p> |
291 | 281 | API methods used: |
|
294 | 284 |
|
295 | 285 | <h2>Premium features</h2> |
296 | 286 |
|
297 | | -<h4 id="example035">35. <a href="eg035">Sending via SMS delivery</a></h4> |
| 287 | +<h4 id="example035">35. <a href="eg035">Request a signature by SMS delivery</a></h4> |
298 | 288 | <p> |
299 | | - This example demonstrates how to send a signature request for a signer (and CC) to read and sign via an SMS message. |
| 289 | + Demonstrates how to send a signature request via an SMS message |
300 | 290 | </p> |
301 | 291 | <p> |
302 | 292 | API methods used: |
|
0 commit comments