-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCodeExamplesManifest.json
More file actions
2627 lines (2627 loc) · 133 KB
/
CodeExamplesManifest.json
File metadata and controls
2627 lines (2627 loc) · 133 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"SupportingTexts": {
"HomePageText": "Run and explore DocuSign code examples with Authorization Code Grant or JWT Grant authentication",
"ViewSourceFile": "View source file {0} on GitHub.",
"APIMethodUsed": "API method used:",
"APIMethodUsedPlural": "API methods used:",
"SearchFailed": "<p>The examples with this text could not be found. Please, modify the search field.</p>",
"SubmitButton": "Submit",
"ContinueButton": "Continue",
"HomeButton": "Home",
"LoginButton": "Login",
"LogoutButton": "Logout",
"ChangeAPITypeButton": "Change API Type",
"WelcomeText": "Welcome {0} (Account: {1})",
"CFRError": "This example is not compatible with your CFR Part 11 account. Please return to the homepage to run one of the examples that is compatible or authenticate with a different account.",
"LoginPage": {
"LoginHeader": "<h1 class='display-4'>Please Authenticate with DocuSign</h1><label for='auth_type'>Please choose your authentication type</label>",
"LoginButton": "Authenticate with DocuSign",
"LoginHelperText": "You need to authenticate with DocuSign to continue your request."
},
"SelectAPIPage": {
"SelectAPIHeader": "<h1 class='display-4'>Please choose an API type</h1><label for='api_type'>Please choose an API type</label>",
"SelectAPIButton": "Choose your desired API"
},
"HelpingTexts": {
"EmailWontBeShared": "We'll never share your email with anyone else.",
"PhoneNumberWontBeShared": "We'll never share your phone number with anyone else.",
"CCEmailShouldDifferFromSigner": "The email for the cc recipient must be different from the signer's email.",
"AccessCodeText": "Provide this string to a recipient that is different such as in person or by mail or via a different email.",
"CountryCodeText": "The country code for the phone number below.",
"ChooseDateInTheFuture": "Please choose a future date.",
"PhoneNumberWillBeNotified": "This phone number will receive a notification.",
"DynamicContentValue": "Provide values for the dynamic content fields shown on the elastic template agreement.",
"DynamicContentNote": "Note: The elastic template must be manually modified through the elastic templates UI to include these dynamic content fields.",
"EmbedClickwrapURL": "Agreement URL returned in the JSON response:",
"NOTAGREED": "NOT AGREED",
"AGREED": "AGREED",
"SaveAgentActivationCode": "Save this code. You'll need it when activating the new agent.",
"EmailAddressOfUserToDelete": "The email address of the user whose data will be deleted. Note that this email address should be associated with a user that has been closed for 24 hours.",
"UserIDOfUserToDelete": "The user ID of the user whose data will be deleted. Note that this ID should be associated with a user that has been closed for 24 hours."
}
},
"APIs": [
{
"Name": "eSignature",
"Groups": [
{
"Name": "Sending a signature request (remote signing)",
"Examples": [
{
"ExampleNumber": 2,
"CFREnabled": "AllAccounts",
"ExampleName": "Send an envelope with a remote (email) signer and cc recipient",
"ExampleDescription": "The envelope includes a pdf, Word, and HTML document. Anchor text(<a target='_blank' href=\"https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/\">AutoPlace</a>) is used to position the signing fields in the documents.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "CC Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "CC Name",
"InputPlaceholder": "Pat Johnson"
}
]
}
],
"ResultsPageText": "The envelope has been created and sent!<br />Envelope ID {0}."
},
{
"ExampleNumber": 9,
"CFREnabled": "AllAccounts",
"ExampleName": "Send an envelope using a template",
"ExampleDescription": "The envelope is defined by the template. The signer and cc recipient name and email are used to fill in the template's <i>roles</i>.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
}
],
"RedirectsToOtherCodeExamples": [
{
"CodeExampleToRedirectTo": 8,
"RedirectText": "<p>Prerequisite: Please first create the template using <a {0}>Create a template</a>.</p>"
}
],
"Forms": [
{
"FormName": "<p>The template you created via Create a template will be used.<br/>The document list is from your results for List an envelope's documents.</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "CC Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "CC Name",
"InputPlaceholder": "Pat Johnson"
}
]
}
],
"ResultsPageText": "The envelope has been created and sent!<br/>Envelope ID {0}."
},
{
"ExampleNumber": 42,
"CFREnabled": "NonCFR",
"ExampleName": "Request a signature by email with document generation",
"ExampleDescription": "Creates an envelope from a template with a document that is dynamically generated to include all the customized data specified by the sender.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/",
"PathName": "Templates:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatedocuments/update/",
"PathName": "TemplateDocuments:update"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templaterecipienttabs/create/",
"PathName": "TemplateRecipientTabs:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/getenvelopedocgenformfields/",
"PathName": "DocumentGeneration:getEnvelopeDocGenFormFields"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/documentgeneration/updateenvelopedocgenformfields/",
"PathName": "DocumentGeneration:updateEnvelopeDocGenFormFields"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/",
"PathName": "Envelopes:update"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Candidate Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Candidate Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Manager Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Job Title"
},
{
"InputName": "Salary"
},
{
"InputName": "Start Date",
"InputPlaceholder": "mm/dd/yyyy"
}
]
}
],
"ResultsPageText": "The envelope has been created and sent!<br />Envelope ID {0}."
},
{
"ExampleNumber": 37,
"CFREnabled": "NonCFR",
"ExampleName": "Request a signature by SMS or WhatsApp delivery",
"ExampleDescription": "Sends a signature request via an SMS or WhatsApp message.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes::create"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Country Code",
"InputPlaceholder": "1"
},
{
"InputName": "Signer Phone Number",
"InputPlaceholder": "4155551212"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "CC Country Code",
"InputPlaceholder": "1"
},
{
"InputName": "CC Phone Number",
"InputPlaceholder": "4155551212"
},
{
"InputName": "CC Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Delivery Method:"
},
{
"InputName": "SMS"
},
{
"InputName": "WhatsApp"
}
]
}
],
"ResultsPageText": "The envelope has been created and sent!<br />Envelope ID {0}."
}
]
},
{
"Name": "Hosting the signing experience (embedded signing)",
"Examples": [
{
"ExampleNumber": 1,
"CFREnabled": "NonCFR",
"ExampleName": "Request a signature through your app (embedded signing)",
"ExampleDescription": "Sends an envelope, then uses embedded signing for the first signer. With embedded signing, DocuSign signing is initiated from your website.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/",
"PathName": "EnvelopeViews:createRecipient"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
}
]
}
],
"ResultsPageText": ""
},
{
"ExampleNumber": 41,
"CFREnabled": "CFROnly",
"ExampleName": "Request a signature through your app (embedded signing) with a CFR Part 11 account",
"ExampleDescription": "Sends an envelope, then uses embedded signing with recipient authentication by phone for the first signer. With embedded signing, DocuSign signing is initiated from your website.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/getenvelopeworkflowdefinition/",
"PathName": "EnvelopeWorkflowDefinition:getEnvelopeWorkflowDefinition"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/",
"PathName": "EnvelopeViews:createRecipient"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Signer Country Code",
"InputPlaceholder": "1"
},
{
"InputName": "Signer Phone Number",
"InputPlaceholder": "4155551212"
}
]
}
],
"ResultsPageText": ""
},
{
"ExampleNumber": 13,
"CFREnabled": "AllAccounts",
"ExampleName": "Embedded Signing Ceremony from a template with an added document",
"ExampleDescription": "<p>This example sends an envelope based on a template.</p><p>In addition to the template's document(s), the example adds an additional document to the envelope by using the <a target='_blank' href='https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/templates/composite/'>Composite Templates</a> feature.</p>",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/",
"PathName": "EnvelopeViews:createRecipient"
}
],
"RedirectsToOtherCodeExamples": [
{
"CodeExampleToRedirectTo": 8,
"RedirectText": "<p>Prerequisite: Please first create the template using <a {0}>Create a template</a>.</p>"
}
],
"Forms": [
{
"FormName": "<p>The template you created via Create a template will be used.</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "CC Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "CC Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Item"
},
{
"InputName": "Quantity"
}
]
}
],
"ResultsPageText": ""
},
{
"ExampleNumber": 44,
"CFREnabled": "NonCFR",
"ExampleName": "Request a signature using focused view",
"ExampleDescription": "Sends an envelope, then uses focused view for the signer.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/",
"PathName": "EnvelopeViews:createRecipient"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
}
]
}
],
"ResultsPageText": "The document has been embedded with focused view.",
"SkipForLanguages": "bash;powershell"
},
{
"ExampleNumber": 39,
"CFREnabled": "NonCFR",
"ExampleName": "Send an envelope to an In Person Signer",
"ExampleDescription": "Demonstrates how to host an In Person Signing session with embedded signing.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/",
"PathName": "EnvelopeViews:createRecipient"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
}
]
}
],
"ResultsPageText": ""
},
{
"ExampleNumber": 14,
"CFREnabled": "NonCFR",
"ExampleName": "Send an envelope with an order form and payment field",
"ExampleDescription": "Anchor text (<a target='_blank' href=\"https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/tabs/auto-place/\">AutoPlace</a>) is used to position the fields in the documents.",
"Notes": "<h5 style=\"color: purple;\">Note: This example will only work if the sender's DocuSign account is set up with a DocuSign payment gateway. Since the Payment Gateway ID is set in the configuration file, you will need to run your own instance of this project to set it.</h5>",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/",
"PathName": "EnvelopeViews:createRecipient"
}
],
"RedirectsToOtherCodeExamples": [
{
"RedirectText": "<p>Prerequisite: Please set the <b>DS_PAYMENT_GATEWAY_ID</b> value in the configuration file.</p>"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "CC Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "CC Email",
"InputPlaceholder": "pat@example.com"
}
]
}
],
"ResultsPageText": "The envelope has been created and sent!<br/>Envelope ID {0}."
}
]
},
{
"Name": "Using envelopes and templates",
"Examples": [
{
"ExampleNumber": 4,
"CFREnabled": "AllAccounts",
"ExampleName": "Get an envelope's basic information and status",
"ExampleDescription": "List the basic information about an envelope, including its overall status. Additional API/SDK methods may be used to get additional information about the envelope, its documents, recipients, etc.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/get/",
"PathName": "Envelopes:get"
}
],
"RedirectsToOtherCodeExamples": [
{
"CodeExampleToRedirectTo": 2,
"RedirectText": "<p>Problem: please first create an envelope using <a {0}>Send an envelope with a remote (email) signer and cc recipient.</a> <br />You will then need to use List an envelope's documents to create the list of documents.<br />Thank you.</p>"
}
],
"Forms": [
{
"FormName": "<p>The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.</p>"
}
],
"ResultsPageText": "Results from the Envelopes::get method:"
},
{
"ExampleNumber": 5,
"CFREnabled": "AllAccounts",
"ExampleName": "List an envelope's recipients and their status",
"ExampleDescription": "List the envelope's recipients, including their current status.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/",
"PathName": "EnvelopeRecipients:list"
}
],
"RedirectsToOtherCodeExamples": [
{
"CodeExampleToRedirectTo": 2,
"RedirectText": "<p>Problem: please first create an envelope using <a {0}>Send an envelope with a remote (email) signer and cc recipient.</a> <br />You will then need to use List an envelope's documents to create the list of documents.<br />Thank you.</p>"
}
],
"Forms": [
{
"FormName": "<p>The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.</p>"
}
],
"ResultsPageText": ""
},
{
"ExampleNumber": 3,
"CFREnabled": "AllAccounts",
"ExampleName": "List envelopes in the user's account",
"ExampleDescription": "List the envelopes created in the last 30 days.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/",
"PathName": "Envelopes:listStatusChanges"
}
],
"ResultsPageText": "Results from the Envelopes::listStatusChanges method:"
},
{
"ExampleNumber": 8,
"CFREnabled": "AllAccounts",
"ExampleName": "Create a template",
"ExampleDescription": "Create a template with two roles, <b>signer</b> and <b>cc</b>.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/list/",
"PathName": "Templates:list"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/templates/templates/create/",
"PathName": "Templates:create"
}
],
"ResultsPageText": "<br/>Template name: {0}, ID {1}."
},
{
"ExampleNumber": 11,
"CFREnabled": "AllAccounts",
"ExampleName": "Embedded sending",
"ExampleDescription": "An envelope will be created in draft mode. The DocuSign web tool (NDSE) will then be shown, enabling further updates to the envelope before it is sent.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/",
"PathName": "EnvelopeViews:createSender"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Starting View"
},
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "CC Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "CC Name",
"InputPlaceholder": "Pat Johnson"
}
]
}
],
"ResultsPageText": "Sender view URL: {0}"
},
{
"ExampleNumber": 31,
"CFREnabled": "AllAccounts",
"ExampleName": "Bulk send envelopes",
"ExampleDescription": "Demonstrates how to send envelopes in bulk to multiple recipients. First, this example creates a bulk-send recipients list, then creates an envelope. After that, it initiates bulk envelope sending.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendlist/",
"PathName": "BulkSend::createBulkSendList"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes::create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopecustomfields/create/",
"PathName": "EnvelopeCustomFields::create"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/",
"PathName": "BulkSend::createBulkSendRequest"
},
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/bulkenvelopes/bulksend/getbulksendbatchstatus/",
"PathName": "BulkSend::getBulkSendBatchStatus"
}
],
"CustomErrorTexts": [
{
"ErrorMessage": "Bulk send envelope failed."
}
],
"Forms": [
{
"FormName": "<p>Bulk copy #1</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Signer Name"
},
{
"InputName": "CC Email",
"InputPlaceholder": "CC Email"
},
{
"InputName": "CC Name",
"InputPlaceholder": "CC Name"
}
]
},
{
"FormName": "<p>Bulk copy #2</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Signer Name"
},
{
"InputName": "CC Email",
"InputPlaceholder": "CC Email"
},
{
"InputName": "CC Name",
"InputPlaceholder": "CC Name"
}
]
}
],
"ResultsPageText": "Results from BulkSend:getBulkSendBatchStatus method:"
}
]
},
{
"Name": "Using advanced recipient routing",
"Examples": [
{
"ExampleNumber": 32,
"CFREnabled": "NonCFR",
"ExampleName": "Pause a signature workflow",
"ExampleDescription": "This example creates and envelope and then pauses the signature workflow.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
}
],
"Forms": [
{
"FormName": "<p>Signer 1</p>",
"Inputs": [
{
"InputName": "Signer name",
"InputPlaceholder": "Signer name"
},
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
}
]
},
{
"FormName": "<p>Signer 2</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Signer name"
}
]
}
],
"ResultsPageText": "Results from the Envelopes::create method:"
},
{
"ExampleNumber": 33,
"CFREnabled": "NonCFR",
"ExampleName": "Unpause a signature workflow",
"ExampleDescription": "This example unpauses a signature workflow for the previously created envelope that was paused.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/",
"PathName": "Envelopes:update"
}
],
"RedirectsToOtherCodeExamples": [
{
"CodeExampleToRedirectTo": 32,
"RedirectText": "<p>Prerequisite: Please first create an envelope with a paused signature workflow using <a {0}>Pause a signature workflow</a>.</p>"
}
],
"Forms": [
{
"FormName": "<p>Signer 1</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer name",
"InputPlaceholder": "Signer name"
}
]
},
{
"FormName": "<p>Conditional signer 2 when unchecked</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer name",
"InputPlaceholder": "Signer name"
}
]
},
{
"FormName": "<p>Conditional signer 2 when checked</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer name",
"InputPlaceholder": "Signer name"
}
]
}
],
"ResultsPageText": "Results from the Envelopes::update method:"
},
{
"ExampleNumber": 34,
"CFREnabled": "NonCFR",
"ExampleName": "Use conditional recipients",
"ExampleDescription": "Demonstrates how to create an envelope where the workflow is routed to different recipients based on the value of a transaction.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
}
],
"CustomErrorTexts": [
{
"ErrorMessageCheck": "WORKFLOW_UPDATE_RECIPIENTROUTING_NOT_ALLOWED",
"ErrorMessage": "Update to the workflow with recipient routing is not allowed for your account! Please contact with our <a href='https://developers.docusign.com/support/' target='_blank'>support team</a> to resolve this issue."
}
],
"Forms": [
{
"FormName": "<p>Signer 1</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer name",
"InputPlaceholder": "Signer name"
}
]
},
{
"FormName": "<p>Conditional signer 2 when unchecked</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer name",
"InputPlaceholder": "Signer name"
}
]
},
{
"FormName": "<p>Conditional signer 2 when checked</p>",
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "Signer Email"
},
{
"InputName": "Signer name",
"InputPlaceholder": "Signer name"
}
]
}
],
"ResultsPageText": "Envelope ID {0} with conditional routing criteria has been created and sent to the first recipient!"
},
{
"ExampleNumber": 35,
"CFREnabled": "AllAccounts",
"ExampleName": "Schedule an envelope",
"ExampleDescription": "Demonstrates how to schedule an envelope using the scheduled sending feature.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Resume Date"
}
]
}
],
"ResultsPageText": "The envelope has been created and scheduled!<br />Envelope ID {0}."
},
{
"ExampleNumber": 36,
"CFREnabled": "NonCFR",
"ExampleName": "Send an envelope with delayed routing",
"ExampleDescription": "Demonstrates how to delay an envelope’s delivery between recipients using the delayed routing feature.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer 1 Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer 1 Name",
"InputPlaceholder": "Pat Johnson"
},
{
"InputName": "Signer 2 Email",
"InputPlaceholder": "dana@example.com"
},
{
"InputName": "Signer 2 Name",
"InputPlaceholder": "Dana Paxon"
},
{
"InputName": "Delay (in hours)"
}
]
}
],
"ResultsPageText": "The envelope has been created and sent!<br />Envelope ID {0}."
}
]
},
{
"Name": "Using documents",
"Examples": [
{
"ExampleNumber": 6,
"CFREnabled": "AllAccounts",
"ExampleName": "List an envelope's documents",
"ExampleDescription": "List the envelope's documents. A <i>Certificate of Completion</i> document is also associated with every envelope.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/list/",
"PathName": "EnvelopeDocuments:list"
}
],
"RedirectsToOtherCodeExamples": [
{
"CodeExampleToRedirectTo": 2,
"RedirectText": "<p>Problem: please first create an envelope using <a {0}>Send an envelope with a remote (email) signer and cc recipient.</a> <br />You will then need to use List an envelope's documents to create the list of documents.<br />Thank you.</p>"
}
],
"Forms": [
{
"FormName": "<p>The envelope you created via Send an envelope with a remote (email) signer and cc recipient will be queried.</p>"
}
],
"ResultsPageText": "Results from the EnvelopeDocuments::list method:"
},
{
"ExampleNumber": 7,
"CFREnabled": "AllAccounts",
"ExampleName": "Download a document from an envelope",
"ExampleDescription": "An envelope's documents can be downloaded one by one or as a complete set.",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopedocuments/get/",
"PathName": "EnvelopeDocuments:get"
}
],
"RedirectsToOtherCodeExamples": [
{
"CodeExampleToRedirectTo": 2,
"RedirectText": "<p>Problem: please first create an envelope using <a {0}>Send an envelope with a remote (email) signer and cc recipient.</a> <br />You will then need to use List an envelope's documents to create the list of documents.<br />Thank you.</p>"
},
{
"CodeExampleToRedirectTo": 6,
"RedirectText": "<p>Problem: please first create a list of the envelope's documents using<a {0}>List an envelope's documents.</a> <br />Thank you.</p>"
}
],
"Forms": [
{
"FormName": "<p>Please choose a document.<br/>The document list is from your results for List an envelope's documents.</p>",
"Inputs": [
{
"InputName": "Document selection"
}
]
}
],
"ResultsPageText": ""
},
{
"ExampleNumber": 10,
"CFREnabled": "AllAccounts",
"ExampleName": "Send an envelope using binary document transfer",
"ExampleDescription": "<p>The envelope includes a pdf, Word, and HTML document.</p><p>Multipart data transfer is used to send the documents in binary format to DocuSign. Binary transfer is 33% more efficient than base64 encoding and is recommended for documents over 15M Bytes. Binary transfer is not yet supported by the SDK.</p>",
"LinksToAPIMethod": [
{
"Path": "https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/create/",
"PathName": "Envelopes:create"
}
],
"Forms": [
{
"Inputs": [
{
"InputName": "Signer Email",
"InputPlaceholder": "pat@example.com"
},
{
"InputName": "Signer Name",
"InputPlaceholder": "Pat Johnson"
},
{