Dropbox Sign

Electronic signature API

developers.hellosign.com ↗

Version

3.0.0

OpenAPI

3.0.3

Endpoints

Schemas

182

83

Quality

Updated

3 days ago

Documents documents signatures legal

Use this API in your AI agent

Query structured spec data via REST or MCP. Get exactly what your agent needs.

Get API Key

Server URLs

https://api.hellosign.com/v3

Endpoints

Clear filters

GET POST PUT PATCH DELETE

Account 2 endpoints

POST /account/create Create Account

Creates a new Dropbox Sign Account that is associated with the specified email_address.

operationId: Account_createNew

Request Body

required

application/json

schema AccountCreateRequest

Property	Type	Required
locale	string	optional
client_id	string	optional
client_secret	string	optional
email_address	string	required

Responses

4XX

failed_operation

200

successful operation

POST /account/create

POST /account/verify Verify Account

Verifies whether an Dropbox Sign Account exists for the given email address.

operationId: Account_verifyEmailExists

Request Body

required

application/json

schema AccountVerifyRequest

Property	Type	Required
email_address	string	required

Responses

4XX

failed_operation

200

successful operation

POST /account/verify

Apiapp 1 endpoints

POST /api_app Create API App

Creates a new API App.

operationId: ApiApp_createNew

Request Body

required

application/json

schema ApiAppCreateRequest

Property	Type	Required
name	string	required
oauth	object	optional
└ scopes	array	optional
└ callback_url	string	optional
domains	array	required
options	object	optional
└ can_insert_everywhere	boolean	optional
callback_url	string	optional
custom_logo_file	string	optional
white_labeling_options	object	optional
└ link_color	string	optional
└ text_color1	string	optional
└ text_color2	string	optional
└ legal_version	string	optional
└ reset_to_default	boolean	optional
└ primary_button_color	string	optional
└ page_background_color	string	optional
└ secondary_button_color	string	optional
└ header_background_color	string	optional
└ primary_button_text_color	string	optional
└ primary_button_color_hover	string	optional
└ secondary_button_text_color	string	optional
└ secondary_button_color_hover	string	optional
└ primary_button_text_color_hover	string	optional
└ secondary_button_text_color_hover	string	optional

multipart/form-data

schema ApiAppCreateRequest

Property	Type	Required
name	string	required
oauth	object	optional
└ scopes	array	optional
└ callback_url	string	optional
domains	array	required
options	object	optional
└ can_insert_everywhere	boolean	optional
callback_url	string	optional
custom_logo_file	string	optional
white_labeling_options	object	optional
└ link_color	string	optional
└ text_color1	string	optional
└ text_color2	string	optional
└ legal_version	string	optional
└ reset_to_default	boolean	optional
└ primary_button_color	string	optional
└ page_background_color	string	optional
└ secondary_button_color	string	optional
└ header_background_color	string	optional
└ primary_button_text_color	string	optional
└ primary_button_color_hover	string	optional
└ secondary_button_text_color	string	optional
└ secondary_button_color_hover	string	optional
└ primary_button_text_color_hover	string	optional
└ secondary_button_text_color_hover	string	optional

Responses

4XX

failed_operation

201

successful operation

POST /api_app

Embedded 1 endpoints

POST /embedded/edit_url/{template_id} Get Embedded Template Edit URL

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.

operationId: Embedded_templateEditUrl

Parameters

Name	In	Required	Type	Description
template_id	path	required	string	The id of the template to edit.

Request Body

required

application/json

schema EmbeddedEditUrlRequest

Property	Type	Required
cc_roles	array	optional
test_mode	boolean	optional
merge_fields	array	optional
└ name	string	required
└ type	string	required
preview_only	boolean	optional
show_preview	boolean	optional
allow_edit_ccs	boolean	optional
editor_options	object	optional
└ allow_edit_signers	boolean	optional
└ allow_edit_documents	boolean	optional
force_signer_roles	boolean	optional
force_subject_message	boolean	optional
show_progress_stepper	boolean	optional

Responses

4XX

failed_operation

200

successful operation

POST /embedded/edit_url/{template_id}

Oauth 2 endpoints

POST /oauth/token OAuth Token Generate

Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.

operationId: OAuth_exchangeCodeForToken

Request Body

required

application/json

schema OAuthTokenGenerateRequest

Property	Type	Required
code	string	required
state	string	required
client_id	string	required
grant_type	string	required
client_secret	string	required

Responses

200

successful operation

POST /oauth/token

POST /oauth/token?refresh OAuth Token Refresh

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.

operationId: OAuth_tokenRefreshPost

Request Body

required

application/json

schema OAuthTokenRefreshRequest

Property	Type	Required
grant_type	string	required
refresh_token	string	required

Responses

200

successful operation

POST /oauth/token?refresh

Report 1 endpoints

POST /report/create Create Report

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.

operationId: Report_generateEmailLink

Request Body

required

application/json

schema ReportCreateRequest

Property	Type	Required
end_date	string	required
start_date	string	required
report_type	array	required

Responses

4XX

failed_operation

200

successful operation

POST /report/create

Signaturerequest 11 endpoints

POST /signature_request/bulk_create_embedded_with_template Embedded Bulk Send with Template

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.

operationId: SignatureRequest_bulkCreateEmbeddedWithTemplate

Request Body

required

application/json

schema SignatureRequestBulkCreateEmbeddedWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
title	string	optional
message	string	optional
subject	string	optional
metadata	object	optional
client_id	string	required
test_mode	boolean	optional
signer_file	string	optional
signer_list	array	optional
└ signers	array	optional
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
└ custom_fields	array	optional
└ name	string	required
└ value	string	required
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_redirect_url	string	optional

multipart/form-data

schema SignatureRequestBulkCreateEmbeddedWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
title	string	optional
message	string	optional
subject	string	optional
metadata	object	optional
client_id	string	required
test_mode	boolean	optional
signer_file	string	optional
signer_list	array	optional
└ signers	array	optional
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
└ custom_fields	array	optional
└ name	string	required
└ value	string	required
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_redirect_url	string	optional

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/bulk_create_embedded_with_template

