Dropbox Sign (HelloSign) Unclaimed Draft API
{'$ref': './markdown/en/tags/unclaimed-draft-tag-description.md'}
OpenAPI Specification
openapi: 3.0.3
info:
title: Dropbox Sign Account Unclaimed Draft API
description: Dropbox Sign v3 API
termsOfService: https://www.hellosign.com/terms
contact:
email: apisupport@hellosign.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: 3.0.0
servers:
- url: https://api.hellosign.com/v3
security:
- api_key: []
- oauth2:
- account_access
- signature_request_access
- template_access
- team_access
- api_app_access
- basic_account_info
- request_signature
tags:
- name: Unclaimed Draft
description:
$ref: ./markdown/en/tags/unclaimed-draft-tag-description.md
paths:
/unclaimed_draft/create:
post:
tags:
- Unclaimed Draft
summary: Create Unclaimed Draft
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.
operationId: unclaimedDraftCreate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateRequest'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftCreateRequest'
form_fields_per_document_example:
$ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument'
form_field_groups_example:
$ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups'
form_field_rules_example:
$ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules'
multipart/form-data:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftCreateResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
- oauth2:
- signature_request_access
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/UnclaimedDraftCreateExample.php
- lang: C#
label: C#
source:
$ref: examples/UnclaimedDraftCreateExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/UnclaimedDraftCreateExample.ts
- lang: Java
label: Java
source:
$ref: examples/UnclaimedDraftCreateExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/UnclaimedDraftCreateExample.rb
- lang: Python
label: Python
source:
$ref: examples/UnclaimedDraftCreateExample.py
- lang: cURL
label: cURL
source:
$ref: examples/UnclaimedDraftCreateExample.sh
x-meta:
seo:
title: Create Unclaimed Draft | REST API | Dropbox Sign for Developers
description: The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.
/unclaimed_draft/create_embedded:
post:
tags:
- Unclaimed Draft
summary: Create Embedded Unclaimed Draft
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.'
operationId: unclaimedDraftCreateEmbedded
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest'
form_fields_per_document_example:
$ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument'
form_field_groups_example:
$ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups'
form_field_rules_example:
$ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules'
multipart/form-data:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
- oauth2:
- request_signature
- signature_request_access
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/UnclaimedDraftCreateEmbeddedExample.php
- lang: C#
label: C#
source:
$ref: examples/UnclaimedDraftCreateEmbeddedExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/UnclaimedDraftCreateEmbeddedExample.ts
- lang: Java
label: Java
source:
$ref: examples/UnclaimedDraftCreateEmbeddedExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/UnclaimedDraftCreateEmbeddedExample.rb
- lang: Python
label: Python
source:
$ref: examples/UnclaimedDraftCreateEmbeddedExample.py
- lang: cURL
label: cURL
source:
$ref: examples/UnclaimedDraftCreateEmbeddedExample.sh
x-meta:
seo:
title: Create Embedded Unclaimed Draft | Dropbox Sign for Developers
description: The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.
/unclaimed_draft/create_embedded_with_template:
post:
tags:
- Unclaimed Draft
summary: Create Embedded Unclaimed Draft with Template
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.'
operationId: unclaimedDraftCreateEmbeddedWithTemplate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
- oauth2:
- signature_request_access
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php
- lang: C#
label: C#
source:
$ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts
- lang: Java
label: Java
source:
$ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb
- lang: Python
label: Python
source:
$ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py
- lang: cURL
label: cURL
source:
$ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh
x-meta:
seo:
title: Embed Unclaimed Draft with Template | Dropbox Sign for Developers
description: The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.
/unclaimed_draft/edit_and_resend/{signature_request_id}:
post:
tags:
- Unclaimed Draft
summary: Edit and Resend Unclaimed Draft
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.'
operationId: unclaimedDraftEditAndResend
parameters:
- name: signature_request_id
in: path
description: The ID of the signature request to edit and resend.
required: true
schema:
type: string
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftEditAndResendRequest'
responses:
'200':
description: successful operation
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
example:
$ref: '#/components/examples/UnclaimedDraftEditAndResend'
4XX:
description: failed_operation
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
400_example:
$ref: '#/components/examples/Error400Response'
401_example:
$ref: '#/components/examples/Error401Response'
402_example:
$ref: '#/components/examples/Error402Response'
403_example:
$ref: '#/components/examples/Error403Response'
429_example:
$ref: '#/components/examples/Error429Response'
404_example:
$ref: '#/components/examples/Error404Response'
409_example:
$ref: '#/components/examples/Error409Response'
410_example:
$ref: '#/components/examples/Error410Response'
4XX_example:
$ref: '#/components/examples/Error4XXResponse'
security:
- api_key: []
- oauth2:
- request_signature
- signature_request_access
x-codeSamples:
- lang: PHP
label: PHP
source:
$ref: examples/UnclaimedDraftEditAndResendExample.php
- lang: C#
label: C#
source:
$ref: examples/UnclaimedDraftEditAndResendExample.cs
- lang: TypeScript
label: TypeScript
source:
$ref: examples/UnclaimedDraftEditAndResendExample.ts
- lang: Java
label: Java
source:
$ref: examples/UnclaimedDraftEditAndResendExample.java
- lang: Ruby
label: Ruby
source:
$ref: examples/UnclaimedDraftEditAndResendExample.rb
- lang: Python
label: Python
source:
$ref: examples/UnclaimedDraftEditAndResendExample.py
- lang: cURL
label: cURL
source:
$ref: examples/UnclaimedDraftEditAndResendExample.sh
x-meta:
seo:
title: Edit and Resend Unclaimed Draft | Dropbox Sign for Developers
description: The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.
components:
examples:
Error410Response:
summary: Error 410 deleted
value:
$ref: examples/json/Error410Response.json
UnclaimedDraftCreateEmbeddedRequestFormFieldGroups:
summary: Form Fields Per Document and Groups Example
value:
$ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json
UnclaimedDraftEditAndResend:
summary: Unclaimed Draft Edit and Resend
value:
$ref: examples/json/UnclaimedDraftEditAndResend.json
UnclaimedDraftCreateEmbeddedRequestFormFieldRules:
summary: Form Fields Per Document and Rules Example
value:
$ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json
Error401Response:
summary: Error 401 unauthorized
value:
$ref: examples/json/Error401Response.json
UnclaimedDraftCreateEmbeddedRequest:
summary: Default Example
value:
$ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json
UnclaimedDraftCreateEmbeddedWithTemplateResponse:
summary: Unclaimed Draft Create Embedded With Template
value:
$ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json
UnclaimedDraftCreateRequestFormFieldsPerDocument:
summary: Form Fields Per Document Example
value:
$ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json
UnclaimedDraftCreateEmbeddedWithTemplateRequest:
summary: Default Example
value:
$ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json
UnclaimedDraftCreateRequestFormFieldGroups:
summary: Form Fields Per Document and Groups Example
value:
$ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json
UnclaimedDraftCreateResponse:
summary: Unclaimed Draft Create
value:
$ref: examples/json/UnclaimedDraftCreateResponse.json
UnclaimedDraftCreateRequestFormFieldRules:
summary: Form Fields Per Document and Rules Example
value:
$ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json
Error409Response:
summary: Error 409 conflict
value:
$ref: examples/json/Error409Response.json
Error400Response:
summary: Error 400 bad_request
value:
$ref: examples/json/Error400Response.json
UnclaimedDraftCreateEmbeddedResponse:
summary: Unclaimed Draft Create Embedded
value:
$ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json
Error402Response:
summary: Error 402 payment_required
value:
$ref: examples/json/Error402Response.json
Error4XXResponse:
summary: Error 4XX failed_operation
value:
$ref: examples/json/Error4XXResponse.json
Error404Response:
summary: Error 404 not_found
value:
$ref: examples/json/Error404Response.json
UnclaimedDraftEditAndResendRequest:
summary: Default Example
value:
$ref: examples/json/UnclaimedDraftEditAndResendRequest.json
Error403Response:
summary: Error 403 forbidden
value:
$ref: examples/json/Error403Response.json
UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument:
summary: Form Fields Per Document Example
value:
$ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json
Error429Response:
summary: Error 429 exceeded_rate
value:
$ref: examples/json/Error429Response.json
UnclaimedDraftCreateRequest:
summary: Default Example
value:
$ref: examples/json/UnclaimedDraftCreateRequest.json
schemas:
SubFormFieldRuleTrigger:
required:
- id
- operator
properties:
id:
description: 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.
type: string
operator:
description: "Different field types allow different `operator` values:\n- Field type of **text**:\n - **is**: exact match\n - **not**: not exact match\n - **match**: regular expression, without /. Example:\n - OK `[a-zA-Z0-9]`\n - Not OK `/[a-zA-Z0-9]/`\n- Field type of **dropdown**:\n - **is**: exact match, single value\n - **not**: not exact match, single value\n - **any**: exact match, array of values.\n - **none**: not exact match, array of values.\n- Field type of **checkbox**:\n - **is**: exact match, single value\n - **not**: not exact match, single value\n- Field type of **radio**:\n - **is**: exact match, single value\n - **not**: not exact match, single value"
type: string
enum:
- any
- is
- match
- none
- not
value:
description: "**value** or **values** is required, but not both.\n\nThe value to match against **operator**.\n\n- When **operator** is one of the following, **value** must be `String`:\n - `is`\n - `not`\n - `match`\n\nOtherwise,\n- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`\n- **radio**: When **type** of trigger is **radio**, **value** must be `1`"
type: string
values:
description: '**values** or **value** is required, but not both.
The values to match against **operator** when it is one of the following:
- `any`
- `none`'
type: array
items:
type: string
type: object
UnclaimedDraftEditAndResendRequest:
required:
- client_id
properties:
client_id:
description: Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
type: string
editor_options:
$ref: '#/components/schemas/SubEditorOptions'
is_for_embedded_signing:
description: The request created from this draft will also be signable in embedded mode if set to `true`.
type: boolean
requester_email_address:
description: 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.
type: string
format: email
requesting_redirect_url:
description: The URL you want signers redirected to after they successfully request a signature.
type: string
show_progress_stepper:
description: When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
type: boolean
default: true
signing_redirect_url:
description: The URL you want signers redirected to after they successfully sign.
type: string
test_mode:
description: Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
type: boolean
default: false
type: object
SubCustomField:
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.'
required:
- name
properties:
editor:
description: '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.'
type: string
name:
description: 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.
type: string
required:
description: 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`.
type: boolean
default: false
value:
description: The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.
type: string
type: object
SubFormFieldsPerDocumentBase:
description: 'The fields that should appear on the document, expressed as an array of objects. (For more details 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`'
required:
- document_index
- api_id
- type
- required
- signer
- width
- height
- x
- y
properties:
document_index:
description: Represents the integer index of the `file` or `file_url` document the field should be attached to.
type: integer
api_id:
description: An identifier for the field that is unique across all documents in the request.
type: string
height:
description: Size of the field in pixels.
type: integer
name:
description: Display name for the field.
type: string
page:
description: '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.'
type: integer
nullable: true
required:
description: Whether this field is required.
type: boolean
signer:
description: 'Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.'
type: string
x-int-or-string: true
type:
type: string
width:
description: Size of the field in pixels.
type: integer
x:
description: Location coordinates of the field in pixels.
type: integer
y:
description: Location coordinates of the field in pixels.
type: integer
type: object
discriminator:
propertyName: type
mapping:
text: '#/components/schemas/SubFormFieldsPerDocumentText'
dropdown: '#/components/schemas/SubFormFieldsPerDocumentDropdown'
hyperlink: '#/components/schemas/SubFormFieldsPerDocumentHyperlink'
checkbox: '#/components/schemas/SubFormFieldsPerDocumentCheckbox'
radio: '#/components/schemas/SubFormFieldsPerDocumentRadio'
signature: '#/components/schemas/SubFormFieldsPerDocumentSignature'
date_signed: '#/components/schemas/SubFormFieldsPerDocumentDateSigned'
initials: '#/components/schemas/SubFormFieldsPerDocumentInitials'
text-merge: '#/components/schemas/SubFormFieldsPerDocumentTextMerge'
checkbox-merge: '#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge'
x-internal-class: true
x-base-class: true
UnclaimedDraftCreateRequest:
description: ''
required:
- type
properties:
files:
description: 'Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both.'
type: array
items:
type: string
format: binary
file_urls:
description: '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.'
type: array
items:
type: string
allow_decline:
description: Allows signers to decline to sign a document if `true`. Defaults to `false`.
type: boolean
default: false
attachments:
description: A list describing the attachments
type: array
items:
$ref: '#/components/schemas/SubAttachment'
cc_email_addresses:
description: The email addresses that should be CCed.
type: array
items:
type: string
format: email
client_id:
description: Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
type: string
custom_fields:
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 `cust
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hellosign/refs/heads/main/openapi/hellosign-unclaimed-draft-api-openapi.yml