forked from hellosign/hellosign-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathen.yaml
1599 lines (1339 loc) · 135 KB
/
en.yaml
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
##############
# OAS Config #
##############
"OpenApi::TITLE": Dropbox Sign API
"OpenApi::DESCRIPTION": Dropbox Sign v3 API
"OpenApi::AUTH::API_KEY": |-
Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.
✅ Supported by Try it console (calls sent in `test_mode` only).
"OpenApi::AUTH::OAUTH": |-
You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information.
❌ **Not supported** by Try it console.
"OpenApi::TAG::ACCOUNT::DESCRIPTION": ./markdown/en/tags/account-tag-description.md
"OpenApi::TAG::API_APP::DESCRIPTION": ./markdown/en/tags/api-app-tag-description.md
"OpenApi::TAG::BULK_SEND_JOB::DESCRIPTION": ./markdown/en/tags/bulk-send-job-tag-description.md
"OpenApi::TAG::EMBEDDED::DESCRIPTION": ./markdown/en/tags/embedded-tag-description.md
"OpenApi::TAG::REPORT::DESCRIPTION": ./markdown/en/tags/report-tag-description.md
"OpenApi::TAG::SIGNATURE_REQUEST::DESCRIPTION": ./markdown/en/tags/signature-request-tag-description.md
"OpenApi::TAG::TEAM::DESCRIPTION": ./markdown/en/tags/team-tag-description.md
"OpenApi::TAG::TEMPLATE::DESCRIPTION": ./markdown/en/tags/template-tag-description.md
"OpenApi::TAG::UNCLAIMED_DRAFT::DESCRIPTION": ./markdown/en/tags/unclaimed-draft-tag-description.md
"OpenApi::TAG::OAUTH::DESCRIPTION": ./markdown/en/tags/oauth-tag-description.md
"OpenApi::TAG::CALLBACKS_AND_EVENTS::DESCRIPTION": ./markdown/en/tags/callbacks-tag-description.md
"OpenApi::ACCOUNT_CALLBACK::SUMMARY": Account Callbacks
"OpenApi::ACCOUNT_CALLBACK::DESCRIPTION": ./markdown/en/descriptions/account-callback-description.md
"OpenApi::APP_CALLBACK::SUMMARY": App Callbacks
"OpenApi::APP_CALLBACK::DESCRIPTION": ./markdown/en/descriptions/api-app-callback-description.md
##################
# Request Models #
##################
"AccountCreate::DESCRIPTION": Creates a new Dropbox Sign Account that is associated with the specified `email_address`.
"AccountCreate::SUMMARY": Create Account
"AccountCreate::CLIENT_ID": |-
Used when creating a new account with OAuth authorization.
See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
"AccountCreate::CLIENT_SECRET": |-
Used when creating a new account with OAuth authorization.
See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
"AccountCreate::EMAIL_ADDRESS": The email address which will be associated with the new Account.
"AccountCreate::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
"AccountGet::DESCRIPTION": Returns the properties and settings of your Account.
"AccountGet::SUMMARY": Get Account
"AccountGet::ACCOUNT_ID": |-
`account_id` or `email_address` is required. If both are provided, the account id prevails.
The ID of the Account.
"AccountGet::EMAIL_ADDRESS": |-
`account_id` or `email_address` is required, If both are provided, the account id prevails.
The email address of the Account.
"AccountUpdate::SUMMARY": Update Account
"AccountUpdate::DESCRIPTION": Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.
"AccountUpdate::ACCOUNT_ID": The ID of the Account
"AccountUpdate::CALLBACK_URL": The URL that Dropbox Sign should POST events to.
"AccountUpdate::LOCALE": The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.
"AccountVerify::SUMMARY": Verify Account
"AccountVerify::DESCRIPTION": |-
Verifies whether an Dropbox Sign Account exists for the given email address.
"AccountVerify::EMAIL_ADDRESS": Email address to run the verification for.
"ApiAppCreate::SUMMARY": Create API App
"ApiAppCreate::DESCRIPTION": Creates a new API App.
"ApiAppCreate::CALLBACK_URL": The URL at which the ApiApp should receive event callbacks.
"ApiAppCreate::CUSTOM_LOGO_FILE": An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
"ApiAppCreate::DOMAINS": The domain names the ApiApp will be associated with.
"ApiAppCreate::NAME": The name you want to assign to the ApiApp.
"ApiAppDelete::SUMMARY": Delete API App
"ApiAppDelete::DESCRIPTION": Deletes an API App. Can only be invoked for apps you own.
"ApiAppDelete::CLIENT_ID": The client id of the API App to delete.
"ApiAppGet::SUMMARY": Get API App
"ApiAppGet::DESCRIPTION": Returns an object with information about an API App.
"ApiAppGet::CLIENT_ID": The client id of the API App to retrieve.
"ApiAppList::SUMMARY": List API Apps
"ApiAppList::DESCRIPTION": Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.
"ApiAppList::PAGE": Which page number of the API App List to return. Defaults to `1`.
"ApiAppList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
"ApiAppUpdate::SUMMARY": Update API App
"ApiAppUpdate::DESCRIPTION": Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.
"ApiAppUpdate::CALLBACK_URL": The URL at which the API App should receive event callbacks.
"ApiAppUpdate::CLIENT_ID": The client id of the API App to update.
"ApiAppUpdate::CUSTOM_LOGO_FILE": An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)
"ApiAppUpdate::DOMAINS": The domain names the ApiApp will be associated with.
"ApiAppUpdate::NAME": The name you want to assign to the ApiApp.
"ApiAppUpdate::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
"BulkSendJobGet::SUMMARY": Get Bulk Send Job
"BulkSendJobGet::DESCRIPTION": Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
"BulkSendJobGet::BULK_SEND_JOB_ID": The id of the BulkSendJob to retrieve.
"BulkSendJobGet::PAGE": Which page number of the BulkSendJob list to return. Defaults to `1`.
"BulkSendJobGet::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.
"BulkSendJobList::SUMMARY": List Bulk Send Jobs
"BulkSendJobList::DESCRIPTION": Returns a list of BulkSendJob that you can access.
"BulkSendJobList::PAGE": Which page number of the BulkSendJob List to return. Defaults to `1`.
"BulkSendJobList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.
"EmbeddedEditUrl::SUMMARY": Get Embedded Template Edit URL
"EmbeddedEditUrl::DESCRIPTION": Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
"EmbeddedEditUrl::ALLOW_EDIT_CCS": This allows the requester to enable/disable to add or change CC roles when editing the template.
"EmbeddedEditUrl::CC_ROLES": The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.
"EmbeddedEditUrl::FORCE_SIGNER_ROLES": Provide users the ability to review/edit the template signer roles.
"EmbeddedEditUrl::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the template subject and message.
"EmbeddedEditUrl::MERGE_FIELDS": |-
Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.
Remove all merge fields on the template by passing an empty array `[]`.
"EmbeddedEditUrl::PREVIEW_ONLY": |-
This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
**Note**: This parameter overwrites `show_preview=true` (if set).
"EmbeddedEditUrl::SHOW_PREVIEW": This allows the requester to enable the editor/preview experience.
"EmbeddedEditUrl::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
"EmbeddedEditUrl::TEMPLATE_ID": The id of the template to edit.
"EmbeddedEditUrl::TEST_MODE": Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.
"EmbeddedSignUrl::SUMMARY": Get Embedded Sign URL
"EmbeddedSignUrl::DESCRIPTION": Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
"EmbeddedSignUrl::SIGNATURE_ID": The id of the signature to get a signature url for.
"OAuthTokenGenerate::SUMMARY": OAuth Token Generate
"OAuthTokenGenerate::DESCRIPTION": Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
"OAuthTokenGenerate::CLIENT_ID": The client id of the app requesting authorization.
"OAuthTokenGenerate::CLIENT_SECRET": The secret token of your app.
"OAuthTokenGenerate::CODE": The code passed to your callback when the user granted access.
"OAuthTokenGenerate::GRANT_TYPE": When generating a new token use `authorization_code`.
"OAuthTokenGenerate::STATE": Same as the state you specified earlier.
"OAuthTokenRefresh::SUMMARY": OAuth Token Refresh
"OAuthTokenRefresh::DESCRIPTION": Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.
"OAuthTokenRefresh::GRANT_TYPE": When refreshing an existing token use `refresh_token`.
"OAuthTokenRefresh::REFRESH_TOKEN": The token provided when you got the expired access token.
"ReportCreate::SUMMARY": Create Report
"ReportCreate::DESCRIPTION": |-
Request the creation of one or more report(s).
When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past.
"ReportCreate::END_DATE": The (inclusive) end date for the report data in `MM/DD/YYYY` format.
"ReportCreate::REPORT_TYPE": The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).
"ReportCreate::START_DATE": The (inclusive) start date for the report data in `MM/DD/YYYY` format.
"SignatureRequestBulkCreateEmbeddedWithTemplate::SUMMARY": Embedded Bulk Send with Template
"SignatureRequestBulkCreateEmbeddedWithTemplate::DESCRIPTION": |-
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
**NOTE**: Only available for Standard plan and higher.
"SignatureRequestBulkCreateEmbeddedWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"SignatureRequestBulkCreateEmbeddedWithTemplate::CLIENT_ID": Client id of the app you're using to create this embedded signature request. Used for security purposes.
"SignatureRequestBulkCreateEmbeddedWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
"SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_FILE": |-
`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName
- `email_address`: email address of the signer filling the role of RoleName
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
**Note**: Not available in test mode and requires a Standard plan or higher.
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
```
name, email_address, pin, company_field
George, [email protected], d79a3td, ABC Corp
Mary, [email protected], gd9as5b, 123 LLC
```
"SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNER_LIST": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
"SignatureRequestBulkCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"SignatureRequestBulkCreateEmbeddedWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
"SignatureRequestBulkCreateEmbeddedWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
"SignatureRequestBulkCreateEmbeddedWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
"SignatureRequestBulkCreateEmbeddedWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
"SignatureRequestBulkSendWithTemplate::SUMMARY": Bulk Send with Template
"SignatureRequestBulkSendWithTemplate::DESCRIPTION": |-
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter.
**NOTE**: Only available for Standard plan and higher.
"SignatureRequestBulkSendWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"SignatureRequestBulkSendWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
"SignatureRequestBulkSendWithTemplate::SIGNER_FILE": |-
`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName
- `email_address`: email address of the signer filling the role of RoleName
- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
**Note**: Not available in test mode and requires a Standard plan or higher.
- `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
```
name, email_address, pin, company_field
George, [email protected], d79a3td, ABC Corp
Mary, [email protected], gd9as5b, 123 LLC
```
"SignatureRequestBulkSendWithTemplate::SIGNER_LIST": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
"SignatureRequestBulkSendWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"SignatureRequestBulkSendWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
"SignatureRequestBulkSendWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
"SignatureRequestBulkSendWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
"SignatureRequestBulkSendWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
"SignatureRequestBulkSendWithTemplate::CLIENT_ID" : The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
"SignatureRequestCancel::SUMMARY": Cancel Incomplete Signature Request
"SignatureRequestCancel::DESCRIPTION": |-
Cancels an incomplete signature request. This action is **not reversible**.
The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.
This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.
To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.
**NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
"SignatureRequestCancel::SIGNATURE_REQUEST_ID": The id of the incomplete SignatureRequest to cancel.
"SignatureRequestCreateEmbedded::SUMMARY": Create Embedded Signature Request
"SignatureRequestCreateEmbedded::DESCRIPTION": Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
"SignatureRequestCreateEmbedded::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"SignatureRequestCreateEmbedded::ALLOW_REASSIGN": |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan.
"SignatureRequestCreateEmbedded::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
"SignatureRequestCreateEmbedded::CLIENT_ID": Client id of the app you're using to create this embedded signature request. Used for security purposes.
"SignatureRequestCreateEmbedded::FILES": |-
Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestCreateEmbedded::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestCreateEmbedded::EXPIRES_AT": When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
"SignatureRequestCreateEmbedded::HIDE_TEXT_TAGS": |-
Enables automatic Text Tag removal when set to true.
**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
"SignatureRequestCreateEmbedded::POPULATE_AUTO_FILL_FIELDS": |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
"SignatureRequestCreateEmbedded::MESSAGE": The custom message in the email that will be sent to the signers.
"SignatureRequestCreateEmbedded::SUBJECT": The subject in the email that will be sent to the signers.
"SignatureRequestCreateEmbedded::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
"SignatureRequestCreateEmbedded::TITLE": The title you want to assign to the SignatureRequest.
"SignatureRequestCreateEmbedded::USE_TEXT_TAGS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
"SignatureRequestCreateEmbeddedWithTemplate::SUMMARY": Create Embedded Signature Request with Template
"SignatureRequestCreateEmbeddedWithTemplate::DESCRIPTION": Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
"SignatureRequestCreateEmbeddedWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"SignatureRequestCreateEmbeddedWithTemplate::CLIENT_ID": Client id of the app you're using to create this embedded signature request. Used for security purposes.
"SignatureRequestCreateEmbeddedWithTemplate::FILES": |-
Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestCreateEmbeddedWithTemplate::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestCreateEmbeddedWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
"SignatureRequestCreateEmbeddedWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
"SignatureRequestCreateEmbeddedWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
"SignatureRequestCreateEmbeddedWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
"SignatureRequestCreateEmbeddedWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
"SignatureRequestCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS": |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
"SignatureRequestFiles::SUMMARY": Download Files
"SignatureRequestFiles::DESCRIPTION": |-
Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file.
If the files are currently being prepared, a status code of `409` will be returned instead.
"SignatureRequestFilesAsFileUrl::SUMMARY": Download Files as File Url
"SignatureRequestFilesAsFileUrl::DESCRIPTION": |-
Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only).
If the files are currently being prepared, a status code of `409` will be returned instead.
"SignatureRequestFilesAsDataUri::SUMMARY": Download Files as Data Uri
"SignatureRequestFilesAsDataUri::DESCRIPTION": |-
Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).
If the files are currently being prepared, a status code of `409` will be returned instead.
"SignatureRequestFiles::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to retrieve.
"SignatureRequestFiles::FILE_TYPE": Set to `pdf` for a single merged document or `zip` for a collection of individual documents.
"SignatureRequestFiles::GET_DATA_URI": If `true`, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs.
"SignatureRequestFiles::GET_URL": If `true`, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days.
"SignatureRequestGet::SUMMARY": Get Signature Request
"SignatureRequestGet::DESCRIPTION": Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
"SignatureRequestGet::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to retrieve.
"SignatureRequestList::SUMMARY": List Signature Requests
"SignatureRequestList::DESCRIPTION": |-
Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.
Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
"SignatureRequestList::ACCOUNT_ID": Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
"SignatureRequestList::PAGE": Which page number of the SignatureRequest List to return. Defaults to `1`.
"SignatureRequestList::PAGE_SIZE": Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.
"SignatureRequestList::QUERY": String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
"SignatureRequestReleaseHold::SUMMARY": Release On-Hold Signature Request
"SignatureRequestReleaseHold::DESCRIPTION": Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.
"SignatureRequestReleaseHold::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to release.
"SignatureRequestRemind::SUMMARY": Send Request Reminder
"SignatureRequestRemind::DESCRIPTION": |-
Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders.
**NOTE**: This action can **not** be used with embedded signature requests.
"SignatureRequestRemind::EMAIL_ADDRESS": The email address of the signer to send a reminder to.
"SignatureRequestRemind::NAME": The name of the signer to send a reminder to. Include if two or more
signers share an email address.
"SignatureRequestRemind::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to send a reminder for.
"SignatureRequestRemove::SUMMARY": Remove Signature Request Access
"SignatureRequestRemove::DESCRIPTION": |-
Removes your access to a completed signature request. This action is **not reversible**.
The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s).
Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
"SignatureRequestRemove::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to remove.
"SignatureRequestSend::SUMMARY": Send Signature Request
"SignatureRequestSend::DESCRIPTION": Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.
"SignatureRequestSend::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"SignatureRequestSend::ALLOW_REASSIGN": |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher.
"SignatureRequestSend::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
"SignatureRequestSend::CLIENT_ID": The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.
"SignatureRequestSend::FILES": |-
Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestSend::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestSend::HIDE_TEXT_TAGS": |-
Enables automatic Text Tag removal when set to true.
**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
"SignatureRequestSend::IS_QUALIFIED_SIGNATURE": |-
Send with a value of `true` if you wish to enable
[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
which requires a face-to-face call to verify the signer's identity.<br>
**Note**: QES is only available on the Premium API plan as an add-on purchase.
Cannot be used in `test_mode`. Only works on requests with one signer.
"SignatureRequestSend::MESSAGE": The custom message in the email that will be sent to the signers.
"SignatureRequestSend::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"SignatureRequestSend::SUBJECT": The subject in the email that will be sent to the signers.
"SignatureRequestSend::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
"SignatureRequestSend::TITLE": The title you want to assign to the SignatureRequest.
"SignatureRequestSend::EXPIRES_AT": When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
"SignatureRequestSend::USE_PREEXISTING_FIELDS": Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.
"SignatureRequestSendWithTemplate::SUMMARY": Send with Template
"SignatureRequestSendWithTemplate::DESCRIPTION": Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.
"SignatureRequestSendWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"SignatureRequestSendWithTemplate::CLIENT_ID": Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.
"SignatureRequestSendWithTemplate::FILES": |-
Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestSendWithTemplate::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"SignatureRequestSendWithTemplate::IS_QUALIFIED_SIGNATURE": |-
Send with a value of `true` if you wish to enable
[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
which requires a face-to-face call to verify the signer's identity.<br>
**Note**: QES is only available on the Premium API plan as an add-on purchase.
Cannot be used in `test_mode`. Only works on requests with one signer.
"SignatureRequestSendWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
"SignatureRequestSendWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"SignatureRequestSendWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
"SignatureRequestSendWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.
"SignatureRequestSendWithTemplate::TEST_MODE": Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.
"SignatureRequestSendWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
"SignatureRequestUpdate::SUMMARY": Update Signature Request
"SignatureRequestUpdate::DESCRIPTION": |-
Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.
**NOTE**: This action cannot be performed on a signature request with an appended signature page.
"SignatureRequestUpdate::EMAIL_ADDRESS": |-
The new email address for the recipient.
**NOTE**: Optional if `name` is provided.
"SignatureRequestUpdate::NAME": |-
The new name for the recipient.
**NOTE**: Optional if `email_address` is provided.
"TeamAddMember::TEAM_ID": The id of the team.
"SignatureRequestUpdate::SIGNATURE_ID": The signature ID for the recipient.
"SignatureRequestUpdate::EXPIRES_AT": The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
"SignatureRequestUpdate::SIGNATURE_REQUEST_ID": The id of the SignatureRequest to update.
"TeamAddMember::SUMMARY": Add User to Team
"TeamAddMember::DESCRIPTION": Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.
"TeamAddMember::ACCOUNT_ID": |-
`account_id` or `email_address` is required. If both are provided, the account id prevails.
Account id of the user to invite to your Team.
"TeamAddMember::EMAIL_ADDRESS": |-
`account_id` or `email_address` is required, If both are provided, the account id prevails.
Email address of the user to invite to your Team.
"TeamAddMember::ROLE": |-
A role member will take in a new Team.
**Note**: This parameter is used only if `team_id` is provided.
"TeamCreate::SUMMARY": Create Team
"TeamCreate::DESCRIPTION": Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.
"TeamCreate::NAME": The name of your Team.
"TeamDelete::SUMMARY": Delete Team
"TeamDelete::DESCRIPTION": Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).
"TeamGet::SUMMARY": Get Team
"TeamGet::DESCRIPTION": Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.
"TeamRemoveMember::SUMMARY": Remove User from Team
"TeamRemoveMember::DESCRIPTION": Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.
"TeamRemoveMember::NEW_TEAM_ID": Id of the new Team.
"TeamRemoveMember::NEW_ROLE": |-
A new role member will take in a new Team.
**Note**: This parameter is used only if `new_team_id` is provided.
"TeamRemoveMember::ACCOUNT_ID": |-
**account_id** or **email_address** is required. If both are provided, the account id prevails.
Account id to remove from your Team.
"TeamRemoveMember::EMAIL_ADDRESS": |-
**account_id** or **email_address** is required. If both are provided, the account id prevails.
Email address of the Account to remove from your Team.
"TeamRemoveMember::NEW_OWNER_EMAIL_ADDRESS": |-
The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.
**Note**: Only available for Enterprise plans.
"TeamUpdate::SUMMARY": Update Team
"TeamUpdate::DESCRIPTION": Updates the name of your Team.
"TeamUpdate::NAME": The name of your Team.
"TeamInfo::SUMMARY": Get Team Info
"TeamInfo::DESCRIPTION": Provides information about a team.
"TeamInfo::TEAM_ID": The id of the team.
"TeamInfo::TEAM_PARENT": Information about the parent team if a team has one, set to `null` otherwise.
"TeamInvites::SUMMARY": List Team Invites
"TeamInvites::DESCRIPTION": Provides a list of team invites (and their roles).
"TeamInvites::EMAIL_ADDRESS": The email address for which to display the team invites.
"TeamInviteResponse::EMAIL_ADDRESS": Email address of the user invited to this team.
"TeamInviteResponse::TEAM_ID": Id of the team.
"TeamInviteResponse::ROLE": Role of the user invited to this team.
"TeamInviteResponse::SENT_AT": Timestamp when the invitation was sent.
"TeamInviteResponse::REDEEMED_AT": Timestamp when the invitation was redeemed.
"TeamInviteResponse::EXPIRES_AT": Timestamp when the invitation is expiring.
"TeamInvitesResponse::DESCRIPTION": Contains a list of team invites and their roles.
"TeamMembers::SUMMARY": List Team Members
"TeamMembers::DESCRIPTION": Provides a paginated list of members (and their roles) that belong to a given team.
"TeamMembers::TEAM_ID": The id of the team that a member list is being requested from.
"TeamMembers::PAGE": Which page number of the team member list to return. Defaults to `1`.
"TeamMembers::PAGE_SIZE": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
"TeamMembersResponse::DESCRIPTION": Contains a list of team members and their roles for a specific team.
"TeamMemberResponse::ACCOUNT_ID": Account id of the team member.
"TeamMemberResponse::EMAIL_ADDRESS": Email address of the team member.
"TeamMemberResponse::MEMBER_ROLE": The specific role a member has on the team.
"TeamSubTeams::SUMMARY": List Sub Teams
"TeamSubTeams::DESCRIPTION": Provides a paginated list of sub teams that belong to a given team.
"TeamSubTeams::TEAM_ID": The id of the parent Team.
"TeamSubTeams::PAGE": Which page number of the SubTeam List to return. Defaults to `1`.
"TeamSubTeams::PAGE_SIZE": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
"SubTeamResponse::DESCRIPTION": Contains a list with sub teams.
"TemplateAddUser::SUMMARY": Add User to Template
"TemplateAddUser::DESCRIPTION": Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
"TemplateAddUser::ACCOUNT_ID": |-
The id of the Account to give access to the Template.
<b>Note</b> The account id prevails if email address is also provided.
"TemplateAddUser::EMAIL_ADDRESS": |-
The email address of the Account to give access to the Template.
<b>Note</b> The account id prevails if it is also provided.
"TemplateAddUser::SKIP_NOTIFICATION": If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.
"TemplateAddUser::TEMPLATE_ID": The id of the Template to give the Account access to.
"TemplateCreateEmbeddedDraft::SUMMARY": Create Embedded Template Draft
"TemplateCreateEmbeddedDraft::DESCRIPTION": The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
"TemplateCreateEmbeddedDraft::ALLOW_CCS": This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.
"TemplateCreateEmbeddedDraft::ALLOW_REASSIGN": |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher.
"TemplateCreateEmbeddedDraft::CC_ROLES": The CC roles that must be assigned when using the template to send a signature request
"TemplateCreateEmbeddedDraft::CLIENT_ID": Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app.
"TemplateCreateEmbeddedDraft::FILES": |-
Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"TemplateCreateEmbeddedDraft::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"TemplateCreateEmbeddedDraft::FORCE_SIGNER_ROLES": Provide users the ability to review/edit the template signer roles.
"TemplateCreateEmbeddedDraft::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the template subject and message.
"TemplateCreateEmbeddedDraft::MERGE_FIELDS": |-
Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter.
If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
"TemplateCreateEmbeddedDraft::MESSAGE": The default template email message.
"TemplateCreateEmbeddedDraft::SHOW_PREVIEW": |-
This allows the requester to enable the editor/preview experience.
- `show_preview=true`: Allows requesters to enable the editor/preview experience.
- `show_preview=false`: Allows requesters to disable the editor/preview experience.
"TemplateCreateEmbeddedDraft::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
"TemplateCreateEmbeddedDraft::SIGNER_ROLES": An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
"TemplateCreateEmbeddedDraft::SKIP_ME_NOW": Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
"TemplateCreateEmbeddedDraft::SUBJECT": The template title (alias).
"TemplateCreateEmbeddedDraft::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
"TemplateCreateEmbeddedDraft::TITLE": The title you want to assign to the SignatureRequest.
"TemplateCreateEmbeddedDraft::USE_PREEXISTING_FIELDS": Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).
"TemplateDelete::SUMMARY": Delete Template
"TemplateDelete::DESCRIPTION": Completely deletes the template specified from the account.
"TemplateDelete::TEMPLATE_ID": The id of the Template to delete.
"TemplateFiles::SUMMARY": Get Template Files
"TemplateFiles::DESCRIPTION": |-
Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file.
If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
"TemplateFilesAsFileUrl::SUMMARY": Get Template Files as File Url
"TemplateFilesAsFileUrl::DESCRIPTION": |-
Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only).
If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
"TemplateFilesAsDataUri::SUMMARY": Get Template Files as Data Uri
"TemplateFilesAsDataUri::DESCRIPTION": |-
Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).
If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
"TemplateFiles::FILE_TYPE": Set to `pdf` for a single merged document or `zip` for a collection of individual documents.
"TemplateFiles::GET_DATA_URI": If `true`, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs.
"TemplateFiles::GET_URL": If `true`, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days.
"TemplateFiles::TEMPLATE_ID": The id of the template files to retrieve.
"TemplateGet::SUMMARY": Get Template
"TemplateGet::DESCRIPTION": Returns the Template specified by the `template_id` parameter.
"TemplateGet::TEMPLATE_ID": The id of the Template to retrieve.
"TemplateList::SUMMARY": List Templates
"TemplateList::DESCRIPTION": |-
Returns a list of the Templates that are accessible by you.
Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
"TemplateList::ACCOUNT_ID": Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.
"TemplateList::PAGE": Which page number of the Template List to return. Defaults to `1`.
"TemplateList::PAGE_SIZE": "Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`."
"TemplateList::QUERY": String that includes search terms and/or fields to be used to filter the Template objects.
"TemplateRemoveUser::SUMMARY": Remove User from Template
"TemplateRemoveUser::DESCRIPTION": Removes the specified Account's access to the specified Template.
"TemplateRemoveUser::ACCOUNT_ID": The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
"TemplateRemoveUser::EMAIL_ADDRESS": The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.
"TemplateRemoveUser::TEMPLATE_ID": The id of the Template to remove the Account's access to.
"TemplateUpdateFiles::SUMMARY": Update Template Files
"TemplateUpdateFiles::DESCRIPTION": |-
Overlays a new file with the overlay of an existing template. The new file(s) must:
1. have the same or higher page count
2. the same orientation as the file(s) being replaced.
This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota.
Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks.
It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
"TemplateUpdateFiles::CLIENT_ID": Client id of the app you're using to update this template.
"TemplateUpdateFiles::FILES": |-
Use `files[]` to indicate the uploaded file(s) to use for the template.
This endpoint requires either **files** or **file_urls[]**, but not both.
"TemplateUpdateFiles::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.
This endpoint requires either **files** or **file_urls[]**, but not both.
"TemplateUpdateFiles::MESSAGE": The new default template email message.
"TemplateUpdateFiles::SUBJECT": The new default template email subject.
"TemplateUpdateFiles::TEMPLATE_ID": The ID of the template whose files to update.
"TemplateUpdateFiles::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
"UnclaimedDraftCreate::SUMMARY": Create Unclaimed Draft
"UnclaimedDraftCreate::DESCRIPTION": Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.
"UnclaimedDraftCreate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"UnclaimedDraftCreate::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
"UnclaimedDraftCreate::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
"UnclaimedDraftCreate::FILES": |-
Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"UnclaimedDraftCreate::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"UnclaimedDraftCreate::HIDE_TEXT_TAGS": Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
"UnclaimedDraftCreate::MESSAGE": The custom message in the email that will be sent to the signers.
"UnclaimedDraftCreate::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
"UnclaimedDraftCreate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"UnclaimedDraftCreate::SUBJECT": The subject in the email that will be sent to the signers.
"UnclaimedDraftCreate::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
"UnclaimedDraftCreate::TYPE": The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional.
"UnclaimedDraftCreate::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
"UnclaimedDraftCreate::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
"UnclaimedDraftCreate::EXPIRES_AT": |-
When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
**Note**: This does not correspond to the **expires_at** returned in the response.
"UnclaimedDraftCreateEmbedded::SUMMARY": Create Embedded Unclaimed Draft
"UnclaimedDraftCreateEmbedded::DESCRIPTION": |-
Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
**NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
"UnclaimedDraftCreateEmbedded::ALLOW_CCS": This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
"UnclaimedDraftCreateEmbedded::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"UnclaimedDraftCreateEmbedded::ALLOW_REASSIGN": |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher.
"UnclaimedDraftCreateEmbedded::CC_EMAIL_ADDRESSES": The email addresses that should be CCed.
"UnclaimedDraftCreateEmbedded::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
"UnclaimedDraftCreateEmbedded::FILES": |-
Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"UnclaimedDraftCreateEmbedded::FILE_URLS": |-
Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.
"UnclaimedDraftCreateEmbedded::FORCE_SIGNER_PAGE": Provide users the ability to review/edit the signers.
"UnclaimedDraftCreateEmbedded::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the subject and message.
"UnclaimedDraftCreateEmbedded::HIDE_TEXT_TAGS": Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
"UnclaimedDraftCreateEmbedded::HOLD_REQUEST": The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
"UnclaimedDraftCreateEmbedded::IS_FOR_EMBEDDED_SIGNING": The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
"UnclaimedDraftCreateEmbedded::MESSAGE": The custom message in the email that will be sent to the signers.
"UnclaimedDraftCreateEmbedded::REQUESTER_EMAIL_ADDRESS": The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.
"UnclaimedDraftCreateEmbedded::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature.
"UnclaimedDraftCreateEmbedded::SHOW_PREVIEW": |-
This allows the requester to enable the editor/preview experience.
- `show_preview=true`: Allows requesters to enable the editor/preview experience.
- `show_preview=false`: Allows requesters to disable the editor/preview experience.
"UnclaimedDraftCreateEmbedded::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
"UnclaimedDraftCreateEmbedded::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"UnclaimedDraftCreateEmbedded::SKIP_ME_NOW": Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
"UnclaimedDraftCreateEmbedded::SUBJECT": The subject in the email that will be sent to the signers.
"UnclaimedDraftCreateEmbedded::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
"UnclaimedDraftCreateEmbedded::TYPE": The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.
"UnclaimedDraftCreateEmbedded::USE_PREEXISTING_FIELDS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
"UnclaimedDraftCreateEmbedded::USE_TEXT_TAGS": Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
"UnclaimedDraftCreateEmbedded::POPULATE_AUTO_FILL_FIELDS": |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
"UnclaimedDraftCreateEmbedded::EXPIRES_AT": |-
When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
**Note**: This does not correspond to the **expires_at** returned in the response.
"UnclaimedDraftCreateEmbeddedWithTemplate::SUMMARY": Create Embedded Unclaimed Draft with Template
"UnclaimedDraftCreateEmbeddedWithTemplate::DESCRIPTION": |-
Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
**NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
"UnclaimedDraftCreateEmbeddedWithTemplate::ALLOW_DECLINE": Allows signers to decline to sign a document if `true`. Defaults to `false`.
"UnclaimedDraftCreateEmbeddedWithTemplate::ALLOW_REASSIGN": |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher.
"UnclaimedDraftCreateEmbeddedWithTemplate::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
"UnclaimedDraftCreateEmbeddedWithTemplate::FILES": |-
Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.
**files** or **file_urls[]** is required, but not both.
"UnclaimedDraftCreateEmbeddedWithTemplate::FILE_URLS": |-
Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.
**files** or **file_urls[]** is required, but not both.
"UnclaimedDraftCreateEmbeddedWithTemplate::FORCE_SIGNER_ROLES": Provide users the ability to review/edit the template signer roles.
"UnclaimedDraftCreateEmbeddedWithTemplate::FORCE_SUBJECT_MESSAGE": Provide users the ability to review/edit the template subject and message.
"UnclaimedDraftCreateEmbeddedWithTemplate::HOLD_REQUEST": The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
"UnclaimedDraftCreateEmbeddedWithTemplate::IS_FOR_EMBEDDED_SIGNING": The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
"UnclaimedDraftCreateEmbeddedWithTemplate::MESSAGE": The custom message in the email that will be sent to the signers.
"UnclaimedDraftCreateEmbeddedWithTemplate::PREVIEW_ONLY": |-
This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
- `preview_only=true`: Allows requesters to enable the preview only experience.
- `preview_only=false`: Allows requesters to disable the preview only experience.
**Note**: This parameter overwrites `show_preview=1` (if set).
"UnclaimedDraftCreateEmbeddedWithTemplate::REQUESTER_EMAIL_ADDRESS": The email address of the user that should be designated as the requester of this draft.
"UnclaimedDraftCreateEmbeddedWithTemplate::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature.
"UnclaimedDraftCreateEmbeddedWithTemplate::SHOW_PREVIEW": |-
This allows the requester to enable the editor/preview experience.
- `show_preview=true`: Allows requesters to enable the editor/preview experience.
- `show_preview=false`: Allows requesters to disable the editor/preview experience.
"UnclaimedDraftCreateEmbeddedWithTemplate::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
"UnclaimedDraftCreateEmbeddedWithTemplate::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"UnclaimedDraftCreateEmbeddedWithTemplate::SKIP_ME_NOW": Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
"UnclaimedDraftCreateEmbeddedWithTemplate::SUBJECT": The subject in the email that will be sent to the signers.
"UnclaimedDraftCreateEmbeddedWithTemplate::TEMPLATE_IDS": Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
"UnclaimedDraftCreateEmbeddedWithTemplate::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
"UnclaimedDraftCreateEmbeddedWithTemplate::TITLE": The title you want to assign to the SignatureRequest.
"UnclaimedDraftCreateEmbeddedWithTemplate::POPULATE_AUTO_FILL_FIELDS": |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
"UnclaimedDraftEditAndResend::SUMMARY": Edit and Resend Unclaimed Draft
"UnclaimedDraftEditAndResend::DESCRIPTION": |-
Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set.
**NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
"UnclaimedDraftEditAndResend::REQUESTER_EMAIL_ADDRESS": The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used.
"UnclaimedDraftEditAndResend::SIGNATURE_REQUEST_ID": The ID of the signature request to edit and resend.
"UnclaimedDraftEditAndResend::CLIENT_ID": Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
"UnclaimedDraftEditAndResend::IS_FOR_EMBEDDED_SIGNING": The request created from this draft will also be signable in embedded mode if set to `true`.
"UnclaimedDraftEditAndResend::REQUESTING_REDIRECT_URL": The URL you want signers redirected to after they successfully request a signature.
"UnclaimedDraftEditAndResend::SHOW_PROGRESS_STEPPER": When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
"UnclaimedDraftEditAndResend::SIGNING_REDIRECT_URL": The URL you want signers redirected to after they successfully sign.
"UnclaimedDraftEditAndResend::TEST_MODE": Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
"Sub::Attachment::INSTRUCTIONS": The instructions for uploading the attachment.
"Sub::Attachment::NAME": The name of attachment.
"Sub::Attachment::REQUIRED": Determines if the attachment must be uploaded.
"Sub::Attachment::SIGNER_INDEX": |-
The signer's index in the `signers` parameter (0-based indexing).
**NOTE**: Only one signer can be assigned per attachment.
"Sub::BulkCustomField::DESCRIPTION": An array of custom field values.
"Sub::BulkCustomField::NAME": The name of the custom field. Must be the field's `name` or `api_id`.
"Sub::BulkCustomField::VALUE": The value of the custom field.
"Sub::BulkSigner::DESCRIPTION": |-
Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value.
"Sub::CC::DESCRIPTION": Add CC email recipients. Required when a CC role exists for the Template.
"Sub::CC::EMAIL_ADDRESS": The email address of the CC recipient.
"Sub::CC::ROLE": Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.
"Sub::CustomField::DESCRIPTION": |-
When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
"Sub::CustomField::EDITOR": |-
Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.
**Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
"Sub::CustomField::NAME": The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
"Sub::CustomField::REQUIRED": Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
"Sub::CustomField::TEMPLATE": An array defining values and options for custom fields. Required when a custom field exists in the Template.
"Sub::CustomField::VALUE": The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.
"Sub::EditorOptions::DESCRIPTION": This allows the requester to specify editor options when a preparing a document
"Sub::EditorOptions::ALLOW_EDIT_DOCUMENTS": Allows requesters to edit documents, including delete and add
"Sub::EditorOptions::ALLOW_EDIT_SIGNERS": Allows requesters to edit the list of signers
"Sub::FieldOptions::DESCRIPTION": This allows the requester to specify field options for a signature request.
"Sub::FieldOptions::DATE_FORMAT": |-
Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
**Note**: Only available for Premium and higher.
"Sub::FormFieldGroup::DESCRIPTION": Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
"Sub::FormFieldGroup::GROUP_ID_LABEL": ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`.
"Sub::FormFieldGroup::GROUP_LABEL": Name of the group
"Sub::FormFieldGroup::REQUIREMENT": |-
Examples: `require_0-1` `require_1` `require_1-ormore`
- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).
- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).
- Radio groups require **at least** two fields per group.
"Sub::FormFieldRule::DESCRIPTION": Conditional Logic rules for fields defined in `form_fields_per_document`.
"Sub::FormFieldRule::ID": Must be unique across all defined rules.
"Sub::FormFieldRule::TRIGGER_OPERATOR": Currently only `AND` is supported. Support for `OR` is being worked on.
"Sub::FormFieldRuleAction::DESCRIPTION": An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule.
"Sub::FormFieldRuleAction::FIELD_ID": |-
**field_id** or **group_id** is required, but not both.
Must reference the `api_id` of an existing field defined within `form_fields_per_document`.
Cannot use with `group_id`. Trigger and action fields must belong to the same signer.
"Sub::FormFieldRuleAction::GROUP_ID": |-
**group_id** or **field_id** is required, but not both.
Must reference the ID of an existing group defined within `form_field_groups`.
Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.
"Sub::FormFieldRuleAction::HIDDEN": "`true` to hide the target field when rule is satisfied, otherwise `false`."
"Sub::FormFieldRuleAction::TYPE": |-
- `change-field-visibility` if `field_id` used.
- `change-group-visibility` if `group_id` used.
"Sub::FormFieldRuleTrigger::DESCRIPTION": An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed.
"Sub::FormFieldRuleTrigger::ID": Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.
"Sub::FormFieldRuleTrigger::OPERATOR": |-
Different field types allow different `operator` values:
- Field type of **text**:
- **is**: exact match
- **not**: not exact match
- **match**: regular expression, without /. Example:
- OK `[a-zA-Z0-9]`
- Not OK `/[a-zA-Z0-9]/`
- Field type of **dropdown**:
- **is**: exact match, single value
- **not**: not exact match, single value
- **any**: exact match, array of values.
- **none**: not exact match, array of values.
- Field type of **checkbox**:
- **is**: exact match, single value
- **not**: not exact match, single value
- Field type of **radio**:
- **is**: exact match, single value
- **not**: not exact match, single value
"Sub::FormFieldRuleTrigger::VALUE_SINGLE": |-
**value** or **values** is required, but not both.
The value to match against **operator**.
- When **operator** is one of the following, **value** must be `String`:
- `is`
- `not`
- `match`
Otherwise,
- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`
- **radio**: When **type** of trigger is **radio**, **value** must be `1`
"Sub::FormFieldRuleTrigger::VALUE_MULTI": |-
**values** or **value** is required, but not both.
The values to match against **operator** when it is one of the following:
- `any`
- `none`
"Sub::FormFieldsPerDocument::DESCRIPTION": |-
The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
* Radio Field use `SubFormFieldsPerDocumentRadio`
* Signature Field use `SubFormFieldsPerDocumentSignature`
* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
* Initials Field use `SubFormFieldsPerDocumentInitials`
* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
"Sub::FormFieldsPerDocument::DESCRIPTION_EXTENDS": This class extends `SubFormFieldsPerDocumentBase`.
"Sub::FormFieldsPerDocument::API_ID": An identifier for the field that is unique across all documents in the request.
"Sub::FormFieldsPerDocument::AUTO_FILL_TYPE": Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.
"Sub::FormFieldsPerDocument::LINK_ID": Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.
"Sub::FormFieldsPerDocument::IS_CHECKED_CHECKBOX": "`true` for checking the checkbox field by default, otherwise `false`."
"Sub::FormFieldsPerDocument::IS_CHECKED_RADIO": "`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`."
"Sub::FormFieldsPerDocument::CONTENT_DROPDOWN": Selected value in `options` array. Value must exist in array.
"Sub::FormFieldsPerDocument::CONTENT_HYPERLINK": Link Text.
"Sub::FormFieldsPerDocument::CONTENT_URL": Link URL.
"Sub::FormFieldsPerDocument::DOCUMENT_INDEX": Represents the integer index of the `file` or `file_url` document the field should be attached to.
"Sub::FormFieldsPerDocument::GROUP": String referencing group defined in `form_field_groups` parameter.
"Sub::FormFieldsPerDocument::HEIGHT": Size of the field in pixels.
"Sub::FormFieldsPerDocument::MASKED": Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.
"Sub::FormFieldsPerDocument::NAME": Display name for the field.
"Sub::FormFieldsPerDocument::OPTIONS": Array of string values representing dropdown values.
"Sub::FormFieldsPerDocument::PAGE": |-
Page in the document where the field should be placed (requires documents be PDF files).
- When the page number parameter is supplied, the API will use the new coordinate system.
- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
"Sub::FormFieldsPerDocument::PLACEHOLDER": Placeholder value for text field.
"Sub::FormFieldsPerDocument::REQUIRED": Whether this field is required.
"Sub::FormFieldsPerDocument::SIGNER": |-
Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
"Sub::FormFieldsPerDocument::TYPE": One of the [Type](/api/reference/constants/#field-types) options.
"Sub::FormFieldsPerDocument::TYPE_CHECKBOX": A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.
"Sub::FormFieldsPerDocument::TYPE_CHECKBOX_MERGE": A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.
"Sub::FormFieldsPerDocument::TYPE_DATE_SIGNED": A date. Use the `SubFormFieldsPerDocumentDateSigned` class.
"Sub::FormFieldsPerDocument::TYPE_DROPDOWN": An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.
"Sub::FormFieldsPerDocument::TYPE_HYPERLINK": A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.
"Sub::FormFieldsPerDocument::TYPE_INITIALS": An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.
"Sub::FormFieldsPerDocument::TYPE_RADIO": An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.
"Sub::FormFieldsPerDocument::TYPE_SIGNATURE": A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.
"Sub::FormFieldsPerDocument::TYPE_TEXT": A text input field. Use the `SubFormFieldsPerDocumentText` class.
"Sub::FormFieldsPerDocument::TYPE_TEXT_MERGE": A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.
"Sub::FormFieldsPerDocument::VALIDATION_TYPE": |-
Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.
**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
"Sub::FormFieldsPerDocument::WIDTH": Size of the field in pixels.
"Sub::FormFieldsPerDocument::X": Location coordinates of the field in pixels.
"Sub::FormFieldsPerDocument::Y": Location coordinates of the field in pixels.
"Sub::SignatureRequestGroupedSigners::DESCRIPTION": |-
Add Grouped Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both.
"Sub::SignatureRequestGroupedSigners::GROUP_NAME": The name of the group.
"Sub::SignatureRequestGroupedSigners::ORDER": The order the group is required to sign in. Use this instead of Signer-level `order`.
"Sub::SignatureRequestGroupedSigners::SIGNERS": |-
Signers belonging to this Group.
**NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
"Sub::MergeField::NAME": The name of the merge field. Must be unique.
"Sub::MergeField::TYPE": The type of merge field.
"Sub::MergeField::EnumDescriptions::TEXT": Sets merge [field type](/api/reference/constants/#field-types) to `text`.
"Sub::MergeField::EnumDescriptions::CHECKBOX": Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`.
"Sub::Metadata::DESCRIPTION": |-
Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
"Sub::OAuth::CALLBACK_URL": The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)
"Sub::OAuth::DESCRIPTION": OAuth related parameters.
"Sub::OAuth::SCOPES": A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).
"Sub::Options::CAN_INSERT_EVERYWHERE": Determines if signers can use "Insert Everywhere" when signing a document.
"Sub::Options::DESCRIPTION": Additional options supported by API App.
"Sub::SignatureRequestSigner::DESCRIPTION": |-
Add Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both.
"Sub::SignatureRequestSigner::SIGNER_EMAIL_ADDRESS": The email address of the signer.
"Sub::SignatureRequestSigner::SIGNER_NAME": The name of the signer.
"Sub::SignatureRequestSigner::SIGNER_ORDER": The order the signer is required to sign in.
"Sub::SignatureRequestSigner::SIGNER_PIN": The 4- to 12-character access code that will secure this signer's signature page.
"Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER": |-
An E.164 formatted phone number.
**Note**: Not available in test mode and requires a Standard plan or higher.
"Sub::SignatureRequestSigner::SIGNER_SMS_PHONE_NUMBER_TYPE": |-
Specifies the feature used with the `sms_phone_number`. Default `authentication`.
If `authentication`, signer is sent a verification code via SMS that is required to access the document.
If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).
"Sub::SignatureRequestTemplateSigner::DESCRIPTION": Add Signers to your Templated-based Signature Request.
"Sub::SignatureRequestTemplateSigner::EMAIL_ADDRESS": The email address of the signer.