POST /signature_request/bulk_send_with_template Bulk Send with Template

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.

operationId: SignatureRequest_bulkSendWithTemplate

Request Body

required

application/json

schema SignatureRequestBulkSendWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
title	string	optional
message	string	optional
subject	string	optional
metadata	object	optional
client_id	string	optional
test_mode	boolean	optional
signer_file	string	optional
signer_list	array	optional
└ signers	array	optional
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
└ custom_fields	array	optional
└ name	string	required
└ value	string	required
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_redirect_url	string	optional

multipart/form-data

schema SignatureRequestBulkSendWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
title	string	optional
message	string	optional
subject	string	optional
metadata	object	optional
client_id	string	optional
test_mode	boolean	optional
signer_file	string	optional
signer_list	array	optional
└ signers	array	optional
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
└ custom_fields	array	optional
└ name	string	required
└ value	string	required
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_redirect_url	string	optional

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/bulk_send_with_template

POST /signature_request/cancel/{signature_request_id} Cancel Incomplete Signature Request

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 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 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].

operationId: SignatureRequest_cancelIncomplete

Parameters

Name	In	Required	Type	Description
signature_request_id	path	required	string	The id of the incomplete SignatureRequest to cancel.

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/cancel/{signature_request_id}

POST /signature_request/create_embedded Create Embedded Signature Request

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. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

operationId: SignatureRequest_createEmbedded

Request Body

required

application/json

schema SignatureRequestCreateEmbeddedRequest

Property	Type	Required
files	array	optional
title	string	optional
message	string	optional
signers	array	optional
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
allow_reassign	boolean	optional
hide_text_tags	boolean	optional
grouped_signers	array	optional
└ group	string	required
└ order	integer	optional
└ signers	array	required
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
…4 more	object	optional

multipart/form-data

schema SignatureRequestCreateEmbeddedRequest

Property	Type	Required
files	array	optional
title	string	optional
message	string	optional
signers	array	optional
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
allow_reassign	boolean	optional
hide_text_tags	boolean	optional
grouped_signers	array	optional
└ group	string	required
└ order	integer	optional
└ signers	array	required
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
…4 more	object	optional

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/create_embedded

POST /signature_request/create_embedded_with_template Create Embedded Signature Request with Template

Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

operationId: SignatureRequest_createEmbeddedWithTemplate

Request Body

required

application/json

schema SignatureRequestCreateEmbeddedWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
files	array	optional
title	string	optional
message	string	optional
signers	array	required
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
populate_auto_fill_fields	boolean	optional

multipart/form-data

schema SignatureRequestCreateEmbeddedWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
files	array	optional
title	string	optional
message	string	optional
signers	array	required
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
populate_auto_fill_fields	boolean	optional

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/create_embedded_with_template

POST /signature_request/release_hold/{signature_request_id} Release On-Hold Signature Request

Releases a held SignatureRequest that was claimed and prepared from an UnclaimedDraft. 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.

operationId: SignatureRequest_releaseHold

Parameters

Name	In	Required	Type	Description
signature_request_id	path	required	string	The id of the SignatureRequest to release.

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/release_hold/{signature_request_id}

POST /signature_request/remind/{signature_request_id} Send Request Reminder

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.

operationId: SignatureRequest_sendReminder

Parameters

Name	In	Required	Type	Description
signature_request_id	path	required	string	The id of the SignatureRequest to send a reminder for.

Request Body

required

application/json

schema SignatureRequestRemindRequest

Property	Type	Required
name	string	optional
email_address	string	required

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/remind/{signature_request_id}

POST /signature_request/remove/{signature_request_id} Remove Signature Request Access

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.

operationId: SignatureRequest_removeAccess

Parameters

Name	In	Required	Type	Description
signature_request_id	path	required	string	The id of the SignatureRequest to remove.

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/remove/{signature_request_id}

POST /signature_request/send Send Signature Request

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.

operationId: SignatureRequest_createAndSend

Request Body

required

application/json

schema SignatureRequestSendRequest

Property	Type	Required
files	array	optional
title	string	optional
is_eid	boolean	optional
message	string	optional
signers	array	optional
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
allow_reassign	boolean	optional
hide_text_tags	boolean	optional
grouped_signers	array	optional
└ group	string	required
└ order	integer	optional
└ signers	array	required
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
…5 more	object	optional

multipart/form-data

schema SignatureRequestSendRequest

Property	Type	Required
files	array	optional
title	string	optional
is_eid	boolean	optional
message	string	optional
signers	array	optional
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
allow_reassign	boolean	optional
hide_text_tags	boolean	optional
grouped_signers	array	optional
└ group	string	required
└ order	integer	optional
└ signers	array	required
└ pin	string	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
…5 more	object	optional

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/send

POST /signature_request/send_with_template Send with Template

Creates and sends a new SignatureRequest based off of the Template(s) specified with the template_ids parameter.

operationId: SignatureRequest_createAndSendWithTemplate

Request Body

required

application/json

schema SignatureRequestSendWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
files	array	optional
title	string	optional
is_eid	boolean	optional
message	string	optional
signers	array	required
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
signing_redirect_url	string	optional

multipart/form-data

schema SignatureRequestSendWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
files	array	optional
title	string	optional
is_eid	boolean	optional
message	string	optional
signers	array	required
└ pin	string	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
└ sms_phone_number	string	optional
└ sms_phone_number_type	string	optional
subject	string	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
signing_redirect_url	string	optional

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/send_with_template

POST /signature_request/update/{signature_request_id} Update Signature Request

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.

Updating the email address of a signer will generate a new signature_id value.

NOTE: This action cannot be performed on a signature request with an appended signature page.

operationId: SignatureRequest_updateSignerDetails

Parameters

Name	In	Required	Type	Description
signature_request_id	path	required	string	The id of the SignatureRequest to update.

Request Body

required

application/json

schema SignatureRequestUpdateRequest

