Dropbox Sign (HelloSign)
API integration

list_all_dropbox_sign_hello_sign_teams

Get your HelloSign team, including a list of its members. Returns: team_id, team_parent, name, num_members, num_sub_teams. Fails with a 404 error if you do not belong to a team.

get_single_dropbox_sign_hello_sign_team_by_id

Get detailed info about a HelloSign team by team id (sent as team_id). Returns: team_id, team_parent, name, num_members, num_sub_teams.

delete_a_dropbox_sign_hello_sign_team_by_id

Remove a user from a HelloSign team, identified by account_id or email_address. Returns the updated team including its name, accounts, invited_accounts, and invited_emails.

dropbox_sign_hello_sign_teams_bulk_update

Update the HelloSign team, such as renaming it. Returns the updated team object including its name, accounts, invited_accounts, and invited_emails.

list_all_dropbox_sign_hello_sign_members

List the members of a Dropbox Sign team and their roles. Returns each member's id and attributes holding the upstream member fields. Required: team_id. Max 100 members per page.

list_all_dropbox_sign_hello_sign_account

Get the Dropbox Sign account associated with the authenticated API key. Returns: account_id, email_address, is_locked, is_paid_hs, is_paid_hf, quotas, callback_url, role_code, team_id, locale, usage, settings.

dropbox_sign_hello_sign_account_bulk_update

Update a Dropbox Sign account, e.g. to change its callback URL or locale. Returns the account object including account_id, email_address, callback_url, locale, quotas, and settings.

create_a_dropbox_sign_hello_sign_account_create

Create a new Dropbox Sign (HelloSign) account associated with the specified email address. Returns: account_id, email_address, is_locked, quotas. Required: email_address.

create_a_dropbox_sign_hello_sign_account_verify

Verify whether a Dropbox Sign (HelloSign) account exists for a given email address. Returns the matched account's email_address when found. Required: email_address.

list_all_dropbox_sign_hello_sign_api_app_lists

List HelloSign API Apps accessible to you, including apps owned by teammates when you hold an Admin or Developer role on your team. Returns: name, client_id, callback_url, domains, is_approved. Max 100 per page.

create_a_dropbox_sign_hello_sign_api_app

Create a new HelloSign API App. Returns the created app including its name, domains, client_id, callback_url, and is_approved status. Required: name, domains.

delete_a_dropbox_sign_hello_sign_api_app_by_id

Delete a HelloSign API App by its client id. Returns an empty 204 response on success. Can only be invoked for apps you own. Required: id.

get_single_dropbox_sign_hello_sign_api_app_by_id

