|
27 | 27 | </p> |
28 | 28 |
|
29 | 29 | <h4 id="example003">3. <a href="eg003">List envelope status changes</a></h4> |
30 | | -<p>The envelopes' current status is included |
| 30 | +<p>The envelopes' current status is included. |
31 | 31 | </p> |
32 | 32 | <p>API method used: |
33 | 33 | <a target='_blank' |
|
50 | 50 | </p> |
51 | 51 |
|
52 | 52 | <h4 id="example006">6. <a href="eg006">List envelope documents</a></h4> |
53 | | -<p>Includes current recipient status. |
| 53 | +<p>Lists the envelope's documents. A <i>Certificate of Completion</i> is also included with every envelope. |
54 | 54 | </p> |
55 | 55 | <p>API method used: |
56 | 56 | <a target='_blank' |
57 | 57 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/list/">EnvelopeDocuments::list</a>. |
58 | 58 | </p> |
59 | 59 |
|
60 | 60 | <h4 id="example007">7. <a href="eg007">Download envelope documents</a></h4> |
61 | | -<p>Downloads individual documents, the documents concatenated together, or a ZIP file of the documents |
| 61 | +<p>Downloads individual documents, the documents concatenated together, or a ZIP file of the documents. |
62 | 62 | </p> |
63 | 63 | <p>API method used: |
64 | 64 | <a target='_blank' |
65 | 65 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/">EnvelopeDocuments::get</a>. |
66 | 66 | </p> |
67 | 67 |
|
68 | 68 | <h4 id="example008">8. <a href="eg008">Create a template</a></h4> |
69 | | -<p>Create a template with two roles, <b>signer</b> and <b>cc</b>.</p> |
| 69 | +<p>Creates a template with two roles, <b>signer</b> and <b>cc</b> recipient.</p> |
70 | 70 | <p>API methods used: |
71 | 71 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/list/">Templates::list</a>, |
72 | 72 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/">Templates::create</a>. |
73 | 73 | </p> |
74 | 74 |
|
75 | 75 | <h4 id="example009">9. <a href="eg009">Request a signature by email using a template</a></h4> |
76 | | -<p>The envelope is defined by the template. |
77 | | - The signer and cc recipient name and email are used to fill in the template's <i>roles</i>.</p> |
| 76 | +<p>The envelope is defined by the template. The signer and cc recipient name and email are used to fill the template's <i>roles</i>.</p> |
78 | 77 | <p>API method used: |
79 | 78 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
80 | 79 | </p> |
81 | 80 |
|
82 | 81 | <h4 id="example010">10. <a href="eg010">Attach documents using binary transfer</a></h4> |
83 | | -<p>Binary transfer is 33% more efficient than using Base64 encoding |
| 82 | +<p>Binary transfer is 33% more efficient than using Base64 encoding. |
84 | 83 | </p> |
85 | 84 | <p>API method used: |
86 | 85 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
87 | 86 | </p> |
88 | 87 |
|
89 | | -<h4 id="example011">11. <a href="eg011">Send an envelope in your app (embedded sending)</a></h4> |
90 | | -<p>Embeds the DocuSign UI in your web app to finalize or update the envelope and documents before they are sent |
| 88 | +<h4 id="example011">11. <a href="eg011">Sends an envelope in your app (embedded sending)</a></h4> |
| 89 | +<p>Embeds the DocuSign UI in your web app to finalize or update the envelope and documents before they are sent. |
91 | 90 | </p> |
92 | 91 | <p>API methods used: |
93 | 92 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>, |
94 | 93 | <a target='_blank' |
95 | 94 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/">EnvelopeViews::createSender</a>. |
96 | 95 |
|
97 | 96 | <h4 id="example012">12. <a href="eg012">Embed the DocuSign UI in your app</a></h4> |
98 | | -<p>Redirect the user to the DocuSign web tool.</p> |
| 97 | +<p>Redirects the user to the DocuSign web tool.</p> |
99 | 98 | <p>API method used: |
100 | 99 | <a target='_blank' |
101 | 100 | href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/">EnvelopeViews::createConsole</a>. |
|
104 | 103 | <h4 id="example013">13. <a href="eg013">Request a signature using a composite template</a></h4> |
105 | 104 | <p>Sends an envelope based on a template.</p> |
106 | 105 | <p>In addition to the template's document(s), the example adds an |
107 | | - additional document to the envelope by using the |
108 | | - <a target='_blank' |
| 106 | + additional document to the envelope by using the <a target='_blank' |
109 | 107 | href='https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/templates/composite/'>Composite |
110 | | - Templates</a> |
111 | | - feature.</p> |
| 108 | + templates</a> feature.</p> |
112 | 109 | <p>API methods used: |
113 | 110 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>, |
114 | 111 | <a target='_blank' |
|
118 | 115 | <h2>Payments</h2> |
119 | 116 |
|
120 | 117 | <h4 id="example014">14. <a href="eg014">Send a request for Accept payments</a></h4> |
121 | | -<p>Sends an order form with online payment by credit card. |
122 | | - Anchor text |
123 | | - (<a target='_blank' |
124 | | - href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/">AutoPlace</a>) |
125 | | - is used to position the fields in the documents. |
| 118 | +<p>Sends an order form with online payment by credit card. |
126 | 119 | </p> |
127 | 120 | <p>API method used: |
128 | 121 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
|
180 | 173 | <p>Sends an envelope that requires the recipient to upload a government-issued ID for the purpose of multifactor authentication.</p> |
181 | 174 | <p>API methods used: |
182 | 175 | <a target='_blank' |
183 | | - href="https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list">Accounts::getAccountIdentityVerificationsList</a>. |
| 176 | + href="https://developers.docusign.com/esign-rest-api/reference/Accounts/IdentityVerifications/list">Accounts::getAccountIdentityVerificationsList</a>, |
184 | 177 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
185 | 178 | </p> |
186 | 179 |
|
187 | 180 | <h2>Permissions</h2> |
188 | 181 |
|
189 | 182 | <h4 id="example024">24. <a href="eg024">Create a permission profile</a></h4> |
190 | | -<p>This code example demonstrates how to create a permission profile with the eSignature REST API. </p> |
191 | | -<p>API methods used: |
| 183 | +<p>Demonstrates how to create a permission profile with the eSignature REST API. </p> |
| 184 | +<p>API method used: |
192 | 185 | <a target='_blank' |
193 | 186 | href="https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/create/">AccountPermissionProfiles::create</a>. |
194 | 187 | </p> |
195 | 188 |
|
196 | 189 | <h4 id="example025">25. <a href="eg025">Set a permission profile</a></h4> |
197 | 190 | <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> |
198 | | -<p>API methods used: |
| 191 | +<p>API method used: |
199 | 192 | <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/usergroups/groups/update/">Groups::update</a>. |
200 | 193 | </p> |
201 | 194 |
|
|
207 | 200 | </p> |
208 | 201 |
|
209 | 202 | <h4 id="example027">27. <a href="eg027">Delete a permission profile</a></h4> |
210 | | -<p>This code example demonstrates how to delete a permission profile with the eSignature REST API. </p> |
211 | | -<p>API methods used: |
| 203 | +<p>Demonstrates how to delete a permission profile with the eSignature REST API. </p> |
| 204 | +<p>API method used: |
212 | 205 | <a target='_blank' |
213 | 206 | href="https://developers.docusign.com/esign-rest-api/code-examples/permission-profile-deleting">AccountPermissionProfiles::delete</a>. |
214 | 207 | </p> |
215 | 208 |
|
216 | 209 | <h2>Brands</h2> |
217 | 210 |
|
218 | | -<h4 id="example028">28. <a href="eg028">Creating a brand</a></h4> |
219 | | -<p>This code example demonstrates how to create a brand with the eSignature REST API. </p> |
220 | | -<p>API methods used: |
| 211 | +<h4 id="example028">28. <a href="eg028">Create a brand</a></h4> |
| 212 | +<p>Creates a brand profile for an account.</p> |
| 213 | +<p>API method used: |
221 | 214 | <a target='_blank' |
222 | 215 | href="https://developers.docusign.com/docs/esign-rest-api/reference/accounts/accountbrands/create/">AccountBrands::create</a>. |
223 | 216 | </p> |
224 | 217 |
|
225 | | -<h4 id="example029">29. <a href="eg029">Applying a brand to an envelope</a></h4> |
226 | | -<p>Demonstrates how to apply a brand you've created to an envelope.</p> |
227 | | -<p>API methods used: |
228 | | - <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a> |
| 218 | +<h4 id="example029">29. <a href="eg029">Apply a brand to an envelope</a></h4> |
| 219 | +<p>Demonstrates how to apply a brand you've created to an envelope. First, this example creates the envelope, |
| 220 | +then applies the brand to it. <a target='_blank' |
| 221 | + href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/">Anchor text</a> is used |
| 222 | + to position the signing fields in the documents.</p> |
| 223 | +<p>API method used: |
| 224 | + <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
229 | 225 | </p> |
230 | 226 |
|
231 | 227 | <h4 id="example030">30. <a href="eg030">Apply a brand and template to an envelope</a></h4> |
232 | | -<p>Demonstrates how to apply a brand you've created to a template. You must have at least one created template and brand</p> |
233 | | -<p>API methods used: |
| 228 | +<p>Demonstrates how to apply a brand you've created to a template. You must have at least one created template and brand. <a target='_blank' |
| 229 | + href="https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/">Anchor text</a> is used |
| 230 | + to position the signing fields in the documents.<p> |
| 231 | +<p>API method used: |
234 | 232 | <a target='_blank' href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
235 | 233 | </p> |
236 | 234 |
|
237 | 235 | <h2>Bulk operations</h2> |
238 | 236 |
|
239 | | -<h4 id="example031">31. <a href="eg031">Bulk-send envelopes</a></h4> |
| 237 | +<h4 id="example031">31. <a href="eg031">Bulk send envelopes</a></h4> |
240 | 238 | <p> |
241 | 239 | Demonstrates how to send envelopes in bulk to multiple recipients. First, this example creates a bulk send recipients list, |
242 | 240 | then creates an envelope. After that, it initiates bulk envelope sending. |
|
247 | 245 | <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes:create</a>, |
248 | 246 | <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create/">EnvelopeCustomFields:create</a>, |
249 | 247 | <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/">BulkSend:createBulkSendRequest</a>, |
250 | | - <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchstatus/">BulkSend:getBulkSendBatchStatus</a> |
| 248 | + <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchstatus/">BulkSend:getBulkSendBatchStatus</a>. |
251 | 249 | </p> |
252 | 250 |
|
253 | 251 | <h2>Advanced recipient routing</h2> |
|
257 | 255 | Demonstrates how to create an envelope where the workflow is paused before the envelope is sent to a second recipient. |
258 | 256 | </p> |
259 | 257 | <p> |
260 | | - API methods used: |
261 | | - <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a> |
| 258 | + API method used: |
| 259 | + <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
262 | 260 | </p> |
263 | 261 |
|
264 | 262 | <h4 id="example033">33. <a href="eg033">Unpause a signature workflow</a></h4> |
265 | 263 | <p> |
266 | 264 | 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. |
267 | 265 | <p> |
268 | | - API methods used: |
269 | | - <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/">Envelopes::update</a> |
| 266 | + API method used: |
| 267 | + <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/">Envelopes::update</a>. |
270 | 268 | </p> |
271 | 269 |
|
272 | 270 | <h4 id="example034">34. <a href="eg034">Use conditional recipients</a></h4> |
273 | 271 | <p> |
274 | | - Demonstrates how to create an envelope where the workflow is routed to different recipients based on the value of a transaction |
| 272 | + Demonstrates how to create an envelope where the workflow is routed to different recipients based on the value of a transaction. |
275 | 273 | </p> |
276 | 274 | <p> |
277 | | - API methods used: |
278 | | - <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a> |
| 275 | + API method used: |
| 276 | + <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
279 | 277 | </p> |
280 | 278 |
|
281 | 279 | <h2>Premium features</h2> |
282 | 280 |
|
283 | 281 | <h4 id="example035">35. <a href="eg035">Request a signature by SMS delivery</a></h4> |
284 | 282 | <p> |
285 | | - Demonstrates how to send a signature request via an SMS message |
| 283 | + Demonstrates how to send a signature request via an SMS message. |
286 | 284 | </p> |
287 | 285 | <p> |
288 | | - API methods used: |
289 | | - <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a> |
| 286 | + API method used: |
| 287 | + <a target="_blank" href="https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/">Envelopes::create</a>. |
290 | 288 | </p> |
0 commit comments