Property	Type	Required
name	string	optional
expires_at	integer	optional
signature_id	string	required
email_address	string	optional

Responses

4XX

failed_operation

200

successful operation

POST /signature_request/update/{signature_request_id}

Team 2 endpoints

POST /team/create Create Team

Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.

operationId: Team_createNewTeam

Request Body

required

application/json

schema TeamCreateRequest

Property	Type	Required
name	string	optional

Responses

4XX

failed_operation

200

successful operation

POST /team/create

POST /team/remove_member Remove User from Team

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.

operationId: Team_removeMember

Request Body

required

application/json

schema TeamRemoveMemberRequest

Property	Type	Required
new_role	string	optional
account_id	string	optional
new_team_id	string	optional
email_address	string	optional
new_owner_email_address	string	optional

Responses

4XX

failed_operation

201

successful operation

POST /team/remove_member

Template 6 endpoints

POST /template/add_user/{template_id} Add User to Template

Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.

operationId: Template_addUserToTemplate

Parameters

Name	In	Required	Type	Description
template_id	path	required	string	The id of the Template to give the Account access to.

Request Body

required

application/json

schema TemplateAddUserRequest

Property	Type	Required
account_id	string	optional
email_address	string	optional
skip_notification	boolean	optional

Responses

4XX

failed_operation

200

successful operation

POST /template/add_user/{template_id}

POST /template/create Create Template

Creates a template that can then be used.

operationId: Template_createTemplate

Request Body

required

application/json

schema TemplateCreateRequest

Property	Type	Required
files	array	optional
title	string	optional
message	string	optional
subject	string	optional
cc_roles	array	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
merge_fields	array	optional
└ name	string	required
└ type	string	required
signer_roles	array	required
└ name	string	optional
└ order	integer	optional
field_options	object	optional
└ date_format	string	required
allow_reassign	boolean	optional
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
form_field_groups	array	optional
└ group_id	string	required
└ group_label	string	required
└ requirement	string	required
use_preexisting_fields	boolean	optional
form_fields_per_document	array	required
└ x	integer	required
└ y	integer	required
└ name	string	optional
└ page	integer	optional
└ type	string	required
└ width	integer	required
└ api_id	string	required
└ height	integer	required
└ signer	string	required
└ required	boolean	required
└ document_index	integer	required

multipart/form-data

schema TemplateCreateRequest

Property	Type	Required
files	array	optional
title	string	optional
message	string	optional
subject	string	optional
cc_roles	array	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
merge_fields	array	optional
└ name	string	required
└ type	string	required
signer_roles	array	required
└ name	string	optional
└ order	integer	optional
field_options	object	optional
└ date_format	string	required
allow_reassign	boolean	optional
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
form_field_groups	array	optional
└ group_id	string	required
└ group_label	string	required
└ requirement	string	required
use_preexisting_fields	boolean	optional
form_fields_per_document	array	required
└ x	integer	required
└ y	integer	required
└ name	string	optional
└ page	integer	optional
└ type	string	required
└ width	integer	required
└ api_id	string	required
└ height	integer	required
└ signer	string	required
└ required	boolean	required
└ document_index	integer	required

Responses

4XX

failed_operation

200

successful operation

POST /template/create

POST /template/create_embedded_draft Create Embedded Template Draft

The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ‘edit’ stage.

operationId: Template_createEmbeddedDraft

Request Body

required

application/json

schema TemplateCreateEmbeddedDraftRequest

Property	Type	Required
files	array	optional
title	string	optional
message	string	optional
subject	string	optional
cc_roles	array	optional
metadata	object	optional
allow_ccs	boolean	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
skip_me_now	boolean	optional
merge_fields	array	optional
└ name	string	required
└ type	string	required
show_preview	boolean	optional
signer_roles	array	optional
└ name	string	optional
└ order	integer	optional
field_options	object	optional
└ date_format	string	required
allow_reassign	boolean	optional
editor_options	object	optional
└ allow_edit_signers	boolean	optional
└ allow_edit_documents	boolean	optional
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
form_field_groups	array	optional
└ group_id	string	required
└ group_label	string	required
└ requirement	string	required
…5 more	object	optional

multipart/form-data

schema TemplateCreateEmbeddedDraftRequest

Property	Type	Required
files	array	optional
title	string	optional
message	string	optional
subject	string	optional
cc_roles	array	optional
metadata	object	optional
allow_ccs	boolean	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
skip_me_now	boolean	optional
merge_fields	array	optional
└ name	string	required
└ type	string	required
show_preview	boolean	optional
signer_roles	array	optional
└ name	string	optional
└ order	integer	optional
field_options	object	optional
└ date_format	string	required
allow_reassign	boolean	optional
editor_options	object	optional
└ allow_edit_signers	boolean	optional
└ allow_edit_documents	boolean	optional
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
form_field_groups	array	optional
└ group_id	string	required
└ group_label	string	required
└ requirement	string	required
…5 more	object	optional

Responses

4XX

failed_operation

200

successful operation

POST /template/create_embedded_draft

POST /template/delete/{template_id} Delete Template

Completely deletes the template specified from the account.

operationId: Template_completelyDelete

Parameters

Name	In	Required	Type	Description
template_id	path	required	string	The id of the Template to delete.

Responses

4XX

failed_operation

200

successful operation

POST /template/delete/{template_id}

POST /template/remove_user/{template_id} Remove User from Template

Removes the specified Account’s access to the specified Template.

operationId: Template_removeUser

Parameters

Name	In	Required	Type	Description
template_id	path	required	string	The id of the Template to remove the Account’s access to.

Request Body

required

application/json

schema TemplateRemoveUserRequest

Property	Type	Required
account_id	string	optional
email_address	string	optional

Responses

4XX

failed_operation

200

successful operation

POST /template/remove_user/{template_id}

POST /template/update_files/{template_id} Update Template Files

Overlays a new file with the overlay of an existing template. The new file(s) must:

have the same or higher page count
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.

operationId: Template_updateFiles

Parameters

Name	In	Required	Type	Description
template_id	path	required	string	The ID of the template whose files to update.