Get a HelloSign API App by id (the app's client_id). Returns: name, domains, client_id, callback_url, is_approved. Required: id.

update_a_dropbox_sign_hello_sign_api_app_by_id

Update an existing HelloSign API App by id (the app's client_id); only the fields you provide are changed, and empty strings clear optional fields. Returns: name, domains, client_id, callback_url, is_approved. Required: id.

list_all_dropbox_sign_hello_sign_bulk_send_job_lists

List the Bulk Send Jobs you can access in Dropbox Sign (HelloSign). Returns: bulk_send_jobs (each with bulk_send_job_id and signature_request_ids), list_info pagination info, and warnings.

get_single_dropbox_sign_hello_sign_bulk_send_job_by_id

Get a HelloSign Bulk Send Job by id, including the status of its signature requests. Returns: bulk_send_job_id, total, is_creator, created_at. Required: id, bulk_send_job_id.

create_a_dropbox_sign_hello_sign_document_detect_field

Detect form fields in a PDF document in HelloSign using either PDF form annotations or Dropbox Sign text tags. Returns the detected document object with the detected form-field data. Requires a request body; field definitions follow the upstream DocumentFieldDetectionRequest schema. Required: detection_mode.

create_a_dropbox_sign_hello_sign_embedded_edit_url

Get an embedded edit URL for a HelloSign template that can be opened in an iFrame. Returns: edit_url, expires_at. Required: template_id. Only templates created via the embedded template process can be edited with this endpoint.

get_single_dropbox_sign_hello_sign_embedded_sign_url_by_id

Get an embedded HelloSign sign URL for a signature that can be opened in an iFrame. Returns: sign_url, expires_at. Required: id.

get_single_dropbox_sign_hello_sign_fax_file_by_id

Download the files associated with a fax in HelloSign. Returns the fax files as a binary PDF (application/pdf) download. fa5c8a0b0f492d768749333ad6fcc214c111e967). Required: id.

dropbox_sign_hello_sign_fax_line_add_users_bulk_update

Add a user to a HelloSign fax line. Returns the fax line's number, its list of accounts, and created_at/updated_at timestamps. Required: number.

list_all_dropbox_sign_hello_sign_fax_line_area_codes

List available HelloSign fax line area codes for a given country, optionally filtered by state, province, or city. Returns: area_codes. Required: country.

create_a_dropbox_sign_hello_sign_fax_line_create

Purchase a new fax line in HelloSign. Returns the fax line's number, created_at, updated_at, and linked accounts. Required: area_code, country.

list_all_dropbox_sign_hello_sign_fax_line_lists

List HelloSign fax lines. Returns the properties and settings of each fax line, including its number, created_at, updated_at, and associated accounts.

dropbox_sign_hello_sign_fax_line_remove_users_bulk_update

Remove a user's access to a fax line in HelloSign. Returns the updated fax line including its number, created_at, updated_at, and accounts. Required: number.

dropbox_sign_hello_sign_fax_lines_bulk_delete

Delete a fax line in HelloSign (Dropbox Sign), removing the specified fax line from the subscription. Returns an empty 204 response on success. The fax line to delete is identified in the required JSON request body. Required: number.

list_all_dropbox_sign_hello_sign_fax_lines

Get a HelloSign Fax Line's properties and settings by its number. Returns: number, created_at, updated_at, accounts. Required: number.

list_all_dropbox_sign_hello_sign_fax_lists

List faxes in HelloSign. Returns properties of multiple faxes including fax_id, title, original_title, sender, created_at, and test_mode. Max 100 per page.

create_a_dropbox_sign_hello_sign_fax_send

Send a fax in HelloSign with the submitted file(s). Returns: fax_id, title, sender, created_at, transmissions, test_mode. Required: recipient.

delete_a_dropbox_sign_hello_sign_fax_by_id

Delete a HelloSign fax by id, removing the specified fax from the system. Returns an empty 204 response on success. Required: id.

get_single_dropbox_sign_hello_sign_fax_by_id

Get a single fax in HelloSign by id. Returns: fax_id, title, subject, message, sender, files_url, created_at, transmissions, test_mode. Required: id.

create_a_dropbox_sign_hello_sign_report_create

Create a report in HelloSign. Returns: report, warnings. Required: start_date, end_date, report_type. The report is generated asynchronously and delivered by email as a CSV download link; the requested date range may span up to 12 months and start_date must be no more than 10 years in the past.

create_signature_request_bulk_create_embedded_with_template

Create a HelloSign bulk send job that sends up to 250 signature requests built from the given templates for signing in an embedded iFrame. Returns: bulk_send_job_id, total, is_creator, created_at. Required: template_ids, client_id. Only available on the Standard plan and higher.

create_signature_request_bulk_send_with_template

Bulk send up to 250 signature requests based on a HelloSign template. Returns: bulk_send_job_id, total, is_creator, created_at. Required: template_ids. Requires a Standard plan or higher.

create_a_dropbox_sign_hello_sign_signature_request_cancel

Cancel an incomplete HelloSign signature request by id. Returns an empty 200 OK response on success; cancelation is asynchronous and confirmed via the signature_request_canceled event. The action is not reversible. Required: signature_request_id.

create_signature_request_create_embedded_with_template

Create an embedded HelloSign signature request from one or more templates to be signed in an embedded iFrame. Returns: signature_request_id, signing_url, title, is_complete, signatures. Required: template_ids, client_id, signers. Embedded requests can only be signed in an iFrame.

create_signature_request_create_embedded

Create an embedded HelloSign signature request with documents to be signed in an embedded iFrame. Returns: signature_request_id, signing_url, is_complete, signatures, subject, created_at. Required: client_id. Embedded requests can only be signed in an embedded iFrame, not on Dropbox Sign.

update_signature_request_edit_embedded_with_template_by_id

Edit a HelloSign embedded signature request created from one or more templates so it can be signed in an embedded iFrame. Returns the edited signature request object with its updated details. Requires id, template_ids, client_id, and signers. Edit and resend deducts the signature request quota.

update_signature_request_edit_embedded_by_id

Edit an embedded signature request in Dropbox Sign, resubmitting its documents and settings for signing in an embedded iFrame. Returns: signature_request_id, signing_url, title, subject, is_complete, expires_at. Required: id, client_id. Editing and resending deducts the signature request quota.

update_signature_request_edit_with_template_by_id

Edit and resend a HelloSign signature request based on the specified templates. Returns the updated signature request including signature_request_id, title, subject, is_complete, custom_fields, and signatures. Requires id, template_ids, and signers. Editing and resending deducts your signature request quota. Required: id, template_ids, signers.

update_a_dropbox_sign_hello_sign_signature_request_edit_by_id

Edit and resend a HelloSign signature request with updated documents, signers, and settings. Returns the updated request including signature_request_id, title, subject, is_complete, and signatures. Required: id. Note that each edit and resend deducts the signature request quota.

get_single_dropbox_sign_hello_sign_signature_request_file_by_id

Download the current documents for a HelloSign signature request. Returns the file contents as binary — a single merged PDF or a ZIP archive of individual documents. Returns 409 while the files are still being prepared. Required: id, signature_request_id.

get_signature_request_files_as_data_uris_by_id

Download a HelloSign signature request's current documents as a base64-encoded data URI (PDFs only). Returns a JSON object with a single field: data_uri. Returns 409 while files are still being prepared. Required: id.

get_signature_request_files_as_file_url_by_id

Get a HelloSign signature request's current documents as a file url by id. Returns: file_url, expires_at. PDFs only; a 409 is returned while the files are still being prepared. Required: id, signature_request_id.

list_all_dropbox_sign_hello_sign_signature_request_lists

List HelloSign signature requests you can access, including ones you have sent or received but excluding those you were only CCed on. Returns: signature_request_id, title, subject, requester_email_address, is_complete, created_at, expires_at, and signatures.

create_a_dropbox_sign_hello_sign_signature_request_release_hold

Release a held SignatureRequest in HelloSign, sending the signing requests to all signers. Returns the released SignatureRequest including signature_request_id. Required: signature_request_id. Only applies to requests created from an UnclaimedDraft that was flagged to be held.

create_a_dropbox_sign_hello_sign_signature_request_remind

Send a reminder email to a signer for a HelloSign signature request. Returns the updated signature request with signature_request_id, title, is_complete, and signatures. Required: signature_request_id, email_address. Reminders cannot be sent within 1 hour of the last reminder and are not supported for embedded signature requests.

create_a_dropbox_sign_hello_sign_signature_request_remove

Remove your access to a completed HelloSign signature request. The request must be fully executed (signed or declined by all parties); removal is synchronous, immediate, and not reversible. Returns an empty 200 OK response on success. Required: signature_request_id.

create_signature_request_send_with_template

Create and send a new HelloSign signature request based on one or more templates. Returns: signature_request_id, status, metadata. Required: template_ids, signers.

create_a_dropbox_sign_hello_sign_signature_request_send

Create and send a new HelloSign signature request with the submitted documents. Returns: signature_request_id, title, subject, message, created_at, expires_at, signatures, and metadata. Requires either files or file_urls, and either signers or grouped_signers.

create_a_dropbox_sign_hello_sign_signature_request_update

Update a signer's email address and/or name on a HelloSign signature request, e.g. to recover a bounced email. Returns the updated signature request: signature_request_id, requester_email_address, title, is_complete, signatures. Required: signature_request_id, signature_id. Not usable on requests with an appended signature page.

get_single_dropbox_sign_hello_sign_signature_request_by_id

Get a HelloSign signature request by id. Returns the request's status and details, including signature_request_id, title, subject, is_complete, is_declined, created_at, expires_at, and per-signer signatures. Required: id.

dropbox_sign_hello_sign_team_add_members_bulk_update

Add a user to a team in HelloSign. Returns the updated team object including its name, accounts, invited_accounts, and invited_emails. Requires team_id and either account_id or email_address.

create_a_dropbox_sign_hello_sign_team_create

Create a new team in HelloSign and become its first member. Returns the created team including its name, accounts, invited_accounts, and invited_emails. Requires name. You must not currently belong to a team to invoke.

dropbox_sign_hello_sign_team_destroys_bulk_delete

Delete your Dropbox Sign team. Returns an empty 204 response on success. Can only be invoked when your team has a single member (yourself).

list_all_dropbox_sign_hello_sign_team_invites

List the team invites in HelloSign, including each invitee's role. Returns: id, email_address, role, created_at.

get_single_dropbox_sign_hello_sign_team_sub_team_by_id

List the sub teams that belong to a given team in HelloSign. Returns: team_id, name. Max 100 per page. Required: id, team_id.

create_a_dropbox_sign_hello_sign_template_add_user

Add a user to a HelloSign template, giving the specified Account access to it. Returns the updated template including template_id, title, message, updated_at, signer_roles, and accounts. The Account must be part of your Team. Required: template_id.

create_a_dropbox_sign_hello_sign_template_create_embedded_draft

Create a HelloSign embedded template draft, the first step in an embedded template workflow before the template 'edit' stage. Returns: template_id, edit_url, expires_at, warnings. Required: client_id.

create_a_dropbox_sign_hello_sign_template_create

Create a HelloSign template that can be used in future signature requests. Returns: template_id, title, signer_roles. Required: form_fields_per_document, signer_roles. Creation may complete asynchronously; listen for the template_created or template_error callback event to confirm completion.

create_a_dropbox_sign_hello_sign_template_delete

Delete a Dropbox Sign (HelloSign) template, completely removing it from the account. Returns an empty response on success. Required: template_id.

get_single_dropbox_sign_hello_sign_template_file_by_id

Get a copy of the current documents for a HelloSign template by id. Returns the raw file bytes as a PDF or ZIP download based on file_type. If the files are still being prepared, wait for the template_created callback event. Required: id, template_id.

get_template_files_as_data_uris_by_id

Get a HelloSign template's current documents as a base64-encoded data URI by id. Returns: data_uri. A 409 is returned while the files are still being prepared; wait for the template_created callback event and retry. Required: id.

get_template_files_as_file_url_by_id

Get a copy of a HelloSign template's current documents as a downloadable file URL by id. Returns a JSON object with the file_url to the PDF (PDFs only); a 409 is returned while the files are still being prepared. Required: id (the template_id of the template files to retrieve).

list_all_dropbox_sign_hello_sign_template_lists

List the HelloSign templates accessible to you. Returns: template_id, title, updated_at, is_creator, can_edit, signer_roles, cc_roles, documents, custom_fields.

create_a_dropbox_sign_hello_sign_template_remove_user

Remove an Account's access to a HelloSign template. Returns the updated template including template_id, title, updated_at, signer_roles, and accounts. Required: template_id.

create_a_dropbox_sign_hello_sign_template_update_file

Overlay new files onto the files of an existing HelloSign template without altering the original template. Returns: template_id, warnings. New files must have the same or higher page count and matching orientation; file updates are processed asynchronously. Required: template_id.

get_single_dropbox_sign_hello_sign_template_by_id

Get a HelloSign template by id. Returns the full template object including template_id, title, message, updated_at, signer_roles, documents, custom_fields, and metadata. Required: id.

create_unclaimed_draft_create_embedded_with_template

Create a HelloSign embedded unclaimed draft from one or more saved templates. Returns: claim_url, signature_request_id, expires_at, test_mode. Requires client_id, requester_email_address, and template_ids. The first user to open the claim_url claims the draft; subsequent access returns 404.

create_a_dropbox_sign_hello_sign_unclaimed_draft_create_embedded

Create an embedded unclaimed draft in HelloSign that can be claimed and used in an embedded iFrame. Returns: claim_url, signature_request_id, expires_at. Required: client_id, requester_email_address. The claim URL can be claimed only once; subsequent access returns a 404.

create_a_dropbox_sign_hello_sign_unclaimed_draft_create

Create an unclaimed draft in HelloSign that the first authenticated user to access its claim URL can claim. Returns: claim_url, signature_request_id, signing_redirect_url, requesting_redirect_url, expires_at, test_mode. Required: type.

create_a_dropbox_sign_hello_sign_unclaimed_draft_edit_and_resend

Edit and resend a HelloSign unclaimed draft, creating a new signature request that can be edited prior to being sent to recipients. Returns: signature_request_id, claim_url, signing_redirect_url, expires_at, test_mode. Embedded unclaimed drafts are only accessible in embedded iFrames. Required: signature_request_id, client_id.