openapi: 3.0.3 info: title: 'Dropbox Sign API' description: 'Dropbox Sign v3 API' termsOfService: 'https://www.hellosign.com/terms' contact: email: apisupport@hellosign.com license: name: MIT url: 'https://opensource.org/licenses/MIT' version: 3.0.0 servers: - url: 'https://api.hellosign.com/v3' paths: /account/create: post: tags: - Account summary: 'Create Account' description: 'Creates a new Dropbox Sign Account that is associated with the specified `email_address`.' operationId: accountCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: default_example: $ref: '#/components/examples/AccountCreateRequestDefaultExample' oauth: $ref: '#/components/examples/AccountCreateRequestOAuthExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: default_example: $ref: '#/components/examples/AccountCreateResponseExample' oauth: $ref: '#/components/examples/AccountCreateOAuthResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountCreate.ts - lang: Java label: Java source: $ref: examples/AccountCreate.java - lang: Ruby label: Ruby source: $ref: examples/AccountCreate.rb - lang: Python label: Python source: $ref: examples/AccountCreate.py - lang: cURL label: cURL source: $ref: examples/AccountCreate.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a range of tools. Find out how to create a new Dropbox Sign Account using the specified `email_address` here.' /account: get: tags: - Account summary: 'Get Account' description: 'Returns the properties and settings of your Account.' operationId: accountGet parameters: - name: account_id in: query description: |- `account_id` or `email_address` is required. If both are provided, the account id prevails. The ID of the Account. required: false schema: type: string - name: email_address in: query description: |- `account_id` or `email_address` is required, If both are provided, the account id prevails. The email address of the Account. required: false schema: type: string responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountGetResponse' examples: default_example: $ref: '#/components/examples/AccountGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access - basic_account_info x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountGet.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountGet.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountGet.ts - lang: Java label: Java source: $ref: examples/AccountGet.java - lang: Ruby label: Ruby source: $ref: examples/AccountGet.rb - lang: Python label: Python source: $ref: examples/AccountGet.py - lang: cURL label: cURL source: $ref: examples/AccountGet.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return the properties and settings of your Account, click here.' put: tags: - Account summary: 'Update Account' description: 'Updates the properties and settings of your Account. Currently only allows for updates to the [Callback URL](/api/reference/tag/Callbacks-and-Events) and locale.' operationId: accountUpdate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: default_example: $ref: '#/components/examples/AccountUpdateRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountGetResponse' examples: default_example: $ref: '#/components/examples/AccountUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountUpdate.ts - lang: Java label: Java source: $ref: examples/AccountUpdate.java - lang: Ruby label: Ruby source: $ref: examples/AccountUpdate.rb - lang: Python label: Python source: $ref: examples/AccountUpdate.py - lang: cURL label: cURL source: $ref: examples/AccountUpdate.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how update the properties and settings of your Account, click here.' /account/verify: post: tags: - Account summary: 'Verify Account' description: 'Verifies whether an Dropbox Sign Account exists for the given email address.' operationId: accountVerify requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: default_example: $ref: '#/components/examples/AccountVerifyRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: default_example: $ref: '#/components/examples/AccountVerifyFoundResponseExample' not_found: $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/AccountVerify.php - lang: 'C#' label: 'C#' source: $ref: examples/AccountVerify.cs - lang: JavaScript label: JavaScript source: $ref: examples/AccountVerify.js - lang: TypeScript label: TypeScript source: $ref: examples/AccountVerify.ts - lang: Java label: Java source: $ref: examples/AccountVerify.java - lang: Ruby label: Ruby source: $ref: examples/AccountVerify.rb - lang: Python label: Python source: $ref: examples/AccountVerify.py - lang: cURL label: cURL source: $ref: examples/AccountVerify.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to verify whether an Account exists, click here.' /api_app: post: tags: - 'Api App' summary: 'Create API App' description: 'Creates a new API App.' operationId: apiAppCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: default_example: $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' responses: 201: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: default_example: $ref: '#/components/examples/ApiAppCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppCreate.ts - lang: Java label: Java source: $ref: examples/ApiAppCreate.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppCreate.rb - lang: Python label: Python source: $ref: examples/ApiAppCreate.py - lang: cURL label: cURL source: $ref: examples/ApiAppCreate.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to create a new API App, click here.' '/api_app/{client_id}': get: tags: - 'Api App' summary: 'Get API App' description: 'Returns an object with information about an API App.' operationId: apiAppGet parameters: - name: client_id in: path description: 'The client id of the API App to retrieve.' required: true schema: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: default_example: $ref: '#/components/examples/ApiAppGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppGet.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppGet.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppGet.ts - lang: Java label: Java source: $ref: examples/ApiAppGet.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppGet.rb - lang: Python label: Python source: $ref: examples/ApiAppGet.py - lang: cURL label: cURL source: $ref: examples/ApiAppGet.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return an object with information about an API App, click here.' put: tags: - 'Api App' summary: 'Update API App' description: 'Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.' operationId: apiAppUpdate parameters: - name: client_id in: path description: 'The client id of the API App to update.' required: true schema: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: default_example: $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: default_example: $ref: '#/components/examples/ApiAppUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppUpdate.ts - lang: Java label: Java source: $ref: examples/ApiAppUpdate.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppUpdate.rb - lang: Python label: Python source: $ref: examples/ApiAppUpdate.py - lang: cURL label: cURL source: $ref: examples/ApiAppUpdate.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to update an App that you own, click here.' delete: tags: - 'Api App' summary: 'Delete API App' description: 'Deletes an API App. Can only be invoked for apps you own.' operationId: apiAppDelete parameters: - name: client_id in: path description: 'The client id of the API App to delete.' required: true schema: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: 204: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppDelete.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppDelete.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppDelete.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppDelete.ts - lang: Java label: Java source: $ref: examples/ApiAppDelete.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppDelete.rb - lang: Python label: Python source: $ref: examples/ApiAppDelete.py - lang: cURL label: cURL source: $ref: examples/ApiAppDelete.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations with a wide range of tools. To find out how to delete an API App, click here.' /api_app/list: get: tags: - 'Api App' summary: 'List API Apps' description: 'Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.' operationId: apiAppList parameters: - name: page in: query description: 'Which page number of the API App List to return. Defaults to `1`.' schema: type: integer default: 1 - name: page_size in: query description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: default_example: $ref: '#/components/examples/ApiAppListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - api_app_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ApiAppList.php - lang: 'C#' label: 'C#' source: $ref: examples/ApiAppList.cs - lang: JavaScript label: JavaScript source: $ref: examples/ApiAppList.js - lang: TypeScript label: TypeScript source: $ref: examples/ApiAppList.ts - lang: Java label: Java source: $ref: examples/ApiAppList.java - lang: Ruby label: Ruby source: $ref: examples/ApiAppList.rb - lang: Python label: Python source: $ref: examples/ApiAppList.py - lang: cURL label: cURL source: $ref: examples/ApiAppList.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to return a list of API Apps that are accessible by you, click here.' '/bulk_send_job/{bulk_send_job_id}': get: tags: - 'Bulk Send Job' summary: 'Get Bulk Send Job' description: 'Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.' operationId: bulkSendJobGet parameters: - name: bulk_send_job_id in: path description: 'The id of the BulkSendJob to retrieve.' required: true schema: type: string example: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174 - name: page in: query description: 'Which page number of the BulkSendJob list to return. Defaults to `1`.' schema: type: integer default: 1 - name: page_size in: query description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.' schema: type: integer default: 20 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: default_example: $ref: '#/components/examples/BulkSendJobGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/BulkSendJobGet.php - lang: 'C#' label: 'C#' source: $ref: examples/BulkSendJobGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/BulkSendJobGet.js - lang: TypeScript label: TypeScript source: $ref: examples/BulkSendJobGet.ts - lang: Java label: Java source: $ref: examples/BulkSendJobGet.java - lang: Ruby label: Ruby source: $ref: examples/BulkSendJobGet.rb - lang: Python label: Python source: $ref: examples/BulkSendJobGet.py - lang: cURL label: cURL source: $ref: examples/BulkSendJobGet.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of the BulkSendJob and SignatureRequests, click here.' /bulk_send_job/list: get: tags: - 'Bulk Send Job' summary: 'List Bulk Send Jobs' description: 'Returns a list of BulkSendJob that you can access.' operationId: bulkSendJobList parameters: - name: page in: query description: 'Which page number of the BulkSendJob List to return. Defaults to `1`.' schema: type: integer default: 1 - name: page_size in: query description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is 20.' schema: type: integer default: 20 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: default_example: $ref: '#/components/examples/BulkSendJobListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/BulkSendJobList.php - lang: 'C#' label: 'C#' source: $ref: examples/BulkSendJobList.cs - lang: JavaScript label: JavaScript source: $ref: examples/BulkSendJobList.js - lang: TypeScript label: TypeScript source: $ref: examples/BulkSendJobList.ts - lang: Java label: Java source: $ref: examples/BulkSendJobList.java - lang: Ruby label: Ruby source: $ref: examples/BulkSendJobList.rb - lang: Python label: Python source: $ref: examples/BulkSendJobList.py - lang: cURL label: cURL source: $ref: examples/BulkSendJobList.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of BulkSendJob that you can access, click here.' '/embedded/edit_url/{template_id}': post: tags: - Embedded summary: 'Get Embedded Template Edit URL' description: 'Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.' operationId: embeddedEditUrl parameters: - name: template_id in: path description: 'The id of the template to edit.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: default_example: $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: default_example: $ref: '#/components/examples/EmbeddedEditUrlResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/EmbeddedEditUrl.php - lang: 'C#' label: 'C#' source: $ref: examples/EmbeddedEditUrl.cs - lang: JavaScript label: JavaScript source: $ref: examples/EmbeddedEditUrl.js - lang: TypeScript label: TypeScript source: $ref: examples/EmbeddedEditUrl.ts - lang: Java label: Java source: $ref: examples/EmbeddedEditUrl.java - lang: Ruby label: Ruby source: $ref: examples/EmbeddedEditUrl.rb - lang: Python label: Python source: $ref: examples/EmbeddedEditUrl.py - lang: cURL label: cURL source: $ref: examples/EmbeddedEditUrl.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a template url, click here.' '/embedded/sign_url/{signature_id}': get: tags: - Embedded summary: 'Get Embedded Sign URL' description: 'Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.' operationId: embeddedSignUrl parameters: - name: signature_id in: path description: 'The id of the signature to get a signature url for.' required: true schema: type: string example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: default_example: $ref: '#/components/examples/EmbeddedSignUrlResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/EmbeddedSignUrl.php - lang: 'C#' label: 'C#' source: $ref: examples/EmbeddedSignUrl.cs - lang: JavaScript label: JavaScript source: $ref: examples/EmbeddedSignUrl.js - lang: TypeScript label: TypeScript source: $ref: examples/EmbeddedSignUrl.ts - lang: Java label: Java source: $ref: examples/EmbeddedSignUrl.java - lang: Ruby label: Ruby source: $ref: examples/EmbeddedSignUrl.rb - lang: Python label: Python source: $ref: examples/EmbeddedSignUrl.py - lang: cURL label: cURL source: $ref: examples/EmbeddedSignUrl.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.' /oauth/token: post: tags: - OAuth summary: 'OAuth Token Generate' description: 'Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.' operationId: oauthTokenGenerate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateRequestExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: default_example: $ref: '#/components/examples/OAuthTokenGenerateResponseExample' security: [] servers: - url: 'https://app.hellosign.com' x-codeSamples: - lang: PHP label: PHP source: $ref: examples/OauthTokenGenerate.php - lang: 'C#' label: 'C#' source: $ref: examples/OauthTokenGenerate.cs - lang: JavaScript label: JavaScript source: $ref: examples/OauthTokenGenerate.js - lang: TypeScript label: TypeScript source: $ref: examples/OauthTokenGenerate.ts - lang: Java label: Java source: $ref: examples/OauthTokenGenerate.java - lang: Ruby label: Ruby source: $ref: examples/OauthTokenGenerate.rb - lang: Python label: Python source: $ref: examples/OauthTokenGenerate.py - lang: cURL label: cURL source: $ref: examples/OauthTokenGenerate.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to generate a new OAuth token with the API, click here.' x-hideTryItPanel: true '/oauth/token?refresh': post: tags: - OAuth summary: 'OAuth Token Refresh' description: 'Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.' operationId: oauthTokenRefresh requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshRequestExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: default_example: $ref: '#/components/examples/OAuthTokenRefreshResponseExample' security: [] servers: - url: 'https://app.hellosign.com' x-codeSamples: - lang: PHP label: PHP source: $ref: examples/OauthTokenRefresh.php - lang: 'C#' label: 'C#' source: $ref: examples/OauthTokenRefresh.cs - lang: JavaScript label: JavaScript source: $ref: examples/OauthTokenRefresh.js - lang: TypeScript label: TypeScript source: $ref: examples/OauthTokenRefresh.ts - lang: Java label: Java source: $ref: examples/OauthTokenRefresh.java - lang: Ruby label: Ruby source: $ref: examples/OauthTokenRefresh.rb - lang: Python label: Python source: $ref: examples/OauthTokenRefresh.py - lang: cURL label: cURL source: $ref: examples/OauthTokenRefresh.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to refresh your OAuth token with the API, click here.' x-hideTryItPanel: true /report/create: post: tags: - Report summary: 'Create Report' description: |- Request the creation of one or more report(s). When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past. operationId: reportCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: default_example: $ref: '#/components/examples/ReportCreateRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: default_example: $ref: '#/components/examples/ReportCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] x-codeSamples: - lang: PHP label: PHP source: $ref: examples/ReportCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/ReportCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/ReportCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/ReportCreate.ts - lang: Java label: Java source: $ref: examples/ReportCreate.java - lang: Ruby label: Ruby source: $ref: examples/ReportCreate.rb - lang: Python label: Python source: $ref: examples/ReportCreate.py - lang: cURL label: cURL source: $ref: examples/ReportCreate.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to request the creation of one or more reports, click here.' /signature_request/bulk_create_embedded_with_template: post: tags: - 'Signature Request' summary: 'Embedded Bulk Send with Template' description: |- Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher. operationId: signatureRequestBulkCreateEmbeddedWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create embedded BulkSendJob signature requests, click here.' /signature_request/bulk_send_with_template: post: tags: - 'Signature Request' summary: 'Bulk Send with Template' description: |- Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher. operationId: signatureRequestBulkSendWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestBulkSendWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestBulkSendWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestBulkSendWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestBulkSendWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestBulkSendWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestBulkSendWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestBulkSendWithTemplate.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestBulkSendWithTemplate.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to create BulkSendJob for up to 250 signature requests, click here.' '/signature_request/cancel/{signature_request_id}': post: tags: - 'Signature Request' summary: 'Cancel Incomplete Signature Request' description: |- Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`. operationId: signatureRequestCancel parameters: - name: signature_request_id in: path description: 'The id of the incomplete SignatureRequest to cancel.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestCancel.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestCancel.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestCancel.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestCancel.ts - lang: Java label: Java source: $ref: examples/SignatureRequestCancel.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestCancel.rb - lang: Python label: Python source: $ref: examples/SignatureRequestCancel.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestCancel.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to cancel an incomplete signature request, click here.' /signature_request/create_embedded: post: tags: - 'Signature Request' summary: 'Create Embedded Signature Request' description: 'Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.' operationId: signatureRequestCreateEmbedded requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' grouped_signers_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestCreateEmbedded.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestCreateEmbedded.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestCreateEmbedded.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestCreateEmbedded.ts - lang: Java label: Java source: $ref: examples/SignatureRequestCreateEmbedded.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestCreateEmbedded.rb - lang: Python label: Python source: $ref: examples/SignatureRequestCreateEmbedded.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestCreateEmbedded.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new SignatureRequest in an iFrame, click here.' /signature_request/create_embedded_with_template: post: tags: - 'Signature Request' summary: 'Create Embedded Signature Request with Template' description: '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: signatureRequestCreateEmbeddedWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.' '/signature_request/files/{signature_request_id}': get: tags: - 'Signature Request' summary: 'Download Files' description: |- Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. operationId: signatureRequestFiles parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - name: file_type in: query description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string default: pdf enum: - pdf - zip responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/pdf: schema: type: string format: binary application/zip: schema: type: string format: binary 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestFiles.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestFiles.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestFiles.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestFiles.ts - lang: Java label: Java source: $ref: examples/SignatureRequestFiles.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestFiles.rb - lang: Python label: Python source: $ref: examples/SignatureRequestFiles.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestFiles.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' '/signature_request/files_as_data_uri/{signature_request_id}': get: tags: - 'Signature Request' summary: 'Download Files as Data Uri' description: |- Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. operationId: signatureRequestFilesAsDataUri parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: default_example: $ref: '#/components/examples/SignatureRequestFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestFilesAsDataUri.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestFilesAsDataUri.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestFilesAsDataUri.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestFilesAsDataUri.ts - lang: Java label: Java source: $ref: examples/SignatureRequestFilesAsDataUri.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestFilesAsDataUri.rb - lang: Python label: Python source: $ref: examples/SignatureRequestFilesAsDataUri.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestFilesAsDataUri.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' '/signature_request/files_as_file_url/{signature_request_id}': get: tags: - 'Signature Request' summary: 'Download Files as File Url' description: |- Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. operationId: signatureRequestFilesAsFileUrl parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - name: force_download in: query description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' schema: type: integer default: 1 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/FileResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestFilesAsFileUrl.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestFilesAsFileUrl.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestFilesAsFileUrl.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestFilesAsFileUrl.ts - lang: Java label: Java source: $ref: examples/SignatureRequestFilesAsFileUrl.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestFilesAsFileUrl.rb - lang: Python label: Python source: $ref: examples/SignatureRequestFilesAsFileUrl.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestFilesAsFileUrl.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' '/signature_request/{signature_request_id}': get: tags: - 'Signature Request' summary: 'Get Signature Request' description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' operationId: signatureRequestGet parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestGet.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestGet.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestGet.ts - lang: Java label: Java source: $ref: examples/SignatureRequestGet.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestGet.rb - lang: Python label: Python source: $ref: examples/SignatureRequestGet.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestGet.sh x-meta: seo: title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' /signature_request/list: get: tags: - 'Signature Request' summary: 'List Signature Requests' description: |- Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. operationId: signatureRequestList parameters: - name: account_id in: query description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' schema: type: string - name: page in: query description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' schema: type: integer default: 1 example: 1 - name: page_size in: query description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 - name: query in: query description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' schema: type: string responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestList.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestList.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestList.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestList.ts - lang: Java label: Java source: $ref: examples/SignatureRequestList.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestList.rb - lang: Python label: Python source: $ref: examples/SignatureRequestList.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestList.sh x-meta: seo: title: 'List Signature Requests | REST API | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' '/signature_request/release_hold/{signature_request_id}': post: tags: - 'Signature Request' summary: 'Release On-Hold Signature Request' description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.' operationId: signatureRequestReleaseHold parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to release.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestReleaseHold.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestReleaseHold.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestReleaseHold.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestReleaseHold.ts - lang: Java label: Java source: $ref: examples/SignatureRequestReleaseHold.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestReleaseHold.rb - lang: Python label: Python source: $ref: examples/SignatureRequestReleaseHold.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestReleaseHold.sh x-meta: seo: title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' '/signature_request/remind/{signature_request_id}': post: tags: - 'Signature Request' summary: 'Send Request Reminder' description: |- Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests. operationId: signatureRequestRemind parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to send a reminder for.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestRemindResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestRemind.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestRemind.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestRemind.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestRemind.ts - lang: Java label: Java source: $ref: examples/SignatureRequestRemind.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestRemind.rb - lang: Python label: Python source: $ref: examples/SignatureRequestRemind.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestRemind.sh x-meta: seo: title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' '/signature_request/remove/{signature_request_id}': post: tags: - 'Signature Request' summary: 'Remove Signature Request Access' description: |- Removes your access to a completed signature request. This action is **not reversible**. The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s). Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response. operationId: signatureRequestRemove parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to remove.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestRemove.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestRemove.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestRemove.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestRemove.ts - lang: Java label: Java source: $ref: examples/SignatureRequestRemove.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestRemove.rb - lang: Python label: Python source: $ref: examples/SignatureRequestRemove.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestRemove.sh x-meta: seo: title: 'Remove Signature Request Access | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' /signature_request/send: post: tags: - 'Signature Request' summary: 'Send Signature Request' description: 'Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.' operationId: signatureRequestSend requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' grouped_signers_example: $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestSendResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestSend.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestSend.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestSend.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestSend.ts - lang: Java label: Java source: $ref: examples/SignatureRequestSend.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestSend.rb - lang: Python label: Python source: $ref: examples/SignatureRequestSend.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestSend.sh x-meta: seo: title: 'Send Signature Request | REST API | Dropbox Sign for Developers' description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' /signature_request/send_with_template: post: tags: - 'Signature Request' summary: 'Send with Template' description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' operationId: signatureRequestSendWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestSendWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestSendWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestSendWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestSendWithTemplate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestSendWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestSendWithTemplate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestSendWithTemplate.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestSendWithTemplate.sh x-meta: seo: title: 'Send with Template | API Documentation | Dropbox Sign for Developers' description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' '/signature_request/update/{signature_request_id}': post: tags: - 'Signature Request' summary: 'Update Signature Request' description: |- Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. 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: signatureRequestUpdate parameters: - name: signature_request_id in: path description: 'The id of the SignatureRequest to update.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: default_example: $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: default_example: $ref: '#/components/examples/SignatureRequestUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/SignatureRequestUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/SignatureRequestUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/SignatureRequestUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/SignatureRequestUpdate.ts - lang: Java label: Java source: $ref: examples/SignatureRequestUpdate.java - lang: Ruby label: Ruby source: $ref: examples/SignatureRequestUpdate.rb - lang: Python label: Python source: $ref: examples/SignatureRequestUpdate.py - lang: cURL label: cURL source: $ref: examples/SignatureRequestUpdate.sh x-meta: seo: title: 'Update Signature Request | REST API | Dropbox Sign for Developers' description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' /team/add_member: put: tags: - Team summary: 'Add User to Team' description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.' operationId: teamAddMember parameters: - name: team_id in: query description: 'The id of the team.' required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: email_address: $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' account_id: $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamAddMemberResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamAddMember.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamAddMember.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamAddMember.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamAddMember.ts - lang: Java label: Java source: $ref: examples/TeamAddMember.java - lang: Ruby label: Ruby source: $ref: examples/TeamAddMember.rb - lang: Python label: Python source: $ref: examples/TeamAddMember.py - lang: cURL label: cURL source: $ref: examples/TeamAddMember.sh x-meta: seo: title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' /team/create: post: tags: - Team summary: 'Create Team' description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' operationId: teamCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: default_example: $ref: '#/components/examples/TeamCreateRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamCreate.ts - lang: Java label: Java source: $ref: examples/TeamCreate.java - lang: Ruby label: Ruby source: $ref: examples/TeamCreate.rb - lang: Python label: Python source: $ref: examples/TeamCreate.py - lang: cURL label: cURL source: $ref: examples/TeamCreate.sh x-meta: seo: title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' /team/destroy: delete: tags: - Team summary: 'Delete Team' description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' operationId: teamDelete responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamDelete.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamDelete.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamDelete.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamDelete.ts - lang: Java label: Java source: $ref: examples/TeamDelete.java - lang: Ruby label: Ruby source: $ref: examples/TeamDelete.rb - lang: Python label: Python source: $ref: examples/TeamDelete.py - lang: cURL label: cURL source: $ref: examples/TeamDelete.sh x-meta: seo: title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' /team: get: tags: - Team summary: 'Get Team' description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.' operationId: teamGet responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/TeamDoesNotExistResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamGet.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamGet.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamGet.ts - lang: Java label: Java source: $ref: examples/TeamGet.java - lang: Ruby label: Ruby source: $ref: examples/TeamGet.rb - lang: Python label: Python source: $ref: examples/TeamGet.py - lang: cURL label: cURL source: $ref: examples/TeamGet.sh x-meta: seo: title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' put: tags: - Team summary: 'Update Team' description: 'Updates the name of your Team.' operationId: teamUpdate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: default_example: $ref: '#/components/examples/TeamUpdateRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamUpdateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamUpdate.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamUpdate.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamUpdate.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamUpdate.ts - lang: Java label: Java source: $ref: examples/TeamUpdate.java - lang: Ruby label: Ruby source: $ref: examples/TeamUpdate.rb - lang: Python label: Python source: $ref: examples/TeamUpdate.py - lang: cURL label: cURL source: $ref: examples/TeamUpdate.sh x-meta: seo: title: 'Update Team | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' /team/info: get: tags: - Team summary: 'Get Team Info' description: 'Provides information about a team.' operationId: teamInfo parameters: - name: team_id in: query description: 'The id of the team.' required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: default_example: $ref: '#/components/examples/TeamGetInfoResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamInfo.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamInfo.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamInfo.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamInfo.ts - lang: Java label: Java source: $ref: examples/TeamInfo.java - lang: Ruby label: Ruby source: $ref: examples/TeamInfo.rb - lang: Python label: Python source: $ref: examples/TeamInfo.py - lang: cURL label: cURL source: $ref: examples/TeamInfo.sh x-meta: seo: title: 'Get Team Info | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' /team/invites: get: tags: - Team summary: 'List Team Invites' description: 'Provides a list of team invites (and their roles).' operationId: teamInvites parameters: - name: email_address in: query description: 'The email address for which to display the team invites.' required: false schema: type: string responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamInvitesResponse' examples: default_example: $ref: '#/components/examples/TeamInvitesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - account_access - basic_account_info x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamInvites.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamInvites.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamInvites.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamInvites.ts - lang: Java label: Java source: $ref: examples/TeamInvites.java - lang: Ruby label: Ruby source: $ref: examples/TeamInvites.rb - lang: Python label: Python source: $ref: examples/TeamInvites.py - lang: cURL label: cURL source: $ref: examples/TeamInvites.sh x-meta: seo: title: 'List Team Invites | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' '/team/members/{team_id}': get: tags: - Team summary: 'List Team Members' description: 'Provides a paginated list of members (and their roles) that belong to a given team.' operationId: teamMembers parameters: - name: team_id in: path description: 'The id of the team that a member list is being requested from.' required: true schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - name: page in: query description: 'Which page number of the team member list to return. Defaults to `1`.' schema: type: integer default: 1 - name: page_size in: query description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 maximum: 100 minimum: 1 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: default_example: $ref: '#/components/examples/TeamMembersResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamMembers.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamMembers.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamMembers.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamMembers.ts - lang: Java label: Java source: $ref: examples/TeamMembers.java - lang: Ruby label: Ruby source: $ref: examples/TeamMembers.rb - lang: Python label: Python source: $ref: examples/TeamMembers.py - lang: cURL label: cURL source: $ref: examples/TeamMembers.sh x-meta: seo: title: 'List Team Members | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' /team/remove_member: post: tags: - Team summary: 'Remove User from Team' description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.' operationId: teamRemoveMember requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: email_address: $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' account_id: $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' responses: 201: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamGetResponse' examples: default_example: $ref: '#/components/examples/TeamRemoveMemberResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamRemoveMember.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamRemoveMember.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamRemoveMember.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamRemoveMember.ts - lang: Java label: Java source: $ref: examples/TeamRemoveMember.java - lang: Ruby label: Ruby source: $ref: examples/TeamRemoveMember.rb - lang: Python label: Python source: $ref: examples/TeamRemoveMember.py - lang: cURL label: cURL source: $ref: examples/TeamRemoveMember.sh x-meta: seo: title: 'Remove User from Team | REST API | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' '/team/sub_teams/{team_id}': get: tags: - Team summary: 'List Sub Teams' description: 'Provides a paginated list of sub teams that belong to a given team.' operationId: teamSubTeams parameters: - name: team_id in: path description: 'The id of the parent Team.' required: true schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - name: page in: query description: 'Which page number of the SubTeam List to return. Defaults to `1`.' schema: type: integer default: 1 - name: page_size in: query description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 maximum: 100 minimum: 1 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: default_example: $ref: '#/components/examples/TeamSubTeamsResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - team_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TeamSubTeams.php - lang: 'C#' label: 'C#' source: $ref: examples/TeamSubTeams.cs - lang: JavaScript label: JavaScript source: $ref: examples/TeamSubTeams.js - lang: TypeScript label: TypeScript source: $ref: examples/TeamSubTeams.ts - lang: Java label: Java source: $ref: examples/TeamSubTeams.java - lang: Ruby label: Ruby source: $ref: examples/TeamSubTeams.rb - lang: Python label: Python source: $ref: examples/TeamSubTeams.py - lang: cURL label: cURL source: $ref: examples/TeamSubTeams.sh x-meta: seo: title: 'List Sub Teams | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' '/template/add_user/{template_id}': post: tags: - Template summary: 'Add User to Template' description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' operationId: templateAddUser parameters: - name: template_id in: path description: 'The id of the Template to give the Account access to.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: default_example: $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: $ref: '#/components/examples/TemplateAddUserResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateAddUser.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateAddUser.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateAddUser.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateAddUser.ts - lang: Java label: Java source: $ref: examples/TemplateAddUser.java - lang: Ruby label: Ruby source: $ref: examples/TemplateAddUser.rb - lang: Python label: Python source: $ref: examples/TemplateAddUser.py - lang: cURL label: cURL source: $ref: examples/TemplateAddUser.sh x-meta: seo: title: 'Add User to Template | REST API | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' /template/create: post: tags: - Template summary: 'Create Template' description: 'Creates a template that can then be used.' operationId: templateCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateCreateRequest' examples: default_example: $ref: '#/components/examples/TemplateCreateRequestDefaultExample' form_fields_per_document: $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' form_field_groups: $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' form_field_rules: $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateCreateResponse' examples: default_example: $ref: '#/components/examples/TemplateCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateCreate.ts - lang: Java label: Java source: $ref: examples/TemplateCreate.java - lang: Ruby label: Ruby source: $ref: examples/TemplateCreate.rb - lang: Python label: Python source: $ref: examples/TemplateCreate.py - lang: cURL label: cURL source: $ref: examples/TemplateCreate.sh x-meta: seo: title: 'Create Template | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' /template/create_embedded_draft: post: tags: - Template summary: 'Create Embedded Template Draft' description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' operationId: templateCreateEmbeddedDraft requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: default_example: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' form_fields_per_document: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' form_field_groups: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' form_field_rules: $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: default_example: $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateCreateEmbeddedDraft.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateCreateEmbeddedDraft.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateCreateEmbeddedDraft.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateCreateEmbeddedDraft.ts - lang: Java label: Java source: $ref: examples/TemplateCreateEmbeddedDraft.java - lang: Ruby label: Ruby source: $ref: examples/TemplateCreateEmbeddedDraft.rb - lang: Python label: Python source: $ref: examples/TemplateCreateEmbeddedDraft.py - lang: cURL label: cURL source: $ref: examples/TemplateCreateEmbeddedDraft.sh x-meta: seo: title: 'Create Embedded Template Draft | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' '/template/delete/{template_id}': post: tags: - Template summary: 'Delete Template' description: 'Completely deletes the template specified from the account.' operationId: templateDelete parameters: - name: template_id in: path description: 'The id of the Template to delete.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateDelete.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateDelete.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateDelete.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateDelete.ts - lang: Java label: Java source: $ref: examples/TemplateDelete.java - lang: Ruby label: Ruby source: $ref: examples/TemplateDelete.rb - lang: Python label: Python source: $ref: examples/TemplateDelete.py - lang: cURL label: cURL source: $ref: examples/TemplateDelete.sh x-meta: seo: title: 'Delete Template | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' '/template/files/{template_id}': get: tags: - Template summary: 'Get Template Files' description: |- Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. operationId: templateFiles parameters: - name: template_id in: path description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - name: file_type in: query description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string enum: - pdf - zip responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/pdf: schema: type: string format: binary application/zip: schema: type: string format: binary 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 422_example: $ref: '#/components/examples/Error422ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateFiles.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateFiles.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateFiles.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateFiles.ts - lang: Java label: Java source: $ref: examples/TemplateFiles.java - lang: Ruby label: Ruby source: $ref: examples/TemplateFiles.rb - lang: Python label: Python source: $ref: examples/TemplateFiles.py - lang: cURL label: cURL source: $ref: examples/TemplateFiles.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' '/template/files_as_data_uri/{template_id}': get: tags: - Template summary: 'Get Template Files as Data Uri' description: |- Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. operationId: templateFilesAsDataUri parameters: - name: template_id in: path description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: default_example: $ref: '#/components/examples/TemplateFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 422_example: $ref: '#/components/examples/Error422ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateFilesAsDataUri.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateFilesAsDataUri.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateFilesAsDataUri.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateFilesAsDataUri.ts - lang: Java label: Java source: $ref: examples/TemplateFilesAsDataUri.java - lang: Ruby label: Ruby source: $ref: examples/TemplateFilesAsDataUri.rb - lang: Python label: Python source: $ref: examples/TemplateFilesAsDataUri.py - lang: cURL label: cURL source: $ref: examples/TemplateFilesAsDataUri.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' '/template/files_as_file_url/{template_id}': get: tags: - Template summary: 'Get Template Files as File Url' description: |- Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event. operationId: templateFilesAsFileUrl parameters: - name: template_id in: path description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - name: force_download in: query description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.' schema: type: integer default: 1 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/FileResponse' examples: default_example: $ref: '#/components/examples/TemplateFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 422_example: $ref: '#/components/examples/Error422ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateFilesAsFileUrl.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateFilesAsFileUrl.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateFilesAsFileUrl.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateFilesAsFileUrl.ts - lang: Java label: Java source: $ref: examples/TemplateFilesAsFileUrl.java - lang: Ruby label: Ruby source: $ref: examples/TemplateFilesAsFileUrl.rb - lang: Python label: Python source: $ref: examples/TemplateFilesAsFileUrl.py - lang: cURL label: cURL source: $ref: examples/TemplateFilesAsFileUrl.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' '/template/{template_id}': get: tags: - Template summary: 'Get Template' description: 'Returns the Template specified by the `template_id` parameter.' operationId: templateGet parameters: - name: template_id in: path description: 'The id of the Template to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: $ref: '#/components/examples/TemplateGetResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateGet.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateGet.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateGet.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateGet.ts - lang: Java label: Java source: $ref: examples/TemplateGet.java - lang: Ruby label: Ruby source: $ref: examples/TemplateGet.rb - lang: Python label: Python source: $ref: examples/TemplateGet.py - lang: cURL label: cURL source: $ref: examples/TemplateGet.sh x-meta: seo: title: 'Get Template | API Documentation | Dropbox Sign for Developers' description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' /template/list: get: tags: - Template summary: 'List Templates' description: |- Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. operationId: templateList parameters: - name: account_id in: query description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' schema: type: string - name: page in: query description: 'Which page number of the Template List to return. Defaults to `1`.' schema: type: integer default: 1 - name: page_size in: query description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 maximum: 100 minimum: 1 - name: query in: query description: 'String that includes search terms and/or fields to be used to filter the Template objects.' schema: type: string responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateListResponse' examples: default_example: $ref: '#/components/examples/TemplateListResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateList.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateList.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateList.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateList.ts - lang: Java label: Java source: $ref: examples/TemplateList.java - lang: Ruby label: Ruby source: $ref: examples/TemplateList.rb - lang: Python label: Python source: $ref: examples/TemplateList.py - lang: cURL label: cURL source: $ref: examples/TemplateList.sh x-meta: seo: title: 'List Templates | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' '/template/remove_user/{template_id}': post: tags: - Template summary: 'Remove User from Template' description: 'Removes the specified Account''s access to the specified Template.' operationId: templateRemoveUser parameters: - name: template_id in: path description: 'The id of the Template to remove the Account''s access to.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: default_example: $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: default_example: $ref: '#/components/examples/TemplateRemoveUserResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateRemoveUser.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateRemoveUser.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateRemoveUser.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateRemoveUser.ts - lang: Java label: Java source: $ref: examples/TemplateRemoveUser.java - lang: Ruby label: Ruby source: $ref: examples/TemplateRemoveUser.rb - lang: Python label: Python source: $ref: examples/TemplateRemoveUser.py - lang: cURL label: cURL source: $ref: examples/TemplateRemoveUser.sh x-meta: seo: title: 'Remove User from Template | REST API | Dropbox Sign for Developers' description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' '/template/update_files/{template_id}': post: tags: - Template summary: 'Update Template Files' description: |- Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough). operationId: templateUpdateFiles parameters: - name: template_id in: path description: 'The ID of the template whose files to update.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: default_example: $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: default_example: $ref: '#/components/examples/TemplateUpdateFilesResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - template_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/TemplateUpdateFiles.php - lang: 'C#' label: 'C#' source: $ref: examples/TemplateUpdateFiles.cs - lang: JavaScript label: JavaScript source: $ref: examples/TemplateUpdateFiles.js - lang: TypeScript label: TypeScript source: $ref: examples/TemplateUpdateFiles.ts - lang: Java label: Java source: $ref: examples/TemplateUpdateFiles.java - lang: Ruby label: Ruby source: $ref: examples/TemplateUpdateFiles.rb - lang: Python label: Python source: $ref: examples/TemplateUpdateFiles.py - lang: cURL label: cURL source: $ref: examples/TemplateUpdateFiles.sh x-meta: seo: title: 'Update Template Files | REST API | Dropbox Sign for Developers' description: 'Overlays a new file with the overlay of an existing template' /unclaimed_draft/create: post: tags: - 'Unclaimed Draft' summary: 'Create Unclaimed Draft' description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.' operationId: unclaimedDraftCreate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' form_fields_per_document: $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' form_field_groups: $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' form_field_rules: $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftCreate.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftCreate.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftCreate.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftCreate.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftCreate.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftCreate.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftCreate.py - lang: cURL label: cURL source: $ref: examples/UnclaimedDraftCreate.sh x-meta: seo: title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' /unclaimed_draft/create_embedded: post: tags: - 'Unclaimed Draft' summary: 'Create Embedded Unclaimed Draft' description: |- Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. operationId: unclaimedDraftCreateEmbedded requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' form_fields_per_document: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' form_field_groups: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' form_field_rules: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftCreateEmbedded.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftCreateEmbedded.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftCreateEmbedded.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftCreateEmbedded.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftCreateEmbedded.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftCreateEmbedded.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftCreateEmbedded.py - lang: cURL label: cURL source: $ref: examples/UnclaimedDraftCreateEmbedded.sh x-meta: seo: title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' /unclaimed_draft/create_embedded_with_template: post: tags: - 'Unclaimed Draft' summary: 'Create Embedded Unclaimed Draft with Template' description: |- Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. operationId: unclaimedDraftCreateEmbeddedWithTemplate requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 429_example: $ref: '#/components/examples/Error429ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py - lang: cURL label: cURL source: $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh x-meta: seo: title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' '/unclaimed_draft/edit_and_resend/{signature_request_id}': post: tags: - 'Unclaimed Draft' summary: 'Edit and Resend Unclaimed Draft' description: |- Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. operationId: unclaimedDraftEditAndResend parameters: - name: signature_request_id in: path description: 'The ID of the signature request to edit and resend.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' responses: 200: description: 'successful operation' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: default_example: $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' 4XX: description: failed_operation content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: $ref: '#/components/examples/Error400ResponseExample' 401_example: $ref: '#/components/examples/Error401ResponseExample' 402_example: $ref: '#/components/examples/Error402ResponseExample' 403_example: $ref: '#/components/examples/Error403ResponseExample' 404_example: $ref: '#/components/examples/Error404ResponseExample' 409_example: $ref: '#/components/examples/Error409ResponseExample' 410_example: $ref: '#/components/examples/Error410ResponseExample' 4XX_example: $ref: '#/components/examples/Error4XXResponseExample' security: - api_key: [] - oauth2: - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: $ref: examples/UnclaimedDraftEditAndResend.php - lang: 'C#' label: 'C#' source: $ref: examples/UnclaimedDraftEditAndResend.cs - lang: JavaScript label: JavaScript source: $ref: examples/UnclaimedDraftEditAndResend.js - lang: TypeScript label: TypeScript source: $ref: examples/UnclaimedDraftEditAndResend.ts - lang: Java label: Java source: $ref: examples/UnclaimedDraftEditAndResend.java - lang: Ruby label: Ruby source: $ref: examples/UnclaimedDraftEditAndResend.rb - lang: Python label: Python source: $ref: examples/UnclaimedDraftEditAndResend.py - lang: cURL label: cURL source: $ref: examples/UnclaimedDraftEditAndResend.sh x-meta: seo: title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' components: schemas: AccountCreateRequest: required: - email_address properties: client_id: description: |- Used when creating a new account with OAuth authorization. See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) type: string client_secret: description: |- Used when creating a new account with OAuth authorization. See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) type: string email_address: description: 'The email address which will be associated with the new Account.' type: string format: email locale: 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.' type: string type: object AccountUpdateRequest: properties: account_id: description: 'The ID of the Account' type: string nullable: true callback_url: description: 'The URL that Dropbox Sign should POST events to.' type: string locale: 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.' type: string type: object AccountVerifyRequest: required: - email_address properties: email_address: description: 'Email address to run the verification for.' type: string format: email type: object ApiAppCreateRequest: required: - name - domains properties: callback_url: description: 'The URL at which the ApiApp should receive event callbacks.' type: string custom_logo_file: description: 'An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)' type: string format: binary domains: description: 'The domain names the ApiApp will be associated with.' type: array items: type: string maxItems: 2 minItems: 1 name: description: 'The name you want to assign to the ApiApp.' type: string oauth: $ref: '#/components/schemas/SubOAuth' options: $ref: '#/components/schemas/SubOptions' white_labeling_options: $ref: '#/components/schemas/SubWhiteLabelingOptions' type: object ApiAppUpdateRequest: properties: callback_url: description: 'The URL at which the API App should receive event callbacks.' type: string custom_logo_file: description: 'An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)' type: string format: binary domains: description: 'The domain names the ApiApp will be associated with.' type: array items: type: string maxItems: 2 name: description: 'The name you want to assign to the ApiApp.' type: string oauth: $ref: '#/components/schemas/SubOAuth' options: $ref: '#/components/schemas/SubOptions' white_labeling_options: $ref: '#/components/schemas/SubWhiteLabelingOptions' type: object EmbeddedEditUrlRequest: properties: allow_edit_ccs: description: 'This allows the requester to enable/disable to add or change CC roles when editing the template.' type: boolean default: false cc_roles: 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.' type: array items: type: string editor_options: $ref: '#/components/schemas/SubEditorOptions' force_signer_roles: description: 'Provide users the ability to review/edit the template signer roles.' type: boolean default: false force_subject_message: description: 'Provide users the ability to review/edit the template subject and message.' type: boolean default: false merge_fields: 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. Remove all merge fields on the template by passing an empty array `[]`. type: array items: $ref: '#/components/schemas/SubMergeField' preview_only: 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). **NOTE:** This parameter overwrites `show_preview=true` (if set). type: boolean default: false show_preview: description: 'This allows the requester to enable the editor/preview experience.' type: boolean default: false show_progress_stepper: description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.' type: boolean default: true test_mode: description: 'Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.' type: boolean default: false type: object OAuthTokenGenerateRequest: required: - client_id - client_secret - code - state - grant_type properties: client_id: description: 'The client id of the app requesting authorization.' type: string client_secret: description: 'The secret token of your app.' type: string code: description: 'The code passed to your callback when the user granted access.' type: string grant_type: description: 'When generating a new token use `authorization_code`.' type: string default: authorization_code state: description: 'Same as the state you specified earlier.' type: string type: object OAuthTokenRefreshRequest: required: - grant_type - refresh_token properties: grant_type: description: 'When refreshing an existing token use `refresh_token`.' type: string default: refresh_token refresh_token: description: 'The token provided when you got the expired access token.' type: string type: object ReportCreateRequest: required: - start_date - end_date - report_type properties: end_date: description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.' type: string report_type: 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).' type: array items: type: string enum: - user_activity - document_status maxItems: 2 minItems: 1 start_date: description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.' type: string type: object SignatureRequestBulkCreateEmbeddedWithTemplateRequest: required: - client_id - template_ids properties: template_ids: description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' type: array items: type: string signer_file: 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: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) 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). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` type: string format: binary signer_list: 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.' type: array items: $ref: '#/components/schemas/SubBulkSignerList' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false ccs: description: 'Add CC email recipients. Required when a CC role exists for the Template.' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' type: string custom_fields: description: |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. type: array items: $ref: '#/components/schemas/SubCustomField' message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 255 test_mode: description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 type: object SignatureRequestBulkSendWithTemplateRequest: required: - template_ids properties: template_ids: description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' type: array items: type: string signer_file: 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: - `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) 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). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` type: string format: binary signer_list: 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.' type: array items: $ref: '#/components/schemas/SubBulkSignerList' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false ccs: description: 'Add CC email recipients. Required when a CC role exists for the Template.' type: array items: $ref: '#/components/schemas/SubCC' client_id: 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.' type: string custom_fields: description: |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. type: array items: $ref: '#/components/schemas/SubCustomField' message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 255 test_mode: description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 type: object SignatureRequestCreateEmbeddedRequest: required: - client_id properties: files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string signers: description: |- Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: description: |- Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. type: boolean default: false attachments: description: 'A list describing the attachments' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: 'The email addresses that should be CCed.' type: array items: type: string format: email client_id: description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' type: string custom_fields: description: |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. type: array items: $ref: '#/components/schemas/SubCustomField' field_options: $ref: '#/components/schemas/SubFieldOptions' form_field_groups: 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`.' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: |- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: |- Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. type: boolean default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} signing_options: $ref: '#/components/schemas/SubSigningOptions' subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 255 test_mode: description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 use_text_tags: 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`.' type: boolean default: false populate_auto_fill_fields: 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. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false expires_at: 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.' type: integer nullable: true type: object SignatureRequestCreateEmbeddedWithTemplateRequest: required: - client_id - template_ids - signers properties: template_ids: description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' type: array items: type: string allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false ccs: description: 'Add CC email recipients. Required when a CC role exists for the Template.' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' type: string custom_fields: description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' type: array items: $ref: '#/components/schemas/SubCustomField' files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} signers: description: 'Add Signers to your Templated-based Signature Request.' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 255 test_mode: description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 populate_auto_fill_fields: 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. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false type: object SignatureRequestRemindRequest: required: - email_address properties: email_address: description: 'The email address of the signer to send a reminder to.' type: string format: email name: description: 'The name of the signer to send a reminder to. Include if two or more signers share an email address.' type: string type: object SignatureRequestSendRequest: properties: files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string signers: description: |- Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' grouped_signers: description: |- Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. type: boolean default: false attachments: description: 'A list describing the attachments' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: 'The email addresses that should be CCed.' type: array items: type: string format: email client_id: description: '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.' type: string custom_fields: description: |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. type: array items: $ref: '#/components/schemas/SubCustomField' field_options: $ref: '#/components/schemas/SubFieldOptions' form_field_groups: 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`.' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: |- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: |- Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. type: boolean default: false is_qualified_signature: description: |- Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. type: boolean default: false deprecated: true x-hideOn: doc is_eid: description: |- Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. type: boolean default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 255 test_mode: description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 use_text_tags: 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`.' type: boolean default: false expires_at: 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.' type: integer nullable: true type: object SignatureRequestSendWithTemplateRequest: description: '' required: - signers - template_ids properties: template_ids: description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' type: array items: type: string allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false ccs: description: 'Add CC email recipients. Required when a CC role exists for the Template.' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: 'Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.' type: string custom_fields: description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' type: array items: $ref: '#/components/schemas/SubCustomField' files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string is_qualified_signature: description: |- Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.
**NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. type: boolean default: false deprecated: true x-hideOn: doc is_eid: description: |- Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. type: boolean default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} signers: description: 'Add Signers to your Templated-based Signature Request.' type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 255 test_mode: description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 type: object SignatureRequestUpdateRequest: required: - signature_id properties: email_address: description: |- The new email address for the recipient. This will generate a new `signature_id` value. **NOTE:** Optional if `name` is provided. type: string format: email name: description: |- The new name for the recipient. **NOTE:** Optional if `email_address` is provided. type: string signature_id: description: 'The signature ID for the recipient.' type: string expires_at: description: 'The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer nullable: true type: object SubAttachment: required: - name - signer_index properties: instructions: description: 'The instructions for uploading the attachment.' type: string name: description: 'The name of attachment.' type: string required: description: 'Determines if the attachment must be uploaded.' type: boolean default: false signer_index: description: |- The signer's index in the `signers` parameter (0-based indexing). **NOTE:** Only one signer can be assigned per attachment. type: integer type: object SubBulkSignerList: properties: custom_fields: description: 'An array of custom field values.' type: array items: $ref: '#/components/schemas/SubBulkSignerListCustomField' signers: description: |- Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document. Currently only templates with a single role are supported. All signers must have the same `role` value. type: array items: $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' type: object SubBulkSignerListCustomField: required: - name - value properties: name: description: 'The name of the custom field. Must be the field''s `name` or `api_id`.' type: string value: description: 'The value of the custom field.' type: string type: object SubCC: required: - role - email_address properties: role: description: 'Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.' type: string email_address: description: 'The email address of the CC recipient.' type: string format: email type: object SubCustomField: description: |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. required: - name properties: editor: description: |- Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. type: string name: description: 'The name of a custom field. When working with pre-filled data, the custom field''s name must have a matching merge field name or the field will remain empty on the document during signing.' type: string required: description: 'Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.' type: boolean default: false value: description: 'The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing.' type: string type: object SubEditorOptions: description: 'This allows the requester to specify editor options when a preparing a document' properties: allow_edit_signers: description: 'Allows requesters to edit the list of signers' type: boolean default: false allow_edit_documents: description: 'Allows requesters to edit documents, including delete and add' type: boolean default: false type: object SubFieldOptions: description: 'This allows the requester to specify field options for a signature request.' required: - date_format properties: date_format: description: |- Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher. type: string enum: - 'MM / DD / YYYY' - 'MM - DD - YYYY' - 'DD / MM / YYYY' - 'DD - MM - YYYY' - 'YYYY / MM / DD' - 'YYYY - MM - DD' x-enum-varnames: - MMDDYYYY - MM_DD_YYYY - DDMMYYYY - DD_MM_YYYY - YYYYMMDD - YYYY_MM_DD type: object SubFormFieldGroup: required: - group_id - group_label - requirement properties: group_id: description: 'ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`.' type: string group_label: description: 'Name of the group' type: string requirement: description: |- Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. type: string type: object SubFormFieldRule: required: - id - trigger_operator - triggers - actions properties: id: description: 'Must be unique across all defined rules.' type: string trigger_operator: description: 'Currently only `AND` is supported. Support for `OR` is being worked on.' type: string default: AND triggers: description: 'An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed.' type: array items: $ref: '#/components/schemas/SubFormFieldRuleTrigger' maxItems: 1 minItems: 1 actions: description: 'An array of action definitions, the "then that" part of "if this, **then that**". Any number of actions may be attached to a single rule.' type: array items: $ref: '#/components/schemas/SubFormFieldRuleAction' minItems: 1 type: object SubFormFieldRuleAction: required: - hidden - type properties: field_id: description: |- **field_id** or **group_id** is required, but not both. Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Cannot use with `group_id`. Trigger and action fields must belong to the same signer. type: string group_id: description: |- **group_id** or **field_id** is required, but not both. Must reference the ID of an existing group defined within `form_field_groups`. Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer. type: string hidden: description: '`true` to hide the target field when rule is satisfied, otherwise `false`.' type: boolean type: type: string enum: - change-field-visibility - change-group-visibility type: object SubFormFieldRuleTrigger: required: - id - operator properties: id: description: 'Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.' type: string operator: description: |- Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value type: string enum: - any - is - match - none - not value: description: |- **value** or **values** is required, but not both. The value to match against **operator**. - When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match` Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1` type: string values: description: |- **values** or **value** is required, but not both. The values to match against **operator** when it is one of the following: - `any` - `none` type: array items: type: string type: object SubFormFieldsPerDocumentCheckbox: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - is_checked properties: type: description: 'A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.' type: string default: checkbox group: description: 'String referencing group defined in `form_field_groups` parameter.' type: string is_checked: description: '`true` for checking the checkbox field by default, otherwise `false`.' type: boolean type: object SubFormFieldsPerDocumentCheckboxMerge: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: 'A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.' type: string default: checkbox-merge type: object SubFormFieldsPerDocumentDateSigned: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: 'A date. Use the `SubFormFieldsPerDocumentDateSigned` class.' type: string default: date_signed font_family: description: 'Font family for the field.' type: string enum: - helvetica - arial - courier - calibri - cambria - georgia - times - trebuchet - verdana - roboto - robotoMono - notoSans - notoSerif - notoCJK-JP-Regular - notoHebrew-Regular - notoSanThaiMerged font_size: description: |- The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. type: integer default: 12 type: object SubFormFieldsPerDocumentDropdown: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - options properties: type: description: 'An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.' type: string default: dropdown options: description: 'Array of string values representing dropdown values.' type: array items: type: string minItems: 1 content: description: 'Selected value in `options` array. Value must exist in array.' type: string font_family: description: 'Font family for the field.' type: string enum: - helvetica - arial - courier - calibri - cambria - georgia - times - trebuchet - verdana - roboto - robotoMono - notoSans - notoSerif - notoCJK-JP-Regular - notoHebrew-Regular - notoSanThaiMerged font_size: description: |- The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. type: integer default: 12 type: object SubFormFieldsPerDocumentHyperlink: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - content - content_url properties: type: description: 'A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.' type: string default: hyperlink content: description: 'Link Text.' type: string content_url: description: 'Link URL.' type: string font_family: description: 'Font family for the field.' type: string enum: - helvetica - arial - courier - calibri - cambria - georgia - times - trebuchet - verdana - roboto - robotoMono - notoSans - notoSerif - notoCJK-JP-Regular - notoHebrew-Regular - notoSanThaiMerged font_size: description: |- The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. type: integer default: 12 type: object SubFormFieldsPerDocumentInitials: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: 'An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.' type: string default: initials type: object SubFormFieldsPerDocumentRadio: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - group - is_checked properties: type: description: 'An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.' type: string default: radio group: description: 'String referencing group defined in `form_field_groups` parameter.' type: string is_checked: description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.' type: boolean type: object SubFormFieldsPerDocumentSignature: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: 'A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.' type: string default: signature type: object SubFormFieldsPerDocumentText: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type - options properties: type: description: 'A text input field. Use the `SubFormFieldsPerDocumentText` class.' type: string default: text placeholder: description: 'Placeholder value for text field.' type: string auto_fill_type: description: 'Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.' type: string link_id: description: 'Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.' type: string masked: description: 'Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.' type: boolean validation_type: description: |- Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. type: string enum: - numbers_only - letters_only - phone_number - bank_routing_number - bank_account_number - email_address - zip_code - social_security_number - employer_identification_number - custom_regex validation_custom_regex: type: string validation_custom_regex_format_label: type: string content: description: 'Content of a `me_now` text field' type: string font_family: description: 'Font family for the field.' type: string enum: - helvetica - arial - courier - calibri - cambria - georgia - times - trebuchet - verdana - roboto - robotoMono - notoSans - notoSerif - notoCJK-JP-Regular - notoHebrew-Regular - notoSanThaiMerged font_size: description: |- The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. type: integer default: 12 type: object SubFormFieldsPerDocumentTextMerge: description: 'This class extends `SubFormFieldsPerDocumentBase`.' allOf: - $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' - required: - type properties: type: description: 'A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.' type: string default: text-merge font_family: description: 'Font family for the field.' type: string enum: - helvetica - arial - courier - calibri - cambria - georgia - times - trebuchet - verdana - roboto - robotoMono - notoSans - notoSerif - notoCJK-JP-Regular - notoHebrew-Regular - notoSanThaiMerged font_size: description: |- The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. type: integer default: 12 type: object SubFormFieldsPerDocumentTypeEnum: type: string enum: - checkbox - checkbox-merge - date_signed - dropdown - hyperlink - initials - signature - radio - text - text-merge SubFormFieldsPerDocumentFontEnum: type: string enum: - helvetica - arial - courier - calibri - cambria - georgia - times - trebuchet - verdana - roboto - robotoMono - notoSans - notoSerif - notoCJK-JP-Regular - notoHebrew-Regular - notoSanThaiMerged SubFormFieldsPerDocumentBase: description: |- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` required: - document_index - api_id - type - required - signer - width - height - x - 'y' properties: document_index: description: 'Represents the integer index of the `file` or `file_url` document the field should be attached to.' type: integer api_id: description: 'An identifier for the field that is unique across all documents in the request.' type: string height: description: 'Size of the field in pixels.' type: integer name: description: 'Display name for the field.' type: string page: description: |- Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. type: integer nullable: true required: description: 'Whether this field is required.' type: boolean signer: description: |- Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. type: string x-int-or-string: true type: type: string width: description: 'Size of the field in pixels.' type: integer x: description: 'Location coordinates of the field in pixels.' type: integer 'y': description: 'Location coordinates of the field in pixels.' type: integer type: object discriminator: propertyName: type mapping: text: '#/components/schemas/SubFormFieldsPerDocumentText' dropdown: '#/components/schemas/SubFormFieldsPerDocumentDropdown' hyperlink: '#/components/schemas/SubFormFieldsPerDocumentHyperlink' checkbox: '#/components/schemas/SubFormFieldsPerDocumentCheckbox' radio: '#/components/schemas/SubFormFieldsPerDocumentRadio' signature: '#/components/schemas/SubFormFieldsPerDocumentSignature' date_signed: '#/components/schemas/SubFormFieldsPerDocumentDateSigned' initials: '#/components/schemas/SubFormFieldsPerDocumentInitials' text-merge: '#/components/schemas/SubFormFieldsPerDocumentTextMerge' checkbox-merge: '#/components/schemas/SubFormFieldsPerDocumentCheckboxMerge' x-internal: true x-base-class: true SubSignatureRequestGroupedSigners: required: - group - signers properties: group: description: 'The name of the group.' type: string order: description: 'The order the group is required to sign in. Use this instead of Signer-level `order`.' type: integer nullable: true signers: description: |- Signers belonging to this Group. **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. type: array items: $ref: '#/components/schemas/SubSignatureRequestSigner' type: object SubMergeField: required: - name - type properties: name: description: 'The name of the merge field. Must be unique.' type: string type: description: 'The type of merge field.' type: string enum: - text - checkbox x-enumDescriptions: text: 'Sets merge [field type](/api/reference/constants/#field-types) to `text`.' checkbox: 'Sets merge [field type](/api/reference/constants/#field-types) to `checkbox`.' type: object SubOAuth: description: 'OAuth related parameters.' properties: callback_url: description: 'The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)' type: string scopes: description: 'A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).' type: array items: type: string enum: - request_signature - basic_account_info - account_access - signature_request_access - template_access - team_access - api_app_access - '' type: object SubOptions: description: 'Additional options supported by API App.' properties: can_insert_everywhere: description: 'Determines if signers can use "Insert Everywhere" when signing a document.' type: boolean default: false type: object SubSignatureRequestSigner: required: - name - email_address properties: name: description: 'The name of the signer.' type: string email_address: description: 'The email address of the signer.' type: string format: email order: description: 'The order the signer is required to sign in.' type: integer nullable: true pin: description: 'The 4- to 12-character access code that will secure this signer''s signature page.' type: string maxLength: 12 minLength: 4 sms_phone_number: description: |- An E.164 formatted phone number. 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). **NOTE:** Not available in test mode and requires a Standard plan or higher. type: string sms_phone_number_type: description: |- Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). type: string enum: - authentication - delivery type: object SubSignatureRequestTemplateSigner: required: - role - name - email_address properties: role: description: 'Must match an existing role in chosen Template(s). It''s case-sensitive.' type: string name: description: 'The name of the signer.' type: string email_address: description: 'The email address of the signer.' type: string format: email pin: description: 'The 4- to 12-character access code that will secure this signer''s signature page.' type: string maxLength: 12 minLength: 4 sms_phone_number: description: |- An E.164 formatted phone number. 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). **NOTE:** Not available in test mode and requires a Standard plan or higher. type: string sms_phone_number_type: description: |- Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). type: string enum: - authentication - delivery type: object SubUnclaimedDraftSigner: required: - name - email_address properties: email_address: description: 'The email address of the signer.' type: string format: email name: description: 'The name of the signer.' type: string order: description: 'The order the signer is required to sign in.' type: integer nullable: true type: object SubUnclaimedDraftTemplateSigner: required: - role - name - email_address properties: role: description: 'Must match an existing role in chosen Template(s).' type: string name: description: 'The name of the signer filling the role of `role`.' type: string email_address: description: 'The email address of the signer filling the role of `role`.' type: string format: email type: object SubTemplateRole: properties: name: description: 'The role name of the signer that will be displayed when the template is used to create a signature request.' type: string order: description: 'The order in which this signer role is required to sign.' type: integer nullable: true type: object SubSigningOptions: description: |- This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings. required: - default_type properties: default_type: description: 'The default type shown (limited to the listed types)' type: string enum: - draw - phone - type - upload draw: description: 'Allows drawing the signature' type: boolean default: false phone: description: 'Allows using a smartphone to email the signature' type: boolean default: false type: description: 'Allows typing the signature' type: boolean default: false upload: description: 'Allows uploading the signature' type: boolean default: false type: object SubWhiteLabelingOptions: description: |- An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more. properties: header_background_color: type: string default: '#1A1A1A' legal_version: type: string default: terms1 enum: - terms1 - terms2 link_color: type: string default: '#00B3E6' page_background_color: type: string default: '#F7F8F9' primary_button_color: type: string default: '#00B3E6' primary_button_color_hover: type: string default: '#00B3E6' primary_button_text_color: type: string default: '#FFFFFF' primary_button_text_color_hover: type: string default: '#FFFFFF' secondary_button_color: type: string default: '#FFFFFF' secondary_button_color_hover: type: string default: '#FFFFFF' secondary_button_text_color: type: string default: '#00B3E6' secondary_button_text_color_hover: type: string default: '#00B3E6' text_color1: type: string default: '#808080' text_color2: type: string default: '#FFFFFF' reset_to_default: description: 'Resets white labeling options to defaults. Only useful when updating an API App.' type: boolean type: object TeamAddMemberRequest: properties: account_id: description: |- `account_id` or `email_address` is required. If both are provided, the account id prevails. Account id of the user to invite to your Team. type: string email_address: description: |- `account_id` or `email_address` is required, If both are provided, the account id prevails. Email address of the user to invite to your Team. type: string format: email role: description: |- A role member will take in a new Team. **NOTE:** This parameter is used only if `team_id` is provided. type: string enum: - Member - Developer - 'Team Manager' - Admin type: object TeamCreateRequest: properties: name: description: 'The name of your Team.' type: string default: 'Untitled Team' type: object TeamRemoveMemberRequest: properties: account_id: description: |- **account_id** or **email_address** is required. If both are provided, the account id prevails. Account id to remove from your Team. type: string email_address: description: |- **account_id** or **email_address** is required. If both are provided, the account id prevails. Email address of the Account to remove from your Team. type: string format: email new_owner_email_address: description: |- The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account. **NOTE:** Only available for Enterprise plans. type: string format: email new_team_id: description: 'Id of the new Team.' type: string new_role: description: |- A new role member will take in a new Team. **NOTE:** This parameter is used only if `new_team_id` is provided. type: string enum: - Member - Developer - 'Team Manager' - Admin type: object TeamUpdateRequest: properties: name: description: 'The name of your Team.' type: string type: object TemplateAddUserRequest: properties: account_id: description: |- The id of the Account to give access to the Template. **NOTE:** The account id prevails if email address is also provided. type: string email_address: description: |- The email address of the Account to give access to the Template. **NOTE:** The account id prevails if it is also provided. type: string format: email skip_notification: description: 'If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.' type: boolean default: false type: object TemplateCreateRequest: required: - signer_roles - form_fields_per_document properties: files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. type: boolean default: false attachments: description: 'A list describing the attachments' type: array items: $ref: '#/components/schemas/SubAttachment' cc_roles: description: 'The CC roles that must be assigned when using the template to send a signature request' type: array items: type: string client_id: description: 'Client id of the app you''re using to create this draft. Used to apply the branding and callback url defined for the app.' type: string field_options: $ref: '#/components/schemas/SubFieldOptions' form_field_groups: 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`.' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: |- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' merge_fields: description: |- Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. type: array items: $ref: '#/components/schemas/SubMergeField' message: description: 'The default template email message.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} signer_roles: description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.' type: array items: $ref: '#/components/schemas/SubTemplateRole' subject: description: 'The template title (alias).' type: string maxLength: 200 test_mode: description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string use_preexisting_fields: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false type: object TemplateCreateEmbeddedDraftRequest: required: - client_id properties: files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string allow_ccs: description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.' type: boolean default: true allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. type: boolean default: false attachments: description: 'A list describing the attachments' type: array items: $ref: '#/components/schemas/SubAttachment' cc_roles: description: 'The CC roles that must be assigned when using the template to send a signature request' type: array items: type: string client_id: description: 'Client id of the app you''re using to create this draft. Used to apply the branding and callback url defined for the app.' type: string editor_options: $ref: '#/components/schemas/SubEditorOptions' field_options: $ref: '#/components/schemas/SubFieldOptions' force_signer_roles: description: 'Provide users the ability to review/edit the template signer roles.' type: boolean default: false force_subject_message: description: 'Provide users the ability to review/edit the template subject and message.' type: boolean default: false form_field_groups: 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`.' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: |- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' merge_fields: description: |- Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. type: array items: $ref: '#/components/schemas/SubMergeField' message: description: 'The default template email message.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} show_preview: description: |- This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. type: boolean default: false show_progress_stepper: description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.' type: boolean default: true signer_roles: description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.' type: array items: $ref: '#/components/schemas/SubTemplateRole' skip_me_now: description: 'Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.' type: boolean default: false subject: description: 'The template title (alias).' type: string maxLength: 200 test_mode: description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string use_preexisting_fields: description: 'Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).' type: boolean default: false type: object TemplateRemoveUserRequest: properties: account_id: description: 'The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.' type: string email_address: description: 'The id or email address of the Account to remove access to the Template. The account id prevails if both are provided.' type: string format: email type: object TemplateUpdateFilesRequest: properties: client_id: description: 'Client id of the app you''re using to update this template.' type: string files: description: |- Use `files[]` to indicate the uploaded file(s) to use for the template. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string message: description: 'The new default template email message.' type: string maxLength: 5000 subject: description: 'The new default template email subject.' type: string maxLength: 100 test_mode: description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false type: object UnclaimedDraftCreateRequest: description: '' required: - type properties: files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false attachments: description: 'A list describing the attachments' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: 'The email addresses that should be CCed.' type: array items: type: string format: email client_id: description: 'Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.' type: string custom_fields: description: |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. type: array items: $ref: '#/components/schemas/SubCustomField' field_options: $ref: '#/components/schemas/SubFieldOptions' form_field_groups: 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`.' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: |- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: 'Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.' type: boolean default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} show_progress_stepper: description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.' type: boolean default: true signers: description: 'Add Signers to your Unclaimed Draft Signature Request.' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 200 test_mode: description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false type: description: 'The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional.' type: string enum: - send_document - request_signature use_preexisting_fields: description: 'Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.' type: boolean default: false use_text_tags: description: 'Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.' type: boolean default: false expires_at: 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. **NOTE:** This does not correspond to the **expires_at** returned in the response. type: integer nullable: true type: object UnclaimedDraftCreateEmbeddedRequest: description: '' required: - client_id - requester_email_address properties: files: description: |- Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: description: |- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string allow_ccs: description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.' type: boolean default: true allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. type: boolean default: false attachments: description: 'A list describing the attachments' type: array items: $ref: '#/components/schemas/SubAttachment' cc_email_addresses: description: 'The email addresses that should be CCed.' type: array items: type: string format: email client_id: description: 'Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.' type: string custom_fields: description: |- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. type: array items: $ref: '#/components/schemas/SubCustomField' editor_options: $ref: '#/components/schemas/SubEditorOptions' field_options: $ref: '#/components/schemas/SubFieldOptions' force_signer_page: description: 'Provide users the ability to review/edit the signers.' type: boolean default: false force_subject_message: description: 'Provide users the ability to review/edit the subject and message.' type: boolean default: false form_field_groups: 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`.' type: array items: $ref: '#/components/schemas/SubFormFieldGroup' form_field_rules: description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' type: array items: $ref: '#/components/schemas/SubFormFieldRule' form_fields_per_document: description: |- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` type: array items: $ref: '#/components/schemas/SubFormFieldsPerDocumentBase' hide_text_tags: description: 'Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.' type: boolean default: false hold_request: description: 'The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.' type: boolean default: false is_for_embedded_signing: description: 'The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.' type: boolean default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} requester_email_address: description: 'The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.' type: string format: email requesting_redirect_url: description: 'The URL you want signers redirected to after they successfully request a signature.' type: string show_preview: description: |- This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. type: boolean show_progress_stepper: description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.' type: boolean default: true signers: description: 'Add Signers to your Unclaimed Draft Signature Request.' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string skip_me_now: description: 'Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.' type: boolean default: false subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 200 test_mode: description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false type: description: 'The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.' type: string default: request_signature enum: - send_document - request_signature use_preexisting_fields: description: 'Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.' type: boolean default: false use_text_tags: description: 'Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.' type: boolean default: false populate_auto_fill_fields: 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. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false expires_at: 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. **NOTE:** This does not correspond to the **expires_at** returned in the response. type: integer nullable: true type: object UnclaimedDraftCreateEmbeddedWithTemplateRequest: required: - client_id - requester_email_address - template_ids properties: allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false allow_reassign: description: |- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. type: boolean default: false ccs: description: 'Add CC email recipients. Required when a CC role exists for the Template.' type: array items: $ref: '#/components/schemas/SubCC' client_id: description: 'Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.' type: string custom_fields: description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' type: array items: $ref: '#/components/schemas/SubCustomField' editor_options: $ref: '#/components/schemas/SubEditorOptions' field_options: $ref: '#/components/schemas/SubFieldOptions' files: description: |- Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both. type: array items: type: string format: binary file_urls: description: |- Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both. type: array items: type: string force_signer_roles: description: 'Provide users the ability to review/edit the template signer roles.' type: boolean default: false force_subject_message: description: 'Provide users the ability to review/edit the template subject and message.' type: boolean default: false hold_request: description: 'The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.' type: boolean default: false is_for_embedded_signing: description: 'The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.' type: boolean default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string maxLength: 5000 metadata: description: |- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. type: object maxItems: 10 additionalProperties: {} preview_only: 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). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **NOTE:** This parameter overwrites `show_preview=1` (if set). type: boolean default: false requester_email_address: description: 'The email address of the user that should be designated as the requester of this draft.' type: string format: email requesting_redirect_url: description: 'The URL you want signers redirected to after they successfully request a signature.' type: string show_preview: description: |- This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. type: boolean default: false show_progress_stepper: description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.' type: boolean default: true signers: description: 'Add Signers to your Templated-based Signature Request.' type: array items: $ref: '#/components/schemas/SubUnclaimedDraftTemplateSigner' signing_options: $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string skip_me_now: description: 'Disables the "Me (Now)" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.' type: boolean default: false subject: description: 'The subject in the email that will be sent to the signers.' type: string maxLength: 255 template_ids: description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.' type: array items: type: string test_mode: description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false title: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 populate_auto_fill_fields: 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. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. type: boolean default: false allow_ccs: description: 'This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.' type: boolean default: false type: object UnclaimedDraftEditAndResendRequest: required: - client_id properties: client_id: description: 'Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.' type: string editor_options: $ref: '#/components/schemas/SubEditorOptions' is_for_embedded_signing: description: 'The request created from this draft will also be signable in embedded mode if set to `true`.' type: boolean requester_email_address: description: 'The email address of the user that should be designated as the requester of this draft. If not set, original requester''s email address will be used.' type: string format: email requesting_redirect_url: description: 'The URL you want signers redirected to after they successfully request a signature.' type: string show_progress_stepper: description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.' type: boolean default: true signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string test_mode: description: 'Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.' type: boolean default: false type: object AccountCreateResponse: properties: account: $ref: '#/components/schemas/AccountResponse' oauth_data: $ref: '#/components/schemas/OAuthTokenResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true AccountGetResponse: properties: account: $ref: '#/components/schemas/AccountResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true AccountVerifyResponse: properties: account: $ref: '#/components/schemas/AccountVerifyResponseAccount' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true ApiAppGetResponse: properties: api_app: $ref: '#/components/schemas/ApiAppResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true ApiAppListResponse: properties: api_apps: description: 'Contains information about API Apps.' type: array items: $ref: '#/components/schemas/ApiAppResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true BulkSendJobGetResponse: properties: bulk_send_job: $ref: '#/components/schemas/BulkSendJobResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' signature_requests: description: 'Contains information about the Signature Requests sent in bulk.' type: array items: $ref: '#/components/schemas/BulkSendJobGetResponseSignatureRequests' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true BulkSendJobListResponse: properties: bulk_send_jobs: description: 'Contains a list of BulkSendJobs that the API caller has access to.' type: array items: $ref: '#/components/schemas/BulkSendJobResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true BulkSendJobSendResponse: properties: bulk_send_job: $ref: '#/components/schemas/BulkSendJobResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true EmbeddedEditUrlResponse: properties: embedded: $ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true EmbeddedSignUrlResponse: properties: embedded: $ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true ErrorResponse: required: - error properties: error: $ref: '#/components/schemas/ErrorResponseError' type: object FileResponse: properties: file_url: description: 'URL to the file.' type: string expires_at: description: 'When the link expires.' type: integer type: object x-internal: true FileResponseDataUri: properties: data_uri: description: 'File as base64 encoded string.' type: string type: object x-internal: true ReportCreateResponse: properties: report: $ref: '#/components/schemas/ReportResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true SignatureRequestGetResponse: properties: signature_request: $ref: '#/components/schemas/SignatureRequestResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true SignatureRequestListResponse: properties: signature_requests: description: 'Contains information about signature requests.' type: array items: $ref: '#/components/schemas/SignatureRequestResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true AccountResponse: properties: account_id: description: 'The ID of the Account' type: string email_address: description: 'The email address associated with the Account.' type: string is_locked: description: 'Returns `true` if the user has been locked out of their account by a team admin.' type: boolean is_paid_hs: description: 'Returns `true` if the user has a paid Dropbox Sign account.' type: boolean is_paid_hf: description: 'Returns `true` if the user has a paid HelloFax account.' type: boolean quotas: $ref: '#/components/schemas/AccountResponseQuotas' callback_url: description: 'The URL that Dropbox Sign events will `POST` to.' type: string nullable: true role_code: description: 'The membership role for the team.' type: string nullable: true team_id: description: 'The id of the team account belongs to.' type: string nullable: true locale: 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.' type: string nullable: true type: object x-internal: true OAuthTokenResponse: properties: access_token: type: string token_type: type: string refresh_token: type: string expires_in: description: 'Number of seconds until the `access_token` expires. Uses epoch time.' type: integer state: type: string nullable: true type: object x-internal: true AccountResponseQuotas: description: 'Details concerning remaining monthly quotas.' properties: api_signature_requests_left: description: 'API signature requests remaining.' type: integer nullable: true documents_left: description: 'Signature requests remaining.' type: integer nullable: true templates_total: description: 'Total API templates allowed.' type: integer nullable: true templates_left: description: 'API templates remaining.' type: integer nullable: true sms_verifications_left: description: 'SMS verifications remaining.' type: integer nullable: true type: object x-internal: true AccountVerifyResponseAccount: properties: email_address: description: 'The email address associated with the Account.' type: string type: object x-internal: true ApiAppResponse: description: 'Contains information about an API App.' properties: callback_url: description: 'The app''s callback URL (for events)' type: string nullable: true client_id: description: 'The app''s client id' type: string created_at: description: 'The time that the app was created' type: integer domains: description: 'The domain name(s) associated with the app' type: array items: type: string name: description: 'The name of the app' type: string is_approved: description: 'Boolean to indicate if the app has been approved' type: boolean oauth: $ref: '#/components/schemas/ApiAppResponseOAuth' options: $ref: '#/components/schemas/ApiAppResponseOptions' owner_account: $ref: '#/components/schemas/ApiAppResponseOwnerAccount' white_labeling_options: $ref: '#/components/schemas/ApiAppResponseWhiteLabelingOptions' type: object x-internal: true ApiAppResponseOAuth: description: 'An object describing the app''s OAuth properties, or null if OAuth is not configured for the app.' properties: callback_url: description: 'The app''s OAuth callback URL.' type: string secret: description: 'The app''s OAuth secret, or null if the app does not belong to user.' type: string scopes: description: 'Array of OAuth scopes used by the app.' type: array items: type: string charges_users: description: 'Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests.' type: boolean type: object nullable: true x-internal: true ApiAppResponseOptions: description: 'An object with options that override account settings.' properties: can_insert_everywhere: description: 'Boolean denoting if signers can "Insert Everywhere" in one click while signing a document' type: boolean type: object nullable: true x-internal: true ApiAppResponseOwnerAccount: description: 'An object describing the app''s owner' properties: account_id: description: 'The owner account''s ID' type: string email_address: description: 'The owner account''s email address' type: string type: object x-internal: true ApiAppResponseWhiteLabelingOptions: description: 'An object with options to customize the app''s signer page' properties: header_background_color: type: string legal_version: type: string link_color: type: string page_background_color: type: string primary_button_color: type: string primary_button_color_hover: type: string primary_button_text_color: type: string primary_button_text_color_hover: type: string secondary_button_color: type: string secondary_button_color_hover: type: string secondary_button_text_color: type: string secondary_button_text_color_hover: type: string text_color1: type: string text_color2: type: string type: object nullable: true x-internal: true BulkSendJobResponse: description: 'Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.' properties: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string nullable: true total: description: 'The total amount of Signature Requests queued for sending.' type: integer is_creator: description: 'True if you are the owner of this BulkSendJob, false if it''s been shared with you by a team member.' type: boolean created_at: description: 'Time that the BulkSendJob was created.' type: integer type: object x-internal: true BulkSendJobGetResponseSignatureRequests: title: BulkSendJobGetResponseSignatureRequests type: object allOf: - $ref: '#/components/schemas/SignatureRequestResponse' - properties: bulk_send_job_id: description: 'The id of the BulkSendJob.' type: string x-internal: true EmbeddedEditUrlResponseEmbedded: description: 'An embedded template object.' properties: edit_url: description: 'A template url that can be opened in an iFrame.' type: string expires_at: description: 'The specific time that the the `edit_url` link expires, in epoch.' type: integer type: object x-internal: true EmbeddedSignUrlResponseEmbedded: description: 'An object that contains necessary information to set up embedded signing.' properties: sign_url: description: 'A signature url that can be opened in an iFrame.' type: string expires_at: description: 'The specific time that the the `sign_url` link expires, in epoch.' type: integer type: object x-internal: true ErrorResponseError: description: 'Contains information about an error that occurred.' required: - error_msg - error_name properties: error_msg: description: 'Message describing an error.' type: string error_path: description: 'Path at which an error occurred.' type: string error_name: description: 'Name of the error.' type: string type: object ListInfoResponse: description: 'Contains pagination information about the data returned.' properties: num_pages: description: 'Total number of pages available.' type: integer num_results: description: 'Total number of objects available.' type: integer nullable: true page: description: 'Number of the page being returned.' type: integer page_size: description: 'Objects returned per page.' type: integer type: object x-internal: true ReportResponse: description: 'Contains information about the report request.' properties: success: description: 'A message indicating the requested operation''s success' type: string start_date: description: 'The (inclusive) start date for the report data in MM/DD/YYYY format.' type: string end_date: description: 'The (inclusive) end date for the report data in MM/DD/YYYY format.' type: string report_type: 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).' type: array items: enum: - user_activity - document_status type: object x-internal: true SignatureRequestResponse: description: 'Contains information about a signature request.' properties: test_mode: description: 'Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.' type: boolean default: false nullable: true signature_request_id: description: 'The id of the SignatureRequest.' type: string requester_email_address: description: 'The email address of the initiator of the SignatureRequest.' type: string title: description: 'The title the specified Account uses for the SignatureRequest.' type: string original_title: description: 'Default Label for account.' type: string subject: description: 'The subject in the email that was initially sent to the signers.' type: string nullable: true message: description: 'The custom message in the email that was initially sent to the signers.' type: string nullable: true metadata: description: 'The metadata attached to the signature request.' type: object created_at: description: 'Time the signature request was created.' type: integer expires_at: description: 'The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.' type: integer is_complete: description: 'Whether or not the SignatureRequest has been fully executed by all signers.' type: boolean is_declined: description: 'Whether or not the SignatureRequest has been declined by a signer.' type: boolean has_error: description: 'Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).' type: boolean files_url: description: 'The URL where a copy of the request''s documents can be downloaded.' type: string signing_url: description: 'The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.' type: string nullable: true details_url: description: 'The URL where the requester and the signers can view the current status of the SignatureRequest.' type: string cc_email_addresses: description: 'A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.' type: array items: type: string signing_redirect_url: description: 'The URL you want the signer redirected to after they successfully sign.' type: string nullable: true final_copy_uri: description: 'The path where the completed document can be downloaded' type: string nullable: true template_ids: description: 'Templates IDs used in this SignatureRequest (if any).' type: array items: type: string nullable: true custom_fields: description: |- An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` type: array items: $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' nullable: true attachments: description: 'Signer attachments.' type: array items: $ref: '#/components/schemas/SignatureRequestResponseAttachment' nullable: true response_data: description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' type: array items: $ref: '#/components/schemas/SignatureRequestResponseDataBase' nullable: true signatures: description: 'An array of signature objects, 1 for each signer.' type: array items: $ref: '#/components/schemas/SignatureRequestResponseSignatures' bulk_send_job_id: description: 'The ID of the Bulk Send job which sent the signature request, if applicable.' type: string nullable: true type: object x-internal: true SignatureRequestResponseAttachment: description: 'Signer attachments.' required: - id - signer - name - required properties: id: description: 'The unique ID for this attachment.' type: string signer: description: 'The Signer this attachment is assigned to.' type: string name: description: 'The name of this attachment.' type: string required: description: 'A boolean value denoting if this attachment is required.' type: boolean instructions: description: 'Instructions for Signer.' type: string nullable: true uploaded_at: description: 'Timestamp when attachment was uploaded by Signer.' type: integer nullable: true type: object x-internal: true SignatureRequestResponseCustomFieldBase: description: |- An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox` required: - name - type properties: type: description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' type: string name: description: 'The name of the Custom Field.' type: string required: description: 'A boolean value denoting if this field is required.' type: boolean api_id: description: 'The unique ID for this field.' type: string editor: description: 'The name of the Role that is able to edit this field.' type: string type: object discriminator: propertyName: type mapping: text: '#/components/schemas/SignatureRequestResponseCustomFieldText' checkbox: '#/components/schemas/SignatureRequestResponseCustomFieldCheckbox' x-internal: true x-base-class: true SignatureRequestResponseCustomFieldCheckbox: description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' allOf: - $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' - required: - name - type properties: type: description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' type: string default: checkbox value: description: 'A true/false for checkbox fields' type: boolean type: object SignatureRequestResponseCustomFieldText: description: 'This class extends `SignatureRequestResponseCustomFieldBase`.' allOf: - $ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase' - required: - name - type properties: type: description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.' type: string default: text value: description: 'A text string for text fields' type: string type: object SignatureRequestResponseCustomFieldTypeEnum: type: string enum: - text - checkbox SignatureRequestResponseDataBase: description: 'An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.' properties: api_id: description: 'The unique ID for this field.' type: string signature_id: description: 'The ID of the signature to which this response is linked.' type: string name: description: 'The name of the form field.' type: string required: description: 'A boolean value denoting if this field is required.' type: boolean type: type: string type: object discriminator: propertyName: type mapping: text: '#/components/schemas/SignatureRequestResponseDataValueText' checkbox: '#/components/schemas/SignatureRequestResponseDataValueCheckbox' dropdown: '#/components/schemas/SignatureRequestResponseDataValueDropdown' radio: '#/components/schemas/SignatureRequestResponseDataValueRadio' signature: '#/components/schemas/SignatureRequestResponseDataValueSignature' date_signed: '#/components/schemas/SignatureRequestResponseDataValueDateSigned' initials: '#/components/schemas/SignatureRequestResponseDataValueInitials' text-merge: '#/components/schemas/SignatureRequestResponseDataValueTextMerge' checkbox-merge: '#/components/schemas/SignatureRequestResponseDataValueCheckboxMerge' x-internal: true x-base-class: true SignatureRequestResponseDataTypeEnum: type: string enum: - text - checkbox - date_signed - dropdown - initials - radio - signature - text-merge - checkbox-merge SignatureRequestResponseDataValueCheckbox: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'A yes/no checkbox' type: string default: checkbox value: description: 'The value of the form field.' type: boolean type: object SignatureRequestResponseDataValueCheckboxMerge: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'A checkbox field that has default value set by the api' type: string default: checkbox-merge value: description: 'The value of the form field.' type: string type: object SignatureRequestResponseDataValueDateSigned: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'A date' type: string default: date_signed value: description: 'The value of the form field.' type: string type: object SignatureRequestResponseDataValueDropdown: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'An input field for dropdowns' type: string default: dropdown value: description: 'The value of the form field.' type: string type: object SignatureRequestResponseDataValueInitials: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'An input field for initials' type: string default: initials value: description: 'The value of the form field.' type: string type: object SignatureRequestResponseDataValueRadio: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'An input field for radios' type: string default: radio value: description: 'The value of the form field.' type: boolean type: object SignatureRequestResponseDataValueSignature: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'A signature input field' type: string default: signature value: description: 'The value of the form field.' type: string type: object SignatureRequestResponseDataValueText: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'A text input field' type: string default: text value: description: 'The value of the form field.' type: string type: object SignatureRequestResponseDataValueTextMerge: allOf: - $ref: '#/components/schemas/SignatureRequestResponseDataBase' - properties: type: description: 'A text field that has default text set by the api' type: string default: text-merge value: description: 'The value of the form field.' type: string type: object SignatureRequestResponseSignatures: description: 'An array of signature objects, 1 for each signer.' properties: signature_id: description: 'Signature identifier.' type: string signer_group_guid: description: 'Signer Group GUID' type: string nullable: true signer_email_address: description: 'The email address of the signer.' type: string signer_name: description: 'The name of the signer.' type: string nullable: true signer_role: description: 'The role of the signer.' type: string nullable: true order: description: 'If signer order is assigned this is the 0-based index for this signer.' type: integer nullable: true status_code: description: 'The current status of the signature. eg: awaiting_signature, signed, declined.' type: string decline_reason: description: 'The reason provided by the signer for declining the request.' type: string nullable: true signed_at: description: 'Time that the document was signed or null.' type: integer nullable: true last_viewed_at: description: 'The time that the document was last viewed by this signer or null.' type: integer nullable: true last_reminded_at: description: 'The time the last reminder email was sent to the signer or null.' type: integer nullable: true has_pin: description: 'Boolean to indicate whether this signature requires a PIN to access.' type: boolean has_sms_auth: description: 'Boolean to indicate whether this signature has SMS authentication enabled.' type: boolean nullable: true has_sms_delivery: description: 'Boolean to indicate whether this signature has SMS delivery enabled.' type: boolean nullable: true sms_phone_number: description: 'The SMS phone number used for authentication or signature request delivery.' type: string nullable: true reassigned_by: description: 'Email address of original signer who reassigned to this signer.' type: string nullable: true reassignment_reason: description: 'Reason provided by original signer who reassigned to this signer.' type: string nullable: true reassigned_from: description: 'Previous signature identifier.' type: string nullable: true error: description: 'Error message pertaining to this signer, or null.' type: string nullable: true type: object x-internal: true TeamResponse: description: 'Contains information about your team and its members' properties: name: description: 'The name of your Team' type: string accounts: type: array items: $ref: '#/components/schemas/AccountResponse' invited_accounts: description: 'A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.' type: array items: $ref: '#/components/schemas/AccountResponse' invited_emails: description: 'A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.' type: array items: type: string type: object x-internal: true TeamInfoResponse: properties: team_id: description: 'The id of a team' type: string team_parent: $ref: '#/components/schemas/TeamParentResponse' name: description: 'The name of a team' type: string num_members: description: 'Number of members within a team' type: integer num_sub_teams: description: 'Number of sub teams within a team' type: integer type: object x-internal: true TeamInviteResponse: properties: email_address: description: 'Email address of the user invited to this team.' type: string team_id: description: 'Id of the team.' type: string role: description: 'Role of the user invited to this team.' type: string sent_at: description: 'Timestamp when the invitation was sent.' type: integer redeemed_at: description: 'Timestamp when the invitation was redeemed.' type: integer expires_at: description: 'Timestamp when the invitation is expiring.' type: integer type: object x-internal: true TeamMemberResponse: properties: account_id: description: 'Account id of the team member.' type: string email_address: description: 'Email address of the team member.' type: string role: description: 'The specific role a member has on the team.' type: string type: object x-internal: true TeamParentResponse: description: 'Information about the parent team if a team has one, set to `null` otherwise.' properties: team_id: description: 'The id of a team' type: string name: description: 'The name of a team' type: string type: object nullable: true x-internal: true SubTeamResponse: properties: team_id: description: 'The id of a team' type: string name: description: 'The name of a team' type: string type: object x-internal: true TemplateResponse: description: 'Contains information about the templates you and your team have created.' properties: template_id: description: 'The id of the Template.' type: string title: description: 'The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.' type: string message: description: 'The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest.' type: string updated_at: description: 'Time the template was last updated.' type: integer is_embedded: description: '`true` if this template was created using an embedded flow, `false` if it was created on our website.' type: boolean nullable: true is_creator: description: '`true` if you are the owner of this template, `false` if it''s been shared with you by a team member.' type: boolean nullable: true can_edit: description: 'Indicates whether edit rights have been granted to you by the owner (always `true` if that''s you).' type: boolean nullable: true is_locked: description: |- Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests. type: boolean nullable: true metadata: description: 'The metadata attached to the template.' type: object signer_roles: description: 'An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.' type: array items: $ref: '#/components/schemas/TemplateResponseSignerRole' cc_roles: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' type: array items: $ref: '#/components/schemas/TemplateResponseCCRole' documents: description: 'An array describing each document associated with this Template. Includes form field data for each document.' type: array items: $ref: '#/components/schemas/TemplateResponseDocument' custom_fields: description: 'Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' nullable: true deprecated: true named_form_fields: description: 'Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' nullable: true deprecated: true accounts: description: 'An array of the Accounts that can use this Template.' type: array items: $ref: '#/components/schemas/TemplateResponseAccount' nullable: true type: object x-internal: true TemplateResponseAccount: properties: account_id: description: 'The id of the Account.' type: string email_address: description: 'The email address associated with the Account.' type: string is_locked: description: 'Returns `true` if the user has been locked out of their account by a team admin.' type: boolean is_paid_hs: description: 'Returns `true` if the user has a paid Dropbox Sign account.' type: boolean is_paid_hf: description: 'Returns `true` if the user has a paid HelloFax account.' type: boolean quotas: $ref: '#/components/schemas/TemplateResponseAccountQuota' type: object x-internal: true TemplateResponseAccountQuota: description: 'An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.' properties: templates_left: description: 'API templates remaining.' type: integer api_signature_requests_left: description: 'API signature requests remaining.' type: integer documents_left: description: 'Signature requests remaining.' type: integer sms_verifications_left: description: 'SMS verifications remaining.' type: integer type: object x-internal: true TemplateResponseCCRole: properties: name: description: 'The name of the Role.' type: string type: object x-internal: true TemplateCreateEmbeddedDraftResponseTemplate: description: 'Template object with parameters: `template_id`, `edit_url`, `expires_at`.' properties: template_id: description: 'The id of the Template.' type: string edit_url: description: 'Link to edit the template.' type: string expires_at: description: 'When the link expires.' type: integer warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' deprecated: true type: object x-internal: true TemplateCreateResponseTemplate: description: 'Template object with parameters: `template_id`.' properties: template_id: description: 'The id of the Template.' type: string type: object x-internal: true TemplateResponseDocument: properties: name: description: 'Name of the associated file.' type: string index: description: 'Document ordering, the lowest index is displayed first and the highest last (0-based indexing).' type: integer field_groups: description: 'An array of Form Field Group objects.' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroup' form_fields: description: 'An array of Form Field objects containing the name and type of each named field.' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' custom_fields: description: 'An array of Form Field objects containing the name and type of each named field.' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' static_fields: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' type: array items: $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' nullable: true type: object x-internal: true TemplateResponseDocumentCustomFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: - type properties: api_id: description: 'The unique ID for this field.' type: string name: description: 'The name of the Custom Field.' type: string type: type: string signer: description: 'The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).' type: string nullable: true x: description: 'The horizontal offset in pixels for this form field.' type: integer 'y': description: 'The vertical offset in pixels for this form field.' type: integer width: description: 'The width in pixels of this form field.' type: integer height: description: 'The height in pixels of this form field.' type: integer required: description: 'Boolean showing whether or not this field is required.' type: boolean group: description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' type: string nullable: true type: object discriminator: propertyName: type mapping: text: '#/components/schemas/TemplateResponseDocumentCustomFieldText' checkbox: '#/components/schemas/TemplateResponseDocumentCustomFieldCheckbox' x-internal: true x-base-class: true TemplateResponseDocumentCustomFieldCheckbox: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' - properties: type: description: |- The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` type: string default: checkbox type: object TemplateResponseDocumentCustomFieldText: description: 'This class extends `TemplateResponseDocumentCustomFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase' - properties: type: description: |- The type of this Custom Field. Only `text` and `checkbox` are currently supported. * Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` type: string default: text avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: description: 'Whether this form field is multiline text.' type: boolean originalFontSize: description: 'Original font size used in this form field''s text.' type: integer fontFamily: description: 'Font family used in this form field''s text.' type: string type: object TemplateResponseDocumentFieldGroup: properties: name: description: 'The name of the form field group.' type: string rule: $ref: '#/components/schemas/TemplateResponseDocumentFieldGroupRule' type: object x-internal: true TemplateResponseDocumentFieldGroupRule: description: 'The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).' properties: requirement: description: |- Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. type: string groupLabel: description: 'Name of the group' type: string type: object x-internal: true TemplateResponseDocumentFormFieldBase: description: 'An array of Form Field objects containing the name and type of each named field.' required: - type properties: api_id: description: 'A unique id for the form field.' type: string name: description: 'The name of the form field.' type: string type: type: string signer: description: 'The signer of the Form Field.' type: string x: description: 'The horizontal offset in pixels for this form field.' type: integer 'y': description: 'The vertical offset in pixels for this form field.' type: integer width: description: 'The width in pixels of this form field.' type: integer height: description: 'The height in pixels of this form field.' type: integer required: description: 'Boolean showing whether or not this field is required.' type: boolean group: description: 'The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.' type: string nullable: true type: object discriminator: propertyName: type mapping: text: '#/components/schemas/TemplateResponseDocumentFormFieldText' dropdown: '#/components/schemas/TemplateResponseDocumentFormFieldDropdown' hyperlink: '#/components/schemas/TemplateResponseDocumentFormFieldHyperlink' checkbox: '#/components/schemas/TemplateResponseDocumentFormFieldCheckbox' radio: '#/components/schemas/TemplateResponseDocumentFormFieldRadio' signature: '#/components/schemas/TemplateResponseDocumentFormFieldSignature' date_signed: '#/components/schemas/TemplateResponseDocumentFormFieldDateSigned' initials: '#/components/schemas/TemplateResponseDocumentFormFieldInitials' x-internal: true x-base-class: true TemplateResponseDocumentFormFieldCheckbox: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: checkbox type: object TemplateResponseDocumentFormFieldDateSigned: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: date_signed type: object TemplateResponseDocumentFormFieldDropdown: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: dropdown type: object TemplateResponseDocumentFormFieldHyperlink: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: hyperlink avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: description: 'Whether this form field is multiline text.' type: boolean originalFontSize: description: 'Original font size used in this form field''s text.' type: integer fontFamily: description: 'Font family used in this form field''s text.' type: string type: object TemplateResponseDocumentFormFieldInitials: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: initials type: object TemplateResponseDocumentFormFieldRadio: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - type - group allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: radio type: object TemplateResponseDocumentFormFieldSignature: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: signature type: object TemplateResponseDocumentFormFieldText: description: 'This class extends `TemplateResponseDocumentFormFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase' - required: - type properties: type: description: |- The type of this form field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` type: string default: text avg_text_length: $ref: '#/components/schemas/TemplateResponseFieldAvgTextLength' isMultiline: description: 'Whether this form field is multiline text.' type: boolean originalFontSize: description: 'Original font size used in this form field''s text.' type: integer fontFamily: description: 'Font family used in this form field''s text.' type: string validation_type: description: 'Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.' type: string enum: - numbers_only - letters_only - phone_number - bank_routing_number - bank_account_number - email_address - zip_code - social_security_number - employer_identification_number - custom_regex nullable: true type: object TemplateResponseDocumentStaticFieldBase: description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.' required: - type properties: api_id: description: 'A unique id for the static field.' type: string name: description: 'The name of the static field.' type: string type: type: string signer: description: 'The signer of the Static Field.' type: string default: me_now x: description: 'The horizontal offset in pixels for this static field.' type: integer 'y': description: 'The vertical offset in pixels for this static field.' type: integer width: description: 'The width in pixels of this static field.' type: integer height: description: 'The height in pixels of this static field.' type: integer required: description: 'Boolean showing whether or not this field is required.' type: boolean group: description: 'The name of the group this field is in. If this field is not a group, this defaults to `null`.' type: string nullable: true type: object discriminator: propertyName: type mapping: text: '#/components/schemas/TemplateResponseDocumentStaticFieldText' dropdown: '#/components/schemas/TemplateResponseDocumentStaticFieldDropdown' hyperlink: '#/components/schemas/TemplateResponseDocumentStaticFieldHyperlink' checkbox: '#/components/schemas/TemplateResponseDocumentStaticFieldCheckbox' radio: '#/components/schemas/TemplateResponseDocumentStaticFieldRadio' signature: '#/components/schemas/TemplateResponseDocumentStaticFieldSignature' date_signed: '#/components/schemas/TemplateResponseDocumentStaticFieldDateSigned' initials: '#/components/schemas/TemplateResponseDocumentStaticFieldInitials' x-internal: true x-base-class: true TemplateResponseDocumentStaticFieldCheckbox: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: checkbox type: object TemplateResponseDocumentStaticFieldDateSigned: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: date_signed type: object TemplateResponseDocumentStaticFieldDropdown: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: dropdown type: object TemplateResponseDocumentStaticFieldHyperlink: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: hyperlink type: object TemplateResponseDocumentStaticFieldInitials: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: initials type: object TemplateResponseDocumentStaticFieldRadio: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: radio type: object TemplateResponseDocumentStaticFieldSignature: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: signature type: object TemplateResponseDocumentStaticFieldText: description: 'This class extends `TemplateResponseDocumentStaticFieldBase`' required: - type allOf: - $ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase' - required: - type properties: type: description: |- The type of this static field. See [field types](/api/reference/constants/#field-types). * Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` type: string default: text type: object TemplateResponseFieldAvgTextLength: description: 'Average text length in this field.' properties: num_lines: description: 'Number of lines.' type: integer num_chars_per_line: description: 'Number of characters per line.' type: integer type: object x-internal: true TemplateResponseSignerRole: properties: name: description: 'The name of the Role.' type: string order: description: 'If signer order is assigned this is the 0-based index for this role.' type: integer type: object x-internal: true TemplateUpdateFilesResponseTemplate: description: 'Contains template id' properties: template_id: description: 'The id of the Template.' type: string warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' deprecated: true type: object x-internal: true UnclaimedDraftResponse: description: 'A group of documents that a user can take ownership of via the claim URL.' properties: signature_request_id: description: 'The ID of the signature request that is represented by this UnclaimedDraft.' type: string nullable: true claim_url: description: 'The URL to be used to claim this UnclaimedDraft.' type: string signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string nullable: true requesting_redirect_url: description: 'The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).' type: string nullable: true expires_at: description: 'When the link expires.' type: integer nullable: true test_mode: description: 'Whether this is a test draft. Signature requests made from test drafts have no legal value.' type: boolean type: object x-internal: true WarningResponse: description: 'A list of warnings.' required: - warning_msg - warning_name properties: warning_msg: description: 'Warning message' type: string warning_name: description: 'Warning name' type: string type: object TeamGetResponse: properties: team: $ref: '#/components/schemas/TeamResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TeamGetInfoResponse: properties: team: $ref: '#/components/schemas/TeamInfoResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TeamInvitesResponse: properties: team_invites: description: 'Contains a list of team invites and their roles.' type: array items: $ref: '#/components/schemas/TeamInviteResponse' warnings: type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TeamMembersResponse: properties: team_members: description: 'Contains a list of team members and their roles for a specific team.' type: array items: $ref: '#/components/schemas/TeamMemberResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TeamSubTeamsResponse: properties: sub_teams: description: 'Contains a list with sub teams.' type: array items: $ref: '#/components/schemas/SubTeamResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateCreateResponse: properties: template: $ref: '#/components/schemas/TemplateCreateResponseTemplate' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateCreateEmbeddedDraftResponse: properties: template: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateEditResponse: properties: template_id: description: 'The id of the Template.' type: string type: object TemplateGetResponse: properties: template: $ref: '#/components/schemas/TemplateResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateListResponse: properties: templates: description: 'List of templates that the API caller has access to.' type: array items: $ref: '#/components/schemas/TemplateResponse' list_info: $ref: '#/components/schemas/ListInfoResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true TemplateUpdateFilesResponse: properties: template: $ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate' type: object x-internal: true UnclaimedDraftCreateResponse: properties: unclaimed_draft: $ref: '#/components/schemas/UnclaimedDraftResponse' warnings: description: 'A list of warnings.' type: array items: $ref: '#/components/schemas/WarningResponse' type: object x-internal: true EventCallbackRequest: title: EventCallbackRequest required: - event properties: event: $ref: '#/components/schemas/EventCallbackRequestEvent' account: $ref: '#/components/schemas/AccountResponse' signature_request: $ref: '#/components/schemas/SignatureRequestResponse' template: $ref: '#/components/schemas/TemplateResponse' type: object EventCallbackRequestEvent: description: 'Basic information about the event that occurred.' required: - event_time - event_type - event_hash properties: event_time: description: 'Time the event was created (using Unix time).' type: string event_type: description: 'Type of callback event that was triggered.' type: string 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 event_hash: description: 'Generated hash used to verify source of event data.' type: string event_metadata: $ref: '#/components/schemas/EventCallbackRequestEventMetadata' type: object EventCallbackRequestEventMetadata: description: 'Specific metadata about the event.' properties: related_signature_id: description: 'Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events.' type: string nullable: true reported_for_account_id: description: 'Account ID the event was reported for.' type: string nullable: true reported_for_app_id: description: 'App ID the event was reported for.' type: string nullable: true event_message: description: 'Message about a declined or failed (due to error) signature flow.' type: string nullable: true type: object responses: EventCallbackResponse: description: 'successful operation' content: text/plain: schema: type: string default: 'Hello API Event Received' examples: AccountCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/AccountCreateRequestDefaultExample.json AccountCreateRequestOAuthExample: summary: 'OAuth Example' value: $ref: examples/json/AccountCreateRequestOAuthExample.json AccountUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/AccountUpdateRequestDefaultExample.json AccountVerifyRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/AccountVerifyRequestDefaultExample.json ApiAppCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/ApiAppCreateRequestDefaultExample.json ApiAppUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/ApiAppUpdateRequestDefaultExample.json EmbeddedEditUrlRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json OAuthTokenGenerateRequestExample: summary: 'OAuth Token Generate Example' value: $ref: examples/json/OAuthTokenGenerateRequestExample.json OAuthTokenRefreshRequestExample: summary: 'OAuth Token Refresh Example' value: $ref: examples/json/OAuthTokenRefreshRequestExample.json ReportCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/ReportCreateRequestDefaultExample.json SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json SignatureRequestBulkSendWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json SignatureRequestCreateEmbeddedRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json SignatureRequestCreateEmbeddedRequestGroupedSignersExample: summary: 'Grouped Signers Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json SignatureRequestRemindRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json SignatureRequestSendRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestSendRequestDefaultExample.json SignatureRequestSendRequestGroupedSignersExample: summary: 'Grouped Signers Example' value: $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json SignatureRequestSendWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json SignatureRequestUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json TeamAddMemberRequestEmailAddressExample: summary: 'Email Address Example' value: $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json TeamAddMemberRequestAccountIdExample: summary: 'Account ID Example' value: $ref: examples/json/TeamAddMemberRequestAccountIdExample.json TeamCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TeamCreateRequestDefaultExample.json TeamRemoveMemberRequestEmailAddressExample: summary: 'Email Address Example' value: $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json TeamRemoveMemberRequestAccountIdExample: summary: 'Account ID Example' value: $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json TeamUpdateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TeamUpdateRequestDefaultExample.json TemplateAddUserRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateAddUserRequestDefaultExample.json TemplateCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateCreateRequestDefaultExample.json TemplateCreateRequestFormFieldsPerDocumentExample: summary: 'Form Fields Per Document Example' value: $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json TemplateCreateRequestFormFieldGroupsExample: summary: 'Form Fields Per Document and Groups Example' value: $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json TemplateCreateRequestFormFieldRulesExample: summary: 'Form Fields Per Document and Rules Example' value: $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json TemplateCreateEmbeddedDraftRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: summary: 'Form Fields Per Document Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: summary: 'Form Fields Per Document and Groups Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: summary: 'Form Fields Per Document and Rules Example' value: $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json TemplateRemoveUserRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json TemplateUpdateFilesRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json UnclaimedDraftCreateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: summary: 'Form Fields Per Document Example' value: $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json UnclaimedDraftCreateRequestFormFieldGroupsExample: summary: 'Form Fields Per Document and Groups Example' value: $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json UnclaimedDraftCreateRequestFormFieldRulesExample: summary: 'Form Fields Per Document and Rules Example' value: $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json UnclaimedDraftCreateEmbeddedRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: summary: 'Form Fields Per Document Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: summary: 'Form Fields Per Document and Groups Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: summary: 'Form Fields Per Document and Rules Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json UnclaimedDraftEditAndResendRequestDefaultExample: summary: 'Default Example' value: $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json AccountCreateResponseExample: summary: 'Account Create' value: $ref: examples/json/AccountCreateResponseExample.json AccountCreateOAuthResponseExample: summary: 'Account Create with OAuth Authorization' value: $ref: examples/json/AccountCreateOAuthResponseExample.json AccountGetResponseExample: summary: 'Account Get' value: $ref: examples/json/AccountGetResponseExample.json AccountVerifyFoundResponseExample: summary: 'Account Found' value: $ref: examples/json/AccountVerifyFoundResponseExample.json AccountVerifyNotFoundResponseExample: summary: 'Account Not Found' value: $ref: examples/json/AccountVerifyNotFoundResponseExample.json ApiAppGetResponseExample: summary: 'API App' value: $ref: examples/json/ApiAppGetResponseExample.json ApiAppListResponseExample: summary: 'API App List' value: $ref: examples/json/ApiAppListResponseExample.json BulkSendJobGetResponseExample: summary: 'Bulk Send Job' value: $ref: examples/json/BulkSendJobGetResponseExample.json BulkSendJobListResponseExample: summary: 'Bulk Send Job List' value: $ref: examples/json/BulkSendJobListResponseExample.json EmbeddedEditUrlResponseExample: summary: 'Embedded Edit URL' value: $ref: examples/json/EmbeddedEditUrlResponseExample.json EmbeddedSignUrlResponseExample: summary: 'Embedded Sign URL' value: $ref: examples/json/EmbeddedSignUrlResponseExample.json Error400ResponseExample: summary: 'Error 400 bad_request' value: $ref: examples/json/Error400ResponseExample.json Error401ResponseExample: summary: 'Error 401 unauthorized' value: $ref: examples/json/Error401ResponseExample.json Error402ResponseExample: summary: 'Error 402 payment_required' value: $ref: examples/json/Error402ResponseExample.json Error403ResponseExample: summary: 'Error 403 forbidden' value: $ref: examples/json/Error403ResponseExample.json Error404ResponseExample: summary: 'Error 404 not_found' value: $ref: examples/json/Error404ResponseExample.json Error409ResponseExample: summary: 'Error 409 conflict' value: $ref: examples/json/Error409ResponseExample.json Error410ResponseExample: summary: 'Error 410 deleted' value: $ref: examples/json/Error410ResponseExample.json Error422ResponseExample: summary: 'Error 422 unprocessable_entity' value: $ref: examples/json/Error422ResponseExample.json Error429ResponseExample: summary: 'Error 429 exceeded_rate' value: $ref: examples/json/Error429ResponseExample.json Error4XXResponseExample: summary: 'Error 4XX failed_operation' value: $ref: examples/json/Error4XXResponseExample.json ReportCreateResponseExample: summary: Report value: $ref: examples/json/ReportCreateResponseExample.json SignatureRequestGetResponseExample: summary: 'Get Signature Request' value: $ref: examples/json/SignatureRequestGetResponseExample.json SignatureRequestListResponseExample: summary: 'List Signature Requests' value: $ref: examples/json/SignatureRequestListResponseExample.json AccountUpdateResponseExample: summary: 'Account Update' value: $ref: examples/json/AccountUpdateResponseExample.json OAuthTokenGenerateResponseExample: summary: 'Retrieving the OAuth token' value: $ref: examples/json/OAuthTokenGenerateResponseExample.json OAuthTokenRefreshResponseExample: summary: 'Refresh an existing OAuth token' value: $ref: examples/json/OAuthTokenRefreshResponseExample.json ApiAppCreateResponseExample: summary: 'API App' value: $ref: examples/json/ApiAppCreateResponseExample.json ApiAppUpdateResponseExample: summary: 'API App Update' value: $ref: examples/json/ApiAppUpdateResponseExample.json SignatureRequestCreateEmbeddedResponseExample: summary: 'Create Embedded Signature Request' value: $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json SignatureRequestCreateEmbeddedWithTemplateResponseExample: summary: 'Create Embedded Signature Request With Template' value: $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json SignatureRequestFilesResponseExample: summary: 'Signature Requests Files' value: $ref: examples/json/SignatureRequestFilesResponseExample.json SignatureRequestReleaseHoldResponseExample: summary: 'Send Signature Release Hold' value: $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json SignatureRequestRemindResponseExample: summary: 'Send Signature Request Reminder' value: $ref: examples/json/SignatureRequestRemindResponseExample.json SignatureRequestSendResponseExample: summary: 'Send Signature Request' value: $ref: examples/json/SignatureRequestSendResponseExample.json SignatureRequestSendWithTemplateResponseExample: summary: 'Send Signature Request With Template' value: $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json SignatureRequestUpdateResponseExample: summary: 'Signature Request Update' value: $ref: examples/json/SignatureRequestUpdateResponseExample.json SignatureRequestBulkSendWithTemplateResponseExample: summary: 'Send Signature Request With Template' value: $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: summary: 'Bulk Send Create Embedded Signature Request With Template' value: $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json TeamCreateResponseExample: summary: 'Team Create' value: $ref: examples/json/TeamCreateResponseExample.json TeamMembersResponseExample: summary: 'Team Members List' value: $ref: examples/json/TeamMembersResponseExample.json TeamRemoveMemberResponseExample: summary: 'Team Remove Member' value: $ref: examples/json/TeamRemoveMemberResponseExample.json TeamUpdateResponseExample: summary: 'Team Update' value: $ref: examples/json/TeamUpdateResponseExample.json TeamDoesNotExistResponseExample: summary: 'Team Does Not Exist' value: $ref: examples/json/TeamDoesNotExistResponseExample.json TemplateAddUserResponseExample: summary: 'Add User to Template' value: $ref: examples/json/TemplateAddUserResponseExample.json TemplateFilesResponseExample: summary: 'Template Files' value: $ref: examples/json/TemplateFilesResponseExample.json TemplateRemoveUserResponseExample: summary: 'Remove User from Template' value: $ref: examples/json/TemplateRemoveUserResponseExample.json UnclaimedDraftCreateEmbeddedResponseExample: summary: 'Unclaimed Draft Create Embedded' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: summary: 'Unclaimed Draft Create Embedded With Template' value: $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json UnclaimedDraftEditAndResendExample: summary: 'Unclaimed Draft Edit and Resend' value: $ref: examples/json/UnclaimedDraftEditAndResendExample.json TeamGetResponseExample: summary: 'Team Get' value: $ref: examples/json/TeamGetResponseExample.json TeamGetInfoResponseExample: summary: 'Team Get Info' value: $ref: examples/json/TeamGetInfoResponseExample.json TeamInvitesResponseExample: summary: 'Team Invites' value: $ref: examples/json/TeamInvitesResponseExample.json TeamAddMemberResponseExample: summary: 'Team Add Member' value: $ref: examples/json/TeamAddMemberResponseExample.json TeamSubTeamsResponseExample: summary: 'Team Sub Teams List' value: $ref: examples/json/TeamSubTeamsResponseExample.json TemplateCreateResponseExample: summary: 'Create Template' value: $ref: examples/json/TemplateCreateResponseExample.json TemplateCreateEmbeddedDraftResponseExample: summary: 'Create Embedded Draft Template' value: $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json TemplateGetResponseExample: summary: 'Get Template' value: $ref: examples/json/TemplateGetResponseExample.json TemplateListResponseExample: summary: 'List Templates' value: $ref: examples/json/TemplateListResponseExample.json TemplateUpdateFilesResponseExample: summary: 'Update Template Files' value: $ref: examples/json/TemplateUpdateFilesResponseExample.json UnclaimedDraftCreateResponseExample: summary: 'Unclaimed Draft Create' value: $ref: examples/json/UnclaimedDraftCreateResponseExample.json EventCallbackAccountSignatureRequestSentExample: summary: 'Example: signature_request_sent' value: $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json EventCallbackAccountTemplateCreatedExample: summary: 'Example: template_created' value: $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json EventCallbackAppAccountConfirmedExample: summary: 'Example: account_confirmed' value: $ref: examples/json/EventCallbackAppAccountConfirmedExample.json EventCallbackAppSignatureRequestSentExample: summary: 'Example: signature_request_sent' value: $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json EventCallbackAppTemplateCreatedExample: summary: 'Example: template_created' value: $ref: examples/json/EventCallbackAppTemplateCreatedExample.json requestBodies: EventCallbackAccountRequest: description: |- **Account Callback Payloads --** Events that are reported at the Account level through the the *Account callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api). The *Account callback URL* can also be updated by calling [Update Account](/api/reference/operation/accountUpdate) and passing a `callback_url`. content: multipart/form-data: schema: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' template_created_example: $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' EventCallbackAppRequest: description: |- **API App Callback Payloads --** Events that are reported at the API App level through the *Event callback URL* defined in your [API settings](https://app.hellosign.com/home/myAccount#api) for a specific app. The *Event callback URL* can also be updated by calling [Update API App](/api/reference/operation/apiAppUpdate) and passing a `callback_url`. content: multipart/form-data: schema: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' signature_request_sent_example: $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' template_created_example: $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' schema: type: integer format: int32 example: 100 X-RateLimit-Remaining: description: 'The number of requests remaining in the current rate limit window.' schema: type: integer format: int32 example: 99 X-Ratelimit-Reset: description: 'The Unix time at which the rate limit will reset to its maximum.' schema: type: integer format: int64 example: 1430170900 securitySchemes: api_key: type: http description: |- Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information. ✅ Supported by Try it console (calls sent in `test_mode` only). scheme: basic oauth2: type: http description: |- You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console. bearerFormat: JWT scheme: bearer security: - api_key: [] oauth2: - account_access - signature_request_access - template_access - team_access - api_app_access - basic_account_info - request_signature externalDocs: description: 'Legacy API Reference' url: 'https://app.hellosign.com/api/reference' x-webhooks: accountCallback: post: summary: 'Account Callbacks' operationId: accountUpdateEventCallback description: $ref: ./markdown/en/descriptions/account-callback-description.md x-meta: seo: title: 'Account Callbacks | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the account level, click here.' x-codeSamples: - lang: PHP label: PHP source: $ref: examples/EventCallback.php - lang: 'C#' label: 'C#' source: $ref: examples/EventCallback.cs - lang: JavaScript label: JavaScript source: $ref: examples/EventCallback.js - lang: TypeScript label: TypeScript source: $ref: examples/EventCallback.ts - lang: Java label: Java source: $ref: examples/EventCallback.java - lang: Ruby label: Ruby source: $ref: examples/EventCallback.rb - lang: Python label: Python source: $ref: examples/EventCallback.py tags: - 'Callbacks and Events' requestBody: $ref: '#/components/requestBodies/EventCallbackAccountRequest' responses: 200: $ref: '#/components/responses/EventCallbackResponse' appCallback: post: summary: 'App Callbacks' description: $ref: ./markdown/en/descriptions/api-app-callback-description.md operationId: apiAppCreateEventCallback x-meta: seo: title: 'App Callbacks | API Documentation | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build with a wide range of tools. To find out how to consume Dropbox Sign Events at the App level, click here.' x-codeSamples: - lang: PHP label: PHP source: $ref: examples/EventCallback.php - lang: 'C#' label: 'C#' source: $ref: examples/EventCallback.cs - lang: JavaScript label: JavaScript source: $ref: examples/EventCallback.js - lang: TypeScript label: TypeScript source: $ref: examples/EventCallback.ts - lang: Java label: Java source: $ref: examples/EventCallback.java - lang: Ruby label: Ruby source: $ref: examples/EventCallback.rb - lang: Python label: Python source: $ref: examples/EventCallback.py tags: - 'Callbacks and Events' requestBody: $ref: '#/components/requestBodies/EventCallbackAppRequest' responses: 200: $ref: '#/components/responses/EventCallbackResponse'