Request Body

required

application/json

schema TemplateUpdateFilesRequest

Property	Type	Required
files	array	optional
message	string	optional
subject	string	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional

multipart/form-data

schema TemplateUpdateFilesRequest

Property	Type	Required
files	array	optional
message	string	optional
subject	string	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional

Responses

4XX

failed_operation

200

successful operation

POST /template/update_files/{template_id}

Unclaimeddraft 4 endpoints

POST /unclaimed_draft/create Create Unclaimed Draft

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: UnclaimedDraft_createNewDraft

Request Body

required

application/json

schema UnclaimedDraftCreateRequest

Property	Type	Required
type	string	required
files	array	optional
message	string	optional
signers	array	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
subject	string	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
hide_text_tags	boolean	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
form_field_groups	array	optional
└ group_id	string	required
└ group_label	string	required
└ requirement	string	required
cc_email_addresses	array	optional
…4 more	object	optional

multipart/form-data

schema UnclaimedDraftCreateRequest

Property	Type	Required
type	string	required
files	array	optional
message	string	optional
signers	array	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
subject	string	optional
metadata	object	optional
client_id	string	optional
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
hide_text_tags	boolean	optional
signing_options	object	optional
└ draw	boolean	optional
└ type	boolean	optional
└ phone	boolean	optional
└ upload	boolean	optional
└ default_type	string	required
form_field_rules	array	optional
└ id	string	required
└ actions	array	required
└ type	string	required
└ hidden	boolean	required
└ field_id	string	optional
└ group_id	string	optional
└ triggers	array	required
└ id	string	required
└ value	string	optional
└ values	array	optional
└ operator	string	required
└ trigger_operator	string	required
form_field_groups	array	optional
└ group_id	string	required
└ group_label	string	required
└ requirement	string	required
cc_email_addresses	array	optional
…4 more	object	optional

Responses

4XX

failed_operation

200

successful operation

POST /unclaimed_draft/create

POST /unclaimed_draft/create_embedded Create Embedded Unclaimed Draft

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: UnclaimedDraft_createEmbedded

Request Body

required

application/json

schema UnclaimedDraftCreateEmbeddedRequest

Property	Type	Required
type	string	optional
files	array	optional
message	string	optional
signers	array	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
subject	string	optional
metadata	object	optional
allow_ccs	boolean	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
skip_me_now	boolean	optional
hold_request	boolean	optional
show_preview	boolean	optional
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
allow_reassign	boolean	optional
…16 more	object	optional

multipart/form-data

schema UnclaimedDraftCreateEmbeddedRequest

Property	Type	Required
type	string	optional
files	array	optional
message	string	optional
signers	array	optional
└ name	string	required
└ order	integer	optional
└ email_address	string	required
subject	string	optional
metadata	object	optional
allow_ccs	boolean	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
expires_at	integer	optional
attachments	array	optional
└ name	string	required
└ required	boolean	optional
└ instructions	string	optional
└ signer_index	integer	required
skip_me_now	boolean	optional
hold_request	boolean	optional
show_preview	boolean	optional
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
use_text_tags	boolean	optional
allow_reassign	boolean	optional
…16 more	object	optional

Responses

4XX

failed_operation

200

successful operation

POST /unclaimed_draft/create_embedded

POST /unclaimed_draft/create_embedded_with_template Create Embedded Unclaimed Draft with Template

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: UnclaimedDraft_createEmbeddedWithTemplate

Request Body

required

application/json

schema UnclaimedDraftCreateEmbeddedWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
files	array	optional
title	string	optional
message	string	optional
signers	array	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
subject	string	optional
metadata	object	optional
allow_ccs	boolean	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
skip_me_now	boolean	optional
hold_request	boolean	optional
preview_only	boolean	optional
show_preview	boolean	optional
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
allow_reassign	boolean	optional
…10 more	object	optional

multipart/form-data

schema UnclaimedDraftCreateEmbeddedWithTemplateRequest

Property	Type	Required
ccs	array	optional
└ role	string	required
└ email_address	string	required
files	array	optional
title	string	optional
message	string	optional
signers	array	optional
└ name	string	required
└ role	string	required
└ email_address	string	required
subject	string	optional
metadata	object	optional
allow_ccs	boolean	optional
client_id	string	required
file_urls	array	optional
test_mode	boolean	optional
skip_me_now	boolean	optional
hold_request	boolean	optional
preview_only	boolean	optional
show_preview	boolean	optional
template_ids	array	required
allow_decline	boolean	optional
custom_fields	array	optional
└ name	string	required
└ value	string	optional
└ editor	string	optional
└ required	boolean	optional
field_options	object	optional
└ date_format	string	required
allow_reassign	boolean	optional
…10 more	object	optional

Responses

4XX

failed_operation

200

successful operation

POST /unclaimed_draft/create_embedded_with_template

POST /unclaimed_draft/edit_and_resend/{signature_request_id} Edit and Resend Unclaimed Draft

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: UnclaimedDraft_editResend

Parameters

Name	In	Required	Type	Description
signature_request_id	path	required	string	The ID of the signature request to edit and resend.

Request Body

required

application/json

schema UnclaimedDraftEditAndResendRequest

Property	Type	Required
client_id	string	required
test_mode	boolean	optional
editor_options	object	optional
└ allow_edit_signers	boolean	optional
└ allow_edit_documents	boolean	optional
signing_redirect_url	string	optional
show_progress_stepper	boolean	optional
is_for_embedded_signing	boolean	optional
requester_email_address	string	optional
requesting_redirect_url	string	optional

Responses

4XX

failed_operation

200

successful operation

POST /unclaimed_draft/edit_and_resend/{signature_request_id}

Load more endpoints

Schemas

object AccountCreateRequest

{
  "type": "object",
  "required": [
    "email_address"
  ],
  "properties": {
    "locale": {
      "type": "string",
      "description": "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."
    },
    "client_id": {
      "type": "string",
      "description": "Used when creating a new account with OAuth authorization.\n\nSee [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)"
    },
    "client_secret": {
      "type": "string",
      "description": "Used when creating a new account with OAuth authorization.\n\nSee [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)"
    },
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "The email address which will be associated with the new Account."
    }
  }
}

object AccountCreateResponse

{
  "type": "object",
  "properties": {
    "account": {
      "$ref": "#/components/schemas/AccountResponse"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "oauth_data": {
      "$ref": "#/components/schemas/OAuthTokenResponse"
    }
  },
  "x-internal": true
}

object AccountGetResponse

{
  "type": "object",
  "properties": {
    "account": {
      "$ref": "#/components/schemas/AccountResponse"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

object AccountResponse

{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "nullable": true,
      "description": "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."
    },
    "quotas": {
      "$ref": "#/components/schemas/AccountResponseQuotas"
    },
    "team_id": {
      "type": "string",
      "nullable": true,
      "description": "The id of the team account belongs to."
    },
    "is_locked": {
      "type": "boolean",
      "description": "Returns `true` if the user has been locked out of their account by a team admin."
    },
    "role_code": {
      "type": "string",
      "nullable": true,
      "description": "The membership role for the team."
    },
    "account_id": {
      "type": "string",
      "description": "The ID of the Account"
    },
    "is_paid_hf": {
      "type": "boolean",
      "description": "Returns `true` if the user has a paid HelloFax account."
    },
    "is_paid_hs": {
      "type": "boolean",
      "description": "Returns `true` if the user has a paid Dropbox Sign account."
    },
    "callback_url": {
      "type": "string",
      "nullable": true,
      "description": "The URL that Dropbox Sign events will `POST` to."
    },
    "email_address": {
      "type": "string",
      "description": "The email address associated with the Account."
    }
  },
  "x-internal": true
}

object AccountResponseQuotas

{
  "type": "object",
  "properties": {
    "documents_left": {
      "type": "integer",
      "nullable": true,
      "description": "Signature requests remaining."
    },
    "templates_left": {
      "type": "integer",
      "nullable": true,
      "description": "API templates remaining."
    },
    "templates_total": {
      "type": "integer",
      "nullable": true,
      "description": "Total API templates allowed."
    },
    "sms_verifications_left": {
      "type": "integer",
      "nullable": true,
      "description": "SMS verifications  remaining."
    },
    "api_signature_requests_left": {
      "type": "integer",
      "nullable": true,
      "description": "API signature requests remaining."
    }
  },
  "x-internal": true,
  "description": "Details concerning remaining monthly quotas."
}

object AccountUpdateRequest

{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "description": "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."
    },
    "account_id": {
      "type": "string",
      "nullable": true,
      "description": "The ID of the Account"
    },
    "callback_url": {
      "type": "string",
      "description": "The URL that Dropbox Sign should POST events to."
    }
  }
}

object AccountVerifyRequest

{
  "type": "object",
  "required": [
    "email_address"
  ],
  "properties": {
    "email_address": {
      "type": "string",
      "format": "email",
      "description": "Email address to run the verification for."
    }
  }
}

object AccountVerifyResponse

{
  "type": "object",
  "properties": {
    "account": {
      "$ref": "#/components/schemas/AccountVerifyResponseAccount"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

object AccountVerifyResponseAccount

{
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The email address associated with the Account."
    }
  },
  "x-internal": true
}

object ApiAppCreateRequest

{
  "type": "object",
  "required": [
    "name",
    "domains"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name you want to assign to the ApiApp."
    },
    "oauth": {
      "$ref": "#/components/schemas/SubOAuth"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 2,
      "minItems": 1,
      "description": "The domain names the ApiApp will be associated with."
    },
    "options": {
      "$ref": "#/components/schemas/SubOptions"
    },
    "callback_url": {
      "type": "string",
      "description": "The URL at which the ApiApp should receive event callbacks."
    },
    "custom_logo_file": {
      "type": "string",
      "format": "binary",
      "description": "An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)"
    },
    "white_labeling_options": {
      "$ref": "#/components/schemas/SubWhiteLabelingOptions"
    }
  }
}

object ApiAppGetResponse

{
  "type": "object",
  "properties": {
    "api_app": {
      "$ref": "#/components/schemas/ApiAppResponse"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

object ApiAppListResponse

{
  "type": "object",
  "properties": {
    "api_apps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApiAppResponse"
      },
      "description": "Contains information about API Apps."
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "list_info": {
      "$ref": "#/components/schemas/ListInfoResponse"
    }
  },
  "x-internal": true
}

object ApiAppResponse

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the app"
    },
    "oauth": {
      "$ref": "#/components/schemas/ApiAppResponseOAuth"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The domain name(s) associated with the app"
    },
    "options": {
      "$ref": "#/components/schemas/ApiAppResponseOptions"
    },
    "client_id": {
      "type": "string",
      "description": "The app's client id"
    },
    "created_at": {
      "type": "integer",
      "description": "The time that the app was created"
    },
    "is_approved": {
      "type": "boolean",
      "description": "Boolean to indicate if the app has been approved"
    },
    "callback_url": {
      "type": "string",
      "nullable": true,
      "description": "The app's callback URL (for events)"
    },
    "owner_account": {
      "$ref": "#/components/schemas/ApiAppResponseOwnerAccount"
    },
    "white_labeling_options": {
      "$ref": "#/components/schemas/ApiAppResponseWhiteLabelingOptions"
    }
  },
  "x-internal": true,
  "description": "Contains information about an API App."
}

object ApiAppResponseOAuth

{
  "type": "object",
  "nullable": true,
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of OAuth scopes used by the app."
    },
    "secret": {
      "type": "string",
      "description": "The app's OAuth secret, or null if the app does not belong to user."
    },
    "callback_url": {
      "type": "string",
      "description": "The app's OAuth callback URL."
    },
    "charges_users": {
      "type": "boolean",
      "description": "Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests."
    }
  },
  "x-internal": true,
  "description": "An object describing the app's OAuth properties, or null if OAuth is not configured for the app."
}

object ApiAppResponseOptions

{
  "type": "object",
  "nullable": true,
  "properties": {
    "can_insert_everywhere": {
      "type": "boolean",
      "description": "Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document"
    }
  },
  "x-internal": true,
  "description": "An object with options that override account settings."
}

object ApiAppResponseOwnerAccount

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The owner account's ID"
    },
    "email_address": {
      "type": "string",
      "description": "The owner account's email address"
    }
  },
  "x-internal": true,
  "description": "An object describing the app's owner"
}

object ApiAppResponseWhiteLabelingOptions

{
  "type": "object",
  "nullable": true,
  "properties": {
    "link_color": {
      "type": "string"
    },
    "text_color1": {
      "type": "string"
    },
    "text_color2": {
      "type": "string"
    },
    "legal_version": {
      "type": "string"
    },
    "primary_button_color": {
      "type": "string"
    },
    "page_background_color": {
      "type": "string"
    },
    "secondary_button_color": {
      "type": "string"
    },
    "header_background_color": {
      "type": "string"
    },
    "primary_button_text_color": {
      "type": "string"
    },
    "primary_button_color_hover": {
      "type": "string"
    },
    "secondary_button_text_color": {
      "type": "string"
    },
    "secondary_button_color_hover": {
      "type": "string"
    },
    "primary_button_text_color_hover": {
      "type": "string"
    },
    "secondary_button_text_color_hover": {
      "type": "string"
    }
  },
  "x-internal": true,
  "description": "An object with options to customize the app's signer page"
}

object ApiAppUpdateRequest

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name you want to assign to the ApiApp."
    },
    "oauth": {
      "$ref": "#/components/schemas/SubOAuth"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 2,
      "description": "The domain names the ApiApp will be associated with."
    },
    "options": {
      "$ref": "#/components/schemas/SubOptions"
    },
    "callback_url": {
      "type": "string",
      "description": "The URL at which the API App should receive event callbacks."
    },
    "custom_logo_file": {
      "type": "string",
      "format": "binary",
      "description": "An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)"
    },
    "white_labeling_options": {
      "$ref": "#/components/schemas/SubWhiteLabelingOptions"
    }
  }
}

object BulkSendJobGetResponse

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "list_info": {
      "$ref": "#/components/schemas/ListInfoResponse"
    },
    "bulk_send_job": {
      "$ref": "#/components/schemas/BulkSendJobResponse"
    },
    "signature_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkSendJobGetResponseSignatureRequests"
      },
      "description": "Contains information about the Signature Requests sent in bulk."
    }
  },
  "x-internal": true
}

object BulkSendJobGetResponseSignatureRequests

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/SignatureRequestResponse"
    },
    {
      "properties": {
        "bulk_send_job_id": {
          "type": "string",
          "description": "The id of the BulkSendJob."
        }
      }
    }
  ],
  "title": "BulkSendJobGetResponseSignatureRequests",
  "x-internal": true
}

object BulkSendJobListResponse

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "list_info": {
      "$ref": "#/components/schemas/ListInfoResponse"
    },
    "bulk_send_jobs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkSendJobResponse"
      },
      "description": "Contains a list of BulkSendJobs that the API caller has access to."
    }
  },
  "x-internal": true
}

object BulkSendJobResponse

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "description": "The total amount of Signature Requests queued for sending."
    },
    "created_at": {
      "type": "integer",
      "description": "Time that the BulkSendJob was created."
    },
    "is_creator": {
      "type": "boolean",
      "description": "True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member."
    },
    "bulk_send_job_id": {
      "type": "string",
      "nullable": true,
      "description": "The id of the BulkSendJob."
    }
  },
  "x-internal": true,
  "description": "Contains information about the BulkSendJob such as when it was created and how many signature requests are queued."
}

object BulkSendJobSendResponse

{
  "type": "object",
  "properties": {
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    },
    "bulk_send_job": {
      "$ref": "#/components/schemas/BulkSendJobResponse"
    }
  },
  "x-internal": true
}

object EmbeddedEditUrlRequest

{
  "type": "object",
  "properties": {
    "cc_roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`."
    },
    "merge_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubMergeField"
      },
      "description": "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.\n\nRemove all merge fields on the template by passing an empty array `[]`."
    },
    "preview_only": {
      "type": "boolean",
      "default": false,
      "description": "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).\n\n**Note**: This parameter overwrites `show_preview=true` (if set)."
    },
    "show_preview": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable the editor/preview experience."
    },
    "allow_edit_ccs": {
      "type": "boolean",
      "default": false,
      "description": "This allows the requester to enable/disable to add or change CC roles when editing the template."
    },
    "editor_options": {
      "$ref": "#/components/schemas/SubEditorOptions"
    },
    "force_signer_roles": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template signer roles."
    },
    "force_subject_message": {
      "type": "boolean",
      "default": false,
      "description": "Provide users the ability to review/edit the template subject and message."
    },
    "show_progress_stepper": {
      "type": "boolean",
      "default": true,
      "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."
    }
  }
}

object EmbeddedEditUrlResponse

{
  "type": "object",
  "properties": {
    "embedded": {
      "$ref": "#/components/schemas/EmbeddedEditUrlResponseEmbedded"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

object EmbeddedEditUrlResponseEmbedded

{
  "type": "object",
  "properties": {
    "edit_url": {
      "type": "string",
      "description": "A template url that can be opened in an iFrame."
    },
    "expires_at": {
      "type": "integer",
      "description": "The specific time that the the `edit_url` link expires, in epoch."
    }
  },
  "x-internal": true,
  "description": "An embedded template object."
}

object EmbeddedSignUrlResponse

{
  "type": "object",
  "properties": {
    "embedded": {
      "$ref": "#/components/schemas/EmbeddedSignUrlResponseEmbedded"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

object EmbeddedSignUrlResponseEmbedded

{
  "type": "object",
  "properties": {
    "sign_url": {
      "type": "string",
      "description": "A signature url that can be opened in an iFrame."
    },
    "expires_at": {
      "type": "integer",
      "description": "The specific time that the the `sign_url` link expires, in epoch."
    }
  },
  "x-internal": true,
  "description": "An object that contains necessary information to set up embedded signing."
}

object ErrorResponse

{
  "type": "object",
  "required": [
    "error"
  ],
  "properties": {
    "error": {
      "$ref": "#/components/schemas/ErrorResponseError"
    }
  }
}

object ErrorResponseError

{
  "type": "object",
  "required": [
    "error_msg",
    "error_name"
  ],
  "properties": {
    "error_msg": {
      "type": "string",
      "description": "Message describing an error."
    },
    "error_name": {
      "type": "string",
      "description": "Name of the error."
    },
    "error_path": {
      "type": "string",
      "description": "Path at which an error occurred."
    }
  },
  "description": "Contains information about an error that occurred."
}

object EventCallbackRequest

{
  "type": "object",
  "title": "EventCallbackRequest",
  "required": [
    "event"
  ],
  "properties": {
    "event": {
      "$ref": "#/components/schemas/EventCallbackRequestEvent"
    },
    "account": {
      "$ref": "#/components/schemas/AccountResponse"
    },
    "template": {
      "$ref": "#/components/schemas/TemplateResponse"
    },
    "signature_request": {
      "$ref": "#/components/schemas/SignatureRequestResponse"
    }
  }
}

object EventCallbackRequestEvent

{
  "type": "object",
  "required": [
    "event_time",
    "event_type",
    "event_hash"
  ],
  "properties": {
    "event_hash": {
      "type": "string",
      "description": "Generated hash used to verify source of event data."
    },
    "event_time": {
      "type": "string",
      "description": "Time the event was created (using Unix time)."
    },
    "event_type": {
      "enum": [
        "account_confirmed",
        "unknown_error",
        "file_error",
        "sign_url_invalid",
        "signature_request_viewed",
        "signature_request_signed",
        "signature_request_sent",
        "signature_request_all_signed",
        "signature_request_email_bounce",
        "signature_request_remind",
        "signature_request_incomplete_qes",
        "signature_request_destroyed",
        "signature_request_canceled",
        "signature_request_downloadable",
        "signature_request_declined",
        "signature_request_reassigned",
        "signature_request_invalid",
        "signature_request_prepared",
        "signature_request_expired",
        "template_created",
        "template_error",
        "callback_test",
        "signature_request_signer_removed"
      ],
      "type": "string",
      "description": "Type of callback event that was triggered."
    },
    "event_metadata": {
      "$ref": "#/components/schemas/EventCallbackRequestEventMetadata"
    }
  },
  "description": "Basic information about the event that occurred."
}

object EventCallbackRequestEventMetadata

{
  "type": "object",
  "properties": {
    "event_message": {
      "type": "string",
      "nullable": true,
      "description": "Message about a declined or failed (due to error) signature flow."
    },
    "reported_for_app_id": {
      "type": "string",
      "nullable": true,
      "description": "App ID the event was reported for."
    },
    "related_signature_id": {
      "type": "string",
      "nullable": true,
      "description": "Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events."
    },
    "reported_for_account_id": {
      "type": "string",
      "nullable": true,
      "description": "Account ID the event was reported for."
    }
  },
  "description": "Specific metadata about the event."
}

object FileResponse

{
  "type": "object",
  "properties": {
    "file_url": {
      "type": "string",
      "description": "URL to the file."
    },
    "expires_at": {
      "type": "integer",
      "description": "When the link expires."
    }
  },
  "x-internal": true
}

object FileResponseDataUri

{
  "type": "object",
  "properties": {
    "data_uri": {
      "type": "string",
      "description": "File as base64 encoded string."
    }
  },
  "x-internal": true
}

object ListInfoResponse

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "Number of the page being returned."
    },
    "num_pages": {
      "type": "integer",
      "description": "Total number of pages available."
    },
    "page_size": {
      "type": "integer",
      "description": "Objects returned per page."
    },
    "num_results": {
      "type": "integer",
      "nullable": true,
      "description": "Total number of objects available."
    }
  },
  "x-internal": true,
  "description": "Contains pagination information about the data returned."
}

object OAuthTokenGenerateRequest

{
  "type": "object",
  "required": [
    "client_id",
    "client_secret",
    "code",
    "state",
    "grant_type"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "The code passed to your callback when the user granted access."
    },
    "state": {
      "type": "string",
      "description": "Same as the state you specified earlier."
    },
    "client_id": {
      "type": "string",
      "description": "The client id of the app requesting authorization."
    },
    "grant_type": {
      "type": "string",
      "default": "authorization_code",
      "description": "When generating a new token use `authorization_code`."
    },
    "client_secret": {
      "type": "string",
      "description": "The secret token of your app."
    }
  }
}

object OAuthTokenRefreshRequest

{
  "type": "object",
  "required": [
    "grant_type",
    "refresh_token"
  ],
  "properties": {
    "grant_type": {
      "type": "string",
      "default": "refresh_token",
      "description": "When refreshing an existing token use `refresh_token`."
    },
    "refresh_token": {
      "type": "string",
      "description": "The token provided when you got the expired access token."
    }
  }
}

object OAuthTokenResponse

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "nullable": true
    },
    "expires_in": {
      "type": "integer",
      "description": "Number of seconds until the `access_token` expires. Uses epoch time."
    },
    "token_type": {
      "type": "string"
    },
    "access_token": {
      "type": "string"
    },
    "refresh_token": {
      "type": "string"
    }
  },
  "x-internal": true
}

object ReportCreateRequest

{
  "type": "object",
  "required": [
    "start_date",
    "end_date",
    "report_type"
  ],
  "properties": {
    "end_date": {
      "type": "string",
      "description": "The (inclusive) end date for the report data in `MM/DD/YYYY` format."
    },
    "start_date": {
      "type": "string",
      "description": "The (inclusive) start date for the report data in `MM/DD/YYYY` format."
    },
    "report_type": {
      "type": "array",
      "items": {
        "enum": [
          "user_activity",
          "document_status"
        ],
        "type": "string"
      },
      "maxItems": 2,
      "minItems": 1,
      "description": "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)."
    }
  }
}

object ReportCreateResponse

{
  "type": "object",
  "properties": {
    "report": {
      "$ref": "#/components/schemas/ReportResponse"
    },
    "warnings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/WarningResponse"
      },
      "description": "A list of warnings."
    }
  },
  "x-internal": true
}

object ReportResponse

{
  "type": "object",
  "properties": {
    "success": {
      "type": "string",
      "description": "A message indicating the requested operation's success"
    },
    "end_date": {
      "type": "string",
      "description": "The (inclusive) end date for the report data in MM/DD/YYYY format."
    },
    "start_date": {
      "type": "string",
      "description": "The (inclusive) start date for the report data in MM/DD/YYYY format."
    },
    "report_type": {
      "type": "array",
      "items": {
        "enum": [
          "user_activity",
          "document_status"
        ],
        "type": "string"
      },
      "description": "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)."
    }
  },
  "x-internal": true,
  "description": "Contains information about the report request."
}

object SignatureRequestBulkCreateEmbeddedWithTemplateRequest

{
  "type": "object",
  "required": [
    "client_id",
    "template_ids"
  ],
  "properties": {
    "ccs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "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.\n\nEach 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.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "signer_file": {
      "type": "string",
      "format": "binary",
      "description": "`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:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **Note**: Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"
    },
    "signer_list": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubBulkSignerList"
      },
      "description": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-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.\n\nFor 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](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    }
  }
}

object SignatureRequestBulkSendWithTemplateRequest

{
  "type": "object",
  "required": [
    "template_ids"
  ],
  "properties": {
    "ccs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "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.\n\nEach 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.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "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."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "signer_file": {
      "type": "string",
      "format": "binary",
      "description": "`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:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **Note**: Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"
    },
    "signer_list": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubBulkSignerList"
      },
      "description": "`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-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.\n\nFor 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](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "signing_redirect_url": {
      "type": "string",
      "description": "The URL you want signers redirected to after they successfully sign."
    }
  }
}

object SignatureRequestCancelIncompleteResponse

{
  "type": "object",
  "example": {},
  "properties": {}
}

object SignatureRequestCreateEmbeddedRequest

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestSigner"
      },
      "description": "Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "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.\n\nEach 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.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "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."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-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.\n\nFor 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](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "use_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "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`."
    },
    "allow_reassign": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan."
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Enables automatic Text Tag removal when set to true.\n\n**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."
    },
    "grouped_signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestGroupedSigners"
      },
      "description": "Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRule"
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldGroup"
      },
      "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`."
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/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](https://raw.githubusercontent.com).)\n\n**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.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "default": false,
      "description": "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.\n\n⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    }
  }
}

object SignatureRequestCreateEmbeddedWithTemplateRequest

{
  "type": "object",
  "required": [
    "client_id",
    "template_ids",
    "signers"
  ],
  "properties": {
    "ccs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCC"
      },
      "description": "Add CC email recipients. Required when a CC role exists for the Template."
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestTemplateSigner"
      },
      "description": "Add Signers to your Templated-based Signature Request."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "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.\n\nEach 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.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "template_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "An array defining values and options for custom fields. Required when a custom field exists in the Template."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "default": false,
      "description": "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.\n\n⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    }
  }
}

string SignatureRequestDownloadFiles200Response

{
  "type": "string",
  "format": "binary"
}

string SignatureRequestDownloadFilesResponse

{
  "type": "string",
  "format": "binary"
}

object SignatureRequestEditEmbeddedRequest

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "properties": {
    "files": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "binary"
      },
      "description": "Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "The title you want to assign to the SignatureRequest."
    },
    "message": {
      "type": "string",
      "maxLength": 5000,
      "description": "The custom message in the email that will be sent to the signers."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestSigner"
      },
      "description": "Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "subject": {
      "type": "string",
      "maxLength": 255,
      "description": "The subject in the email that will be sent to the signers."
    },
    "metadata": {
      "type": "object",
      "maxItems": 10,
      "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.\n\nEach 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.",
      "additionalProperties": {}
    },
    "client_id": {
      "type": "string",
      "description": "Client id of the app you're using to create this embedded signature request. Used for security purposes."
    },
    "file_urls": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."
    },
    "test_mode": {
      "type": "boolean",
      "default": false,
      "description": "Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."
    },
    "expires_at": {
      "type": "integer",
      "nullable": true,
      "description": "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."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubAttachment"
      },
      "description": "A list describing the attachments"
    },
    "allow_decline": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to decline to sign a document if `true`. Defaults to `false`."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubCustomField"
      },
      "description": "When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-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.\n\nFor 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](https://raw.githubusercontent.com) and then passing `custom_fields` on subsequent signature requests referencing that template."
    },
    "field_options": {
      "$ref": "#/components/schemas/SubFieldOptions"
    },
    "use_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "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`."
    },
    "allow_reassign": {
      "type": "boolean",
      "default": false,
      "description": "Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**Note**: Only available for Premium plan."
    },
    "hide_text_tags": {
      "type": "boolean",
      "default": false,
      "description": "Enables automatic Text Tag removal when set to true.\n\n**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."
    },
    "grouped_signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubSignatureRequestGroupedSigners"
      },
      "description": "Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."
    },
    "signing_options": {
      "$ref": "#/components/schemas/SubSigningOptions"
    },
    "form_field_rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldRule"
      },
      "description": "Conditional Logic rules for fields defined in `form_fields_per_document`."
    },
    "form_field_groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SubFormFieldGroup"
      },
      "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`."
    },
    "cc_email_addresses": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The email addresses that should be CCed."
    },
    "form_fields_per_document": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/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](https://raw.githubusercontent.com).)\n\n**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.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"
    },
    "populate_auto_fill_fields": {
      "type": "boolean",
      "default": false,
      "description": "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.\n\n⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."
    }
  }
}

Load more schemas