{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/account":{"get":{"operationId":"get","summary":"Get Account","description":"Returns the properties and settings of your Account.","tags":["Account"],"parameters":[{"name":"account_id","in":"query","description":"`account_id` or `email_address` is required. If both are provided, the account id prevails.\n\nThe 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.\n\nThe email address of the Account.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"update","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.","tags":["Account"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUpdateRequest"}}}}}},"/account/create":{"post":{"operationId":"create","summary":"Create Account","description":"Creates a new Dropbox Sign Account that is associated with the specified `email_address`.","tags":["Account"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCreateResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountCreateRequest"}}}}}},"/account/verify":{"post":{"operationId":"verify","summary":"Verify Account","description":"Verifies whether an Dropbox Sign Account exists for the given email address.","tags":["Account"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountVerifyResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountVerifyRequest"}}}}}},"/signature_request/{signature_request_id}":{"get":{"operationId":"get","summary":"Get Signature Request","description":"Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to retrieve.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/list":{"get":{"operationId":"list","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.\n\nTake a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.","tags":["signatureRequest"],"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.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Which page number of the SignatureRequest List to return. Defaults to `1`.","required":false,"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`.","required":false,"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.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestListResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/files/{signature_request_id}":{"get":{"operationId":"files","summary":"Download Files","description":"Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file.\n\nIf the files are currently being prepared, a status code of `409` will be returned instead.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to retrieve.","required":true,"schema":{"type":"string"}},{"name":"file_type","in":"query","description":"Set to `pdf` for a single merged document or `zip` for a collection of individual documents.","required":false,"schema":{"$ref":"#/components/schemas/SignatureRequestFilesSignatureRequestIdGetParametersFileType","default":"pdf"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/files_as_data_uri/{signature_request_id}":{"get":{"operationId":"filesAsDataUri","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).\n\nIf the files are currently being prepared, a status code of `409` will be returned instead.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to retrieve.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileResponseDataUri"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/files_as_file_url/{signature_request_id}":{"get":{"operationId":"filesAsFileUrl","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).\n\nIf the files are currently being prepared, a status code of `409` will be returned instead.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to retrieve.","required":true,"schema":{"type":"string"}},{"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.","required":false,"schema":{"type":"integer","default":1}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/send":{"post":{"operationId":"send","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.","tags":["signatureRequest"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestSendRequest"}}}}}},"/signature_request/send_with_template":{"post":{"operationId":"sendWithTemplate","summary":"Send with Template","description":"Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.","tags":["signatureRequest"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestSendWithTemplateRequest"}}}}}},"/signature_request/bulk_send_with_template":{"post":{"operationId":"bulkSendWithTemplate","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.\n\n**NOTE:** Only available for Standard plan and higher.","tags":["signatureRequest"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSendJobSendResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestBulkSendWithTemplateRequest"}}}}}},"/signature_request/remind/{signature_request_id}":{"post":{"operationId":"remind","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.\n\n**NOTE:** This action can **not** be used with embedded signature requests.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to send a reminder for.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestRemindRequest"}}}}}},"/signature_request/release_hold/{signature_request_id}":{"post":{"operationId":"releaseHold","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.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to release.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/update/{signature_request_id}":{"post":{"operationId":"update","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.\n\nUpdating the email address of a signer will generate a new `signature_id` value.\n\n**NOTE:** This action cannot be performed on a signature request with an appended signature page.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to update.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestUpdateRequest"}}}}}},"/signature_request/cancel/{signature_request_id}":{"post":{"operationId":"cancel","summary":"Cancel Incomplete Signature Request","description":"Cancels an incomplete signature request. This action is **not reversible**.\n\nThe 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.\n\nThis 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.\n\nTo 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.\n\n**NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the incomplete SignatureRequest to cancel.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signatureRequest_cancel_Response_200"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/remove/{signature_request_id}":{"post":{"operationId":"remove","summary":"Remove Signature Request Access","description":"Removes your access to a completed signature request. This action is **not reversible**.\n\nThe 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).\n\nUnlike /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.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to remove.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/signatureRequest_remove_Response_200"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/signature_request/bulk_create_embedded_with_template":{"post":{"operationId":"bulkCreateEmbeddedWithTemplate","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.\n\n**NOTE:** Only available for Standard plan and higher.","tags":["signatureRequest"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSendJobSendResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest"}}}}}},"/signature_request/create_embedded":{"post":{"operationId":"createEmbedded","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.","tags":["signatureRequest"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestCreateEmbeddedRequest"}}}}}},"/signature_request/create_embedded_with_template":{"post":{"operationId":"createEmbeddedWithTemplate","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.","tags":["signatureRequest"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest"}}}}}},"/signature_request/edit/{signature_request_id}":{"put":{"operationId":"edit","summary":"Edit Signature Request","description":"Edits and sends a 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.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to edit.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestEditRequest"}}}}}},"/signature_request/edit_embedded/{signature_request_id}":{"put":{"operationId":"editEmbedded","summary":"Edit Embedded Signature Request","description":"Edits a 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.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to edit.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestEditEmbeddedRequest"}}}}}},"/signature_request/edit_embedded_with_template/{signature_request_id}":{"put":{"operationId":"editEmbeddedWithTemplate","summary":"Edit Embedded Signature Request with Template","description":"Edits a 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.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to edit.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest"}}}}}},"/signature_request/edit_with_template/{signature_request_id}":{"put":{"operationId":"editWithTemplate","summary":"Edit Signature Request With Template","description":"Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.\n\n**NOTE:** Edit and resend *will* deduct your signature request quota.","tags":["signatureRequest"],"parameters":[{"name":"signature_request_id","in":"path","description":"The id of the SignatureRequest to edit.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignatureRequestEditWithTemplateRequest"}}}}}},"/template/{template_id}":{"get":{"operationId":"get","summary":"Get Template","description":"Returns the Template specified by the `template_id` parameter.","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The id of the Template to retrieve.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/template/list":{"get":{"operationId":"list","summary":"List Templates","description":"Returns a list of the Templates that are accessible by you.\n\nTake a look at our [search guide](/api/reference/search/) to learn more about querying templates.","tags":["Template"],"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.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Which page number of the Template List to return. Defaults to `1`.","required":false,"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`.","required":false,"schema":{"type":"integer","default":20}},{"name":"query","in":"query","description":"String that includes search terms and/or fields to be used to filter the Template objects.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateListResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/template/create":{"post":{"operationId":"create","summary":"Create Template","description":"Creates a template that can be used in future signature requests.\n\nIf `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/).\n\nTemplate creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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.","tags":["Template"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateCreateResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateCreateRequest"}}}}}},"/template/create_embedded_draft":{"post":{"operationId":"createEmbeddedDraft","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.","tags":["Template"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateCreateEmbeddedDraftResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateCreateEmbeddedDraftRequest"}}}}}},"/template/delete/{template_id}":{"post":{"operationId":"delete","summary":"Delete Template","description":"Completely deletes the template specified from the account.","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The id of the Template to delete.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/template_delete_Response_200"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/template/files/{template_id}":{"get":{"operationId":"files","summary":"Get Template Files","description":"Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file.\n\nIf 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.","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The id of the template files to retrieve.","required":true,"schema":{"type":"string"}},{"name":"file_type","in":"query","description":"Set to `pdf` for a single merged document or `zip` for a collection of individual documents.","required":false,"schema":{"$ref":"#/components/schemas/TemplateFilesTemplateIdGetParametersFileType"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/template/files_as_data_uri/{template_id}":{"get":{"operationId":"filesAsDataUri","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).\n\nIf 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.","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The id of the template files to retrieve.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileResponseDataUri"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/template/files_as_file_url/{template_id}":{"get":{"operationId":"filesAsFileUrl","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).\n\nIf 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.","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The id of the template files to retrieve.","required":true,"schema":{"type":"string"}},{"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.","required":false,"schema":{"type":"integer","default":1}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/template/update_files/{template_id}":{"post":{"operationId":"updateFiles","summary":"Update Template Files","description":"Overlays a new file with the overlay of an existing template. The new file(s) must:\n\n1. have the same or higher page count\n2. the same orientation as the file(s) being replaced.\n\nThis 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.\n\nOverlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks.\n\nIt 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.\n\nIf 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).","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The ID of the template whose files to update.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateUpdateFilesResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateUpdateFilesRequest"}}}}}},"/template/add_user/{template_id}":{"post":{"operationId":"addUser","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.","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The id of the Template to give the Account access to.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateAddUserRequest"}}}}}},"/template/remove_user/{template_id}":{"post":{"operationId":"removeUser","summary":"Remove User from Template","description":"Removes the specified Account's access to the specified Template.","tags":["Template"],"parameters":[{"name":"template_id","in":"path","description":"The id of the Template to remove the Account's access to.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplateRemoveUserRequest"}}}}}},"/bulk_send_job/{bulk_send_job_id}":{"get":{"operationId":"get","summary":"Get Bulk Send Job","description":"Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.","tags":["bulkSendJob"],"parameters":[{"name":"bulk_send_job_id","in":"path","description":"The id of the BulkSendJob to retrieve.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Which page number of the BulkSendJob list to return. Defaults to `1`.","required":false,"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.","required":false,"schema":{"type":"integer","default":20}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSendJobGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/bulk_send_job/list":{"get":{"operationId":"list","summary":"List Bulk Send Jobs","description":"Returns a list of BulkSendJob that you can access.","tags":["bulkSendJob"],"parameters":[{"name":"page","in":"query","description":"Which page number of the BulkSendJob List to return. Defaults to `1`.","required":false,"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.","required":false,"schema":{"type":"integer","default":20}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSendJobListResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/report/create":{"post":{"operationId":"create","summary":"Create Report","description":"Request the creation of one or more report(s).\n\nWhen 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.","tags":["Report"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCreateResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCreateRequest"}}}}}},"/team":{"get":{"operationId":"get","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.","tags":["Team"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"update","summary":"Update Team","description":"Updates the name of your Team.","tags":["Team"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamUpdateRequest"}}}}}},"/team/info":{"get":{"operationId":"info","summary":"Get Team Info","description":"Provides information about a team.","tags":["Team"],"parameters":[{"name":"team_id","in":"query","description":"The id of the team.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamGetInfoResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/team/members/{team_id}":{"get":{"operationId":"members","summary":"List Team Members","description":"Provides a paginated list of members (and their roles) that belong to a given team.","tags":["Team"],"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"}},{"name":"page","in":"query","description":"Which page number of the team member list to return. Defaults to `1`.","required":false,"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`.","required":false,"schema":{"type":"integer","default":20}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMembersResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/team/sub_teams/{team_id}":{"get":{"operationId":"subTeams","summary":"List Sub Teams","description":"Provides a paginated list of sub teams that belong to a given team.","tags":["Team"],"parameters":[{"name":"team_id","in":"path","description":"The id of the parent Team.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Which page number of the SubTeam List to return. Defaults to `1`.","required":false,"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`.","required":false,"schema":{"type":"integer","default":20}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamSubTeamsResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/team/create":{"post":{"operationId":"create","summary":"Create Team","description":"Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.","tags":["Team"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamCreateRequest"}}}}}},"/team/destroy":{"delete":{"operationId":"delete","summary":"Delete Team","description":"Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).","tags":["Team"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/team_delete_Response_200"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/team/add_member":{"put":{"operationId":"addMember","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.","tags":["Team"],"parameters":[{"name":"team_id","in":"query","description":"The id of the team.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamAddMemberRequest"}}}}}},"/team/remove_member":{"post":{"operationId":"removeMember","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.","tags":["Team"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamRemoveMemberRequest"}}}}}},"/unclaimed_draft/create":{"post":{"operationId":"create","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.","tags":["unclaimedDraft"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftCreateResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftCreateRequest"}}}}}},"/unclaimed_draft/create_embedded":{"post":{"operationId":"createEmbedded","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.\n\n**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.","tags":["unclaimedDraft"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftCreateResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftCreateEmbeddedRequest"}}}}}},"/unclaimed_draft/create_embedded_with_template":{"post":{"operationId":"createEmbeddedWithTemplate","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.\n\n**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.","tags":["unclaimedDraft"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftCreateResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest"}}}}}},"/unclaimed_draft/edit_and_resend/{signature_request_id}":{"post":{"operationId":"editAndResend","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.\n\n**NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.","tags":["unclaimedDraft"],"parameters":[{"name":"signature_request_id","in":"path","description":"The ID of the signature request to edit and resend.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftCreateResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnclaimedDraftEditAndResendRequest"}}}}}},"/embedded/sign_url/{signature_id}":{"get":{"operationId":"signUrl","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.","tags":["Embedded"],"parameters":[{"name":"signature_id","in":"path","description":"The id of the signature to get a signature url for.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedSignUrlResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/embedded/edit_url/{template_id}":{"post":{"operationId":"editUrl","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.","tags":["Embedded"],"parameters":[{"name":"template_id","in":"path","description":"The id of the template to edit.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedEditUrlResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedEditUrlRequest"}}}}}},"/api_app/{client_id}":{"get":{"operationId":"get","summary":"Get API App","description":"Returns an object with information about an API App.","tags":["apiApp"],"parameters":[{"name":"client_id","in":"path","description":"The client id of the API App to retrieve.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiAppGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"update","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.","tags":["apiApp"],"parameters":[{"name":"client_id","in":"path","description":"The client id of the API App to update.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiAppGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiAppUpdateRequest"}}}}},"delete":{"operationId":"delete","summary":"Delete API App","description":"Deletes an API App. Can only be invoked for apps you own.","tags":["apiApp"],"parameters":[{"name":"client_id","in":"path","description":"The client id of the API App to delete.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api_app/list":{"get":{"operationId":"list","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.","tags":["apiApp"],"parameters":[{"name":"page","in":"query","description":"Which page number of the API App List to return. Defaults to `1`.","required":false,"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`.","required":false,"schema":{"type":"integer","default":20}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiAppListResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/api_app":{"post":{"operationId":"create","summary":"Create API App","description":"Creates a new API App.","tags":["apiApp"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiAppGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiAppCreateRequest"}}}}}},"/fax/{fax_id}":{"get":{"operationId":"get","summary":"Get Fax","description":"Returns information about a Fax","tags":["Fax"],"parameters":[{"name":"fax_id","in":"path","description":"Fax ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"operationId":"delete","summary":"Delete Fax","description":"Deletes the specified Fax from the system","tags":["Fax"],"parameters":[{"name":"fax_id","in":"path","description":"Fax ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"successful operation","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/fax/list":{"get":{"operationId":"list","summary":"Lists Faxes","description":"Returns properties of multiple Faxes","tags":["Fax"],"parameters":[{"name":"page","in":"query","description":"Which page number of the Fax List to return. Defaults to `1`.","required":false,"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`.","required":false,"schema":{"type":"integer","default":20}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxListResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/fax/files/{fax_id}":{"get":{"operationId":"files","summary":"Download Fax Files","description":"Downloads files associated with a Fax","tags":["Fax"],"parameters":[{"name":"fax_id","in":"path","description":"Fax ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/fax/send":{"post":{"operationId":"send","summary":"Send Fax","description":"Creates and sends a new Fax with the submitted file(s)","tags":["Fax"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxSendRequest"}}}}}},"/fax_line":{"get":{"operationId":"get","summary":"Get Fax Line","description":"Returns the properties and settings of a Fax Line.","tags":["faxLine"],"parameters":[{"name":"number","in":"query","description":"The Fax Line number","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"delete":{"operationId":"delete","summary":"Delete Fax Line","description":"Deletes the specified Fax Line from the subscription.","tags":["faxLine"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/faxLine_delete_Response_200"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineDeleteRequest"}}}}}},"/fax_line/list":{"get":{"operationId":"list","summary":"List Fax Lines","description":"Returns the properties and settings of multiple Fax Lines.","tags":["faxLine"],"parameters":[{"name":"account_id","in":"query","description":"Account ID","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Which page number of the Fax Line List to return. Defaults to `1`.","required":false,"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`.","required":false,"schema":{"type":"integer","default":20}},{"name":"show_team_lines","in":"query","description":"Include Fax Lines belonging to team members in the list","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineListResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/fax_line/create":{"post":{"operationId":"create","summary":"Purchase Fax Line","description":"Purchases a new Fax Line","tags":["faxLine"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineCreateRequest"}}}}}},"/fax_line/add_user":{"put":{"operationId":"addUser","summary":"Add Fax Line User","description":"Grants a user access to the specified Fax Line.","tags":["faxLine"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineAddUserRequest"}}}}}},"/fax_line/remove_user":{"put":{"operationId":"removeUser","summary":"Remove Fax Line Access","description":"Removes a user's access to the specified Fax Line","tags":["faxLine"],"parameters":[{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineRemoveUserRequest"}}}}}},"/fax_line/area_codes":{"get":{"operationId":"areaCodeGet","summary":"Get Available Fax Line Area Codes","description":"Returns a list of available area codes for a given state/province and city","tags":["faxLine"],"parameters":[{"name":"country","in":"query","description":"Filter area codes by country","required":true,"schema":{"$ref":"#/components/schemas/FaxLineAreaCodesGetParametersCountry"}},{"name":"state","in":"query","description":"Filter area codes by state","required":false,"schema":{"$ref":"#/components/schemas/FaxLineAreaCodesGetParametersState"}},{"name":"province","in":"query","description":"Filter area codes by province","required":false,"schema":{"$ref":"#/components/schemas/FaxLineAreaCodesGetParametersProvince"}},{"name":"city","in":"query","description":"Filter area codes by city","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FaxLineAreaCodeGetResponse"}}}},"400":{"description":"failed_operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"servers":[{"url":"https://api.hellosign.com/v3","description":"https://api.hellosign.com/v3"}],"webhooks":{"subpackage_callbacksAndEvents.accountUpdateEventCallback":{"post":{"operationId":"subpackage_callbacksAndEvents.accountUpdateEventCallback","summary":"Account Callbacks","description":"This type of callback URL can be set up at the account level (either by setting it through an API request to \"/v3/account\" or on the Account Settings page on hellosign.com).\n          \nAll signature request events that involve your account are reported to this URL. This includes events such as receiving a signature request, or when a signature request you've sent is signed by someone. Events are reported to the account callback URL for either requests originating on hellosign.com, or on a partner site, via an embedded flow.\n\nYou can set your account callback by using the [account API call](https://app.hellosign.com/api/account/post) or manually on the [settings page](https://app.hellosign.com/home/myAccount#api).","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"**Account Callback Payloads --**\n      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`.\n\n> **Delivery format:** This payload is delivered to your callback URL as an HTTP `POST` with `Content-Type: multipart/form-data`. The JSON structure documented below is sent as the value of a single form field named `json`. The schema below describes that JSON value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCallbackPayload"}}}}}},"subpackage_callbacksAndEvents.apiAppCreateEventCallback":{"post":{"operationId":"subpackage_callbacksAndEvents.apiAppCreateEventCallback","summary":"App Callbacks","description":"This type of callback URL is set up at the API app level. API apps are used to identify a partner integration and configure embedded flows ([embedded signign](https://app.hellosign.com/api/embeddedSigningWalkthrough), [embedded requesting](https://app.hellosign.com/api/embeddedRequestingWalkthrough), and [embedded templates](https://app.hellosign.com/api/embeddedTemplatesWalkthrough)) and [OAuth providers](https://app.hellosign.com/api/oauthWalkthrough)\n        \nAll events that involve signature requests created by an API app are reported to this URL. The event will include a `client_id` field to indicate which app the event is being reported for, which allows multiple API apps to share the same callback URL.\n\nYou can manage your apps and their callbacks from the [settings page](https://app.hellosign.com/home/myAccount#api).","responses":{"200":{"description":"Webhook received successfully"}},"requestBody":{"description":"**API App Callback Payloads --**\nEvents 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`.\n\n> **Delivery format:** This payload is delivered to your callback URL as an HTTP `POST` with `Content-Type: multipart/form-data`. The JSON structure documented below is sent as the value of a single form field named `json`. The schema below describes that JSON value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventCallbackPayload"}}}}}}},"components":{"schemas":{"AccountResponseQuotas":{"type":"object","properties":{"api_signature_requests_left":{"type":["integer","null"],"description":"API signature requests remaining."},"documents_left":{"type":["integer","null"],"description":"Signature requests remaining."},"templates_total":{"type":["integer","null"],"description":"Total API templates allowed."},"templates_left":{"type":["integer","null"],"description":"API templates remaining."},"sms_verifications_left":{"type":["integer","null"],"description":"SMS verifications remaining."},"num_fax_pages_left":{"type":["integer","null"],"description":"Number of fax pages left"}},"description":"Details concerning remaining monthly quotas.","title":"AccountResponseQuotas"},"AccountResponseUsage":{"type":"object","properties":{"fax_pages_sent":{"type":["integer","null"],"description":"Number of fax pages sent"}},"description":"Details concerning monthly usage","title":"AccountResponseUsage"},"AccountResponseSettings":{"type":"object","properties":{"signer_access_codes":{"type":"boolean","description":"Returns `true` if _Custom access codes_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough)."},"sms_delivery":{"type":"boolean","description":"Returns `true` if _Text message_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough)."},"sms_authentication":{"type":"boolean","description":"Returns `true` if _Signer authentication_ is enabled in Admin Console. [Read more](https://developers.hellosign.com/docs/sms-tools/walkthrough)."}},"description":"Subset of configured settings","title":"AccountResponseSettings"},"AccountResponse":{"type":"object","properties":{"account_id":{"type":"string","description":"The ID of the Account"},"email_address":{"type":"string","description":"The email address associated with the Account."},"is_locked":{"type":"boolean","description":"Returns `true` if the user has been locked out of their account by a team admin."},"is_paid_hs":{"type":"boolean","description":"Returns `true` if the user has a paid Dropbox Sign account."},"is_paid_hf":{"type":"boolean","description":"Returns `true` if the user has a paid HelloFax account."},"quotas":{"$ref":"#/components/schemas/AccountResponseQuotas"},"callback_url":{"type":["string","null"],"description":"The URL that Dropbox Sign events will `POST` to."},"role_code":{"type":["string","null"],"description":"The membership role for the team."},"team_id":{"type":["string","null"],"description":"The id of the team account belongs to."},"locale":{"type":["string","null"],"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."},"usage":{"$ref":"#/components/schemas/AccountResponseUsage"},"settings":{"$ref":"#/components/schemas/AccountResponseSettings"}},"title":"AccountResponse"},"WarningResponse":{"type":"object","properties":{"warning_msg":{"type":"string","description":"Warning message"},"warning_name":{"type":"string","description":"Warning name"}},"required":["warning_msg","warning_name"],"description":"A list of warnings.","title":"WarningResponse"},"AccountGetResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["account"],"title":"AccountGetResponse"},"ErrorResponseError":{"type":"object","properties":{"error_msg":{"type":"string","description":"Message describing an error."},"error_path":{"type":"string","description":"Path at which an error occurred."},"error_name":{"type":"string","description":"Name of the error. See the `x-error-codes` catalog in openapi file for a complete list of possible error codes with detailed information including HTTP status codes, causes, remediation steps, and retry guidance."}},"required":["error_msg","error_name"],"description":"Contains information about an error that occurred.","title":"ErrorResponseError"},"ErrorResponse":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ErrorResponseError"}},"required":["error"],"title":"ErrorResponse"},"AccountUpdateRequest":{"type":"object","properties":{"account_id":{"type":["string","null"],"description":"The ID of the Account"},"callback_url":{"type":"string","description":"The URL that Dropbox Sign should POST events to."},"locale":{"type":"string","description":"The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values."}},"title":"AccountUpdateRequest"},"AccountCreateRequest":{"type":"object","properties":{"client_id":{"type":"string","description":"Used when creating a new account with OAuth authorization.\n\nSee [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)"},"client_secret":{"type":"string","description":"Used when creating a new account with OAuth authorization.\n\nSee [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)"},"email_address":{"type":"string","format":"email","description":"The email address which will be associated with the new Account."},"locale":{"type":"string","description":"The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values."}},"required":["email_address"],"title":"AccountCreateRequest"},"OAuthTokenResponse":{"type":"object","properties":{"access_token":{"type":"string"},"token_type":{"type":"string"},"refresh_token":{"type":"string"},"expires_in":{"type":"integer","description":"Number of seconds until the `access_token` expires. Uses epoch time."},"state":{"type":["string","null"]}},"title":"OAuthTokenResponse"},"AccountCreateResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountResponse"},"oauth_data":{"$ref":"#/components/schemas/OAuthTokenResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["account"],"title":"AccountCreateResponse"},"AccountVerifyRequest":{"type":"object","properties":{"email_address":{"type":"string","format":"email","description":"Email address to run the verification for."}},"required":["email_address"],"title":"AccountVerifyRequest"},"AccountVerifyResponseAccount":{"type":"object","properties":{"email_address":{"type":"string","description":"The email address associated with the Account."}},"title":"AccountVerifyResponseAccount"},"AccountVerifyResponse":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/AccountVerifyResponseAccount"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"title":"AccountVerifyResponse"},"SignatureRequestResponseCustomFieldBase":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","description":"The type of this Custom Field. Only 'text' and 'checkbox' are currently supported."},"name":{"type":"string","description":"The name of the Custom Field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."},"api_id":{"type":"string","description":"The unique ID for this field."},"editor":{"type":["string","null"],"description":"The name of the Role that is able to edit this field."},"value":{"type":"string","description":"A text string for text fields"}},"required":["type","name"],"description":"This class extends `SignatureRequestResponseCustomFieldBase`."},{"type":"object","properties":{"type":{"type":"string","description":"The type of this Custom Field. Only 'text' and 'checkbox' are currently supported."},"name":{"type":"string","description":"The name of the Custom Field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."},"api_id":{"type":"string","description":"The unique ID for this field."},"editor":{"type":["string","null"],"description":"The name of the Role that is able to edit this field."},"value":{"type":"boolean","description":"A true/false for checkbox fields"}},"required":["type","name"],"description":"This class extends `SignatureRequestResponseCustomFieldBase`."}],"discriminator":{"propertyName":"type"},"description":"An array of Custom Field objects containing the name and type of each custom field.\n\n* Text Field uses `SignatureRequestResponseCustomFieldText`\n* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`","title":"SignatureRequestResponseCustomFieldBase"},"SignatureRequestResponseAttachment":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID for this attachment."},"signer":{"type":"string","description":"The Signer this attachment is assigned to."},"name":{"type":"string","description":"The name of this attachment."},"required":{"type":"boolean","description":"A boolean value denoting if this attachment is required."},"instructions":{"type":["string","null"],"description":"Instructions for Signer."},"uploaded_at":{"type":["integer","null"],"description":"Timestamp when attachment was uploaded by Signer."}},"required":["id","signer","name","required"],"description":"Signer attachments.","title":"SignatureRequestResponseAttachment"},"SignatureRequestResponseDataBase":{"oneOf":[{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"text variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"checkbox variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"dropdown variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"radio variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"signature variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"date_signed variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"initials variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"text-merge variant"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"signature_id":{"type":"string","description":"The ID of the signature to which this response is linked."},"name":{"type":"string","description":"The name of the form field."},"required":{"type":"boolean","description":"A boolean value denoting if this field is required."}},"required":["type"],"description":"checkbox-merge variant"}],"discriminator":{"propertyName":"type"},"description":"An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.","title":"SignatureRequestResponseDataBase"},"SignatureRequestResponseSignatures":{"type":"object","properties":{"signature_id":{"type":"string","description":"Signature identifier."},"signer_group_guid":{"type":["string","null"],"description":"Signer Group GUID"},"signer_email_address":{"type":"string","description":"The email address of the signer."},"signer_name":{"type":["string","null"],"description":"The name of the signer."},"signer_role":{"type":["string","null"],"description":"The role of the signer."},"order":{"type":["integer","null"],"description":"If signer order is assigned this is the 0-based index for this signer."},"status_code":{"type":"string","description":"The current status of the signature. eg: awaiting_signature, signed, declined."},"decline_reason":{"type":["string","null"],"description":"The reason provided by the signer for declining the request."},"signed_at":{"type":["integer","null"],"description":"Time that the document was signed or null."},"last_viewed_at":{"type":["integer","null"],"description":"The time that the document was last viewed by this signer or null."},"last_reminded_at":{"type":["integer","null"],"description":"The time the last reminder email was sent to the signer or null."},"has_pin":{"type":"boolean","description":"Boolean to indicate whether this signature requires a PIN to access."},"has_sms_auth":{"type":["boolean","null"],"description":"Boolean to indicate whether this signature has SMS authentication enabled."},"has_sms_delivery":{"type":["boolean","null"],"description":"Boolean to indicate whether this signature has SMS delivery enabled."},"sms_phone_number":{"type":["string","null"],"description":"The SMS phone number used for authentication or signature request delivery."},"reassigned_by":{"type":["string","null"],"description":"Email address of original signer who reassigned to this signer."},"reassignment_reason":{"type":["string","null"],"description":"Reason provided by original signer who reassigned to this signer."},"reassigned_from":{"type":["string","null"],"description":"Previous signature identifier."},"error":{"type":["string","null"],"description":"Error message pertaining to this signer, or null."}},"description":"An array of signature objects, 1 for each signer.","title":"SignatureRequestResponseSignatures"},"SignatureRequestResponse":{"type":"object","properties":{"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test signature request. Test requests have no legal value. Defaults to `false`."},"signature_request_id":{"type":"string","description":"The id of the SignatureRequest."},"requester_email_address":{"type":["string","null"],"description":"The email address of the initiator of the SignatureRequest."},"title":{"type":"string","description":"The title the specified Account uses for the SignatureRequest."},"original_title":{"type":"string","description":"Default Label for account."},"subject":{"type":["string","null"],"description":"The subject in the email that was initially sent to the signers."},"message":{"type":["string","null"],"description":"The custom message in the email that was initially sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The metadata attached to the signature request."},"created_at":{"type":"integer","description":"Time the signature request was created."},"expires_at":{"type":["integer","null"],"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."},"is_complete":{"type":"boolean","description":"Whether or not the SignatureRequest has been fully executed by all signers."},"is_declined":{"type":"boolean","description":"Whether or not the SignatureRequest has been declined by a signer."},"has_error":{"type":"boolean","description":"Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings)."},"files_url":{"type":"string","description":"The URL where a copy of the request's documents can be downloaded."},"signing_url":{"type":["string","null"],"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."},"details_url":{"type":"string","description":"The URL where the requester and the signers can view the current status of the SignatureRequest."},"cc_email_addresses":{"type":"array","items":{"type":"string"},"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."},"signing_redirect_url":{"type":["string","null"],"description":"The URL you want the signer redirected to after they successfully sign."},"final_copy_uri":{"type":["string","null"],"description":"The path where the completed document can be downloaded"},"template_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Templates IDs used in this SignatureRequest (if any)."},"custom_fields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SignatureRequestResponseCustomFieldBase"},"description":"An array of Custom Field objects containing the name and type of each custom field.\n\n* Text Field uses `SignatureRequestResponseCustomFieldText`\n* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SignatureRequestResponseAttachment"},"description":"Signer attachments."},"response_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/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."},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/SignatureRequestResponseSignatures"},"description":"An array of signature objects, 1 for each signer."},"bulk_send_job_id":{"type":["string","null"],"description":"The ID of the Bulk Send job which sent the signature request, if applicable."}},"description":"Contains information about a signature request.","title":"SignatureRequestResponse"},"SignatureRequestGetResponse":{"type":"object","properties":{"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["signature_request"],"title":"SignatureRequestGetResponse"},"ListInfoResponse":{"type":"object","properties":{"num_pages":{"type":"integer","description":"Total number of pages available."},"num_results":{"type":["integer","null"],"description":"Total number of objects available."},"page":{"type":"integer","description":"Number of the page being returned."},"page_size":{"type":"integer","description":"Objects returned per page."}},"description":"Contains pagination information about the data returned.","title":"ListInfoResponse"},"SignatureRequestListResponse":{"type":"object","properties":{"signature_requests":{"type":"array","items":{"$ref":"#/components/schemas/SignatureRequestResponse"},"description":"Contains information about signature requests."},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["signature_requests","list_info"],"title":"SignatureRequestListResponse"},"SignatureRequestFilesSignatureRequestIdGetParametersFileType":{"type":"string","enum":["pdf","zip"],"default":"pdf","title":"SignatureRequestFilesSignatureRequestIdGetParametersFileType"},"FileResponseDataUri":{"type":"object","properties":{"data_uri":{"type":"string","description":"File as base64 encoded string."}},"required":["data_uri"],"title":"FileResponseDataUri"},"FileResponse":{"type":"object","properties":{"file_url":{"type":"string","description":"URL to the file."},"expires_at":{"type":"integer","description":"When the link expires."}},"required":["file_url","expires_at"],"title":"FileResponse"},"SubSignatureRequestSignerSmsPhoneNumberType":{"type":"string","enum":["authentication","delivery"],"description":"Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).","title":"SubSignatureRequestSignerSmsPhoneNumberType"},"SubSignatureRequestSigner":{"type":"object","properties":{"name":{"type":"string","description":"The name of the signer."},"email_address":{"type":"string","format":"email","description":"The email address of the signer."},"order":{"type":["integer","null"],"description":"The order the signer is required to sign in."},"pin":{"type":"string","description":"The 4- to 12-character access code that will secure this signer's signature page."},"sms_phone_number":{"type":"string","description":"An E.164 formatted phone number.\n\nBy using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n**NOTE:** Not available in test mode and requires a Standard plan or higher."},"sms_phone_number_type":{"$ref":"#/components/schemas/SubSignatureRequestSignerSmsPhoneNumberType","description":"Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."}},"required":["name","email_address"],"title":"SubSignatureRequestSigner"},"SubSignatureRequestGroupedSigners":{"type":"object","properties":{"group":{"type":"string","description":"The name of the group."},"order":{"type":["integer","null"],"description":"The order the group is required to sign in. Use this instead of Signer-level `order`."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestSigner"},"description":"Signers belonging to this Group.\n\n**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below."}},"required":["group","signers"],"title":"SubSignatureRequestGroupedSigners"},"SubAttachment":{"type":"object","properties":{"instructions":{"type":"string","description":"The instructions for uploading the attachment."},"name":{"type":"string","description":"The name of attachment."},"required":{"type":"boolean","default":false,"description":"Determines if the attachment must be uploaded."},"signer_index":{"type":"integer","description":"The signer's index in the `signers` parameter (0-based indexing).\n\n**NOTE:** Only one signer can be assigned per attachment."}},"required":["name","signer_index"],"title":"SubAttachment"},"SubCustomField":{"type":"object","properties":{"editor":{"type":"string","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`.\n\n**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."},"name":{"type":"string","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."},"required":{"type":"boolean","default":false,"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`."},"value":{"type":"string","description":"The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing."}},"required":["name"],"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.","title":"SubCustomField"},"SubFieldOptionsDateFormat":{"type":"string","enum":["MM / DD / YYYY","MM - DD - YYYY","DD / MM / YYYY","DD - MM - YYYY","YYYY / MM / DD","YYYY - MM - DD"],"description":"Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))\n\n**NOTE:** Only available for Premium and higher.","title":"SubFieldOptionsDateFormat"},"SubFieldOptions":{"type":"object","properties":{"date_format":{"$ref":"#/components/schemas/SubFieldOptionsDateFormat","description":"Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))\n\n**NOTE:** Only available for Premium and higher."}},"required":["date_format"],"description":"This allows the requester to specify field options for a signature request.","title":"SubFieldOptions"},"SubFormFieldGroup":{"type":"object","properties":{"group_id":{"type":"string","description":"ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`."},"group_label":{"type":"string","description":"Name of the group"},"requirement":{"type":"string","description":"Examples: `require_0-1` `require_1` `require_1-ormore`\n\n- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).\n- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).\n- Radio groups require **at least** two fields per group."}},"required":["group_id","group_label","requirement"],"title":"SubFormFieldGroup"},"SubFormFieldRuleTriggerOperator":{"type":"string","enum":["any","is","match","none","not"],"description":"Different field types allow different `operator` values:\n- Field type of **text**:\n  - **is**: exact match\n  - **not**: not exact match\n  - **match**: regular expression, without /. Example:\n    - OK `[a-zA-Z0-9]`\n    - Not OK `/[a-zA-Z0-9]/`\n- Field type of **dropdown**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n  - **any**: exact match, array of values.\n  - **none**: not exact match, array of values.\n- Field type of **checkbox**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n- Field type of **radio**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value","title":"SubFormFieldRuleTriggerOperator"},"SubFormFieldRuleTrigger":{"type":"object","properties":{"id":{"type":"string","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."},"operator":{"$ref":"#/components/schemas/SubFormFieldRuleTriggerOperator","description":"Different field types allow different `operator` values:\n- Field type of **text**:\n  - **is**: exact match\n  - **not**: not exact match\n  - **match**: regular expression, without /. Example:\n    - OK `[a-zA-Z0-9]`\n    - Not OK `/[a-zA-Z0-9]/`\n- Field type of **dropdown**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n  - **any**: exact match, array of values.\n  - **none**: not exact match, array of values.\n- Field type of **checkbox**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value\n- Field type of **radio**:\n  - **is**: exact match, single value\n  - **not**: not exact match, single value"},"value":{"type":"string","description":"**value** or **values** is required, but not both.\n\nThe value to match against **operator**.\n\n- When **operator** is one of the following, **value** must be `String`:\n  - `is`\n  - `not`\n  - `match`\n\nOtherwise,\n- **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1`\n- **radio**: When **type** of trigger is **radio**, **value** must be `1`"},"values":{"type":"array","items":{"type":"string"},"description":"**values** or **value** is required, but not both.\n\nThe values to match against **operator** when it is one of the following:\n\n- `any`\n- `none`"}},"required":["id","operator"],"title":"SubFormFieldRuleTrigger"},"SubFormFieldRuleActionType":{"type":"string","enum":["change-field-visibility","change-group-visibility"],"title":"SubFormFieldRuleActionType"},"SubFormFieldRuleAction":{"type":"object","properties":{"field_id":{"type":"string","description":"**field_id** or **group_id** is required, but not both.\n\nMust reference the `api_id` of an existing field defined within `form_fields_per_document`.\n\nCannot use with `group_id`. Trigger and action fields must belong to the same signer."},"group_id":{"type":"string","description":"**group_id** or **field_id** is required, but not both.\n\nMust reference the ID of an existing group defined within `form_field_groups`.\n\nCannot use with `field_id`. Trigger and action fields and groups must belong to the same signer."},"hidden":{"type":"boolean","description":"`true` to hide the target field when rule is satisfied, otherwise `false`."},"type":{"$ref":"#/components/schemas/SubFormFieldRuleActionType"}},"required":["hidden","type"],"title":"SubFormFieldRuleAction"},"SubFormFieldRule":{"type":"object","properties":{"id":{"type":"string","description":"Must be unique across all defined rules."},"trigger_operator":{"type":"string","default":"AND","description":"Currently only `AND` is supported. Support for `OR` is being worked on."},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRuleTrigger"},"description":"An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed."},"actions":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRuleAction"},"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."}},"required":["id","trigger_operator","triggers","actions"],"title":"SubFormFieldRule"},"SubFormFieldsPerDocumentTextValidationType":{"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"],"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.\n\n**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.","title":"SubFormFieldsPerDocumentTextValidationType"},"SubFormFieldsPerDocumentTextFontFamily":{"type":"string","enum":["helvetica","arial","courier","calibri","cambria","georgia","times","trebuchet","verdana","roboto","robotoMono","notoSans","notoSerif","notoCJK-JP-Regular","notoHebrew-Regular","notoSanThaiMerged"],"description":"Font family for the field.","title":"SubFormFieldsPerDocumentTextFontFamily"},"SubFormFieldsPerDocumentDropdownFontFamily":{"type":"string","enum":["helvetica","arial","courier","calibri","cambria","georgia","times","trebuchet","verdana","roboto","robotoMono","notoSans","notoSerif","notoCJK-JP-Regular","notoHebrew-Regular","notoSanThaiMerged"],"description":"Font family for the field.","title":"SubFormFieldsPerDocumentDropdownFontFamily"},"SubFormFieldsPerDocumentHyperlinkFontFamily":{"type":"string","enum":["helvetica","arial","courier","calibri","cambria","georgia","times","trebuchet","verdana","roboto","robotoMono","notoSans","notoSerif","notoCJK-JP-Regular","notoHebrew-Regular","notoSanThaiMerged"],"description":"Font family for the field.","title":"SubFormFieldsPerDocumentHyperlinkFontFamily"},"SubFormFieldsPerDocumentDateSignedFontFamily":{"type":"string","enum":["helvetica","arial","courier","calibri","cambria","georgia","times","trebuchet","verdana","roboto","robotoMono","notoSans","notoSerif","notoCJK-JP-Regular","notoHebrew-Regular","notoSanThaiMerged"],"description":"Font family for the field.","title":"SubFormFieldsPerDocumentDateSignedFontFamily"},"SubFormFieldsPerDocumentTextMergeFontFamily":{"type":"string","enum":["helvetica","arial","courier","calibri","cambria","georgia","times","trebuchet","verdana","roboto","robotoMono","notoSans","notoSerif","notoCJK-JP-Regular","notoHebrew-Regular","notoSanThaiMerged"],"description":"Font family for the field.","title":"SubFormFieldsPerDocumentTextMergeFontFamily"},"SubFormFieldsPerDocumentBase":{"oneOf":[{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."},{"type":"object","properties":{"type":{"type":"string"},"document_index":{"type":"integer","description":"Represents the integer index of the `file` or `file_url` document the field should be attached to."},"api_id":{"type":"string","description":"An identifier for the field that is unique across all documents in the request."},"height":{"type":"integer","description":"Size of the field in pixels."},"name":{"type":"string","description":"Display name for the field."},"page":{"type":["integer","null"],"description":"Page in the document where the field should be placed (requires documents be PDF files).\n\n- When the page number parameter is supplied, the API will use the new coordinate system.\n- Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them."},"required":{"type":"boolean","description":"Whether this field is required."},"signer":{"type":"string","description":"Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.\n\n**NOTE:** To set the value of the field as the preparer you must set this to `me_now`\n\n**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data."},"width":{"type":"integer","description":"Size of the field in pixels."},"x":{"type":"integer","description":"Location coordinates of the field in pixels."},"y":{"type":"integer","description":"Location coordinates of the field in pixels."}},"required":["type","document_index","api_id","height","required","signer","width","x","y"],"description":"This class extends `SubFormFieldsPerDocumentBase`."}],"discriminator":{"propertyName":"type"},"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).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`","title":"SubFormFieldsPerDocumentBase"},"SubSigningOptionsDefaultType":{"type":"string","enum":["draw","phone","type","upload"],"description":"The default type shown (limited to the listed types)","title":"SubSigningOptionsDefaultType"},"SubSigningOptions":{"type":"object","properties":{"default_type":{"$ref":"#/components/schemas/SubSigningOptionsDefaultType","description":"The default type shown (limited to the listed types)"},"draw":{"type":"boolean","default":false,"description":"Allows drawing the signature"},"phone":{"type":"boolean","default":false,"description":"Allows using a smartphone to email the signature"},"type":{"type":"boolean","default":false,"description":"Allows typing the signature"},"upload":{"type":"boolean","default":false,"description":"Allows uploading the signature"},"force_advanced_signature_details":{"type":"boolean","default":false,"description":"Turning on advanced signature details for the signature request"}},"required":["default_type"],"description":"This allows the requester to specify the types allowed for creating a signature and specify another signing options.\n\n**NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.\n\n**NOTE:** If `force_advanced_signature_details` is set, allowed types has to be defined too.","title":"SubSigningOptions"},"SignatureRequestSendRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestSigner"},"description":"Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"grouped_signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestGroupedSigners"},"description":"Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan and higher."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_email_addresses":{"type":"array","items":{"type":"string","format":"email"},"description":"The email addresses that should be CCed."},"client_id":{"type":"string","description":"The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"hide_text_tags":{"type":"boolean","default":false,"description":"Enables automatic Text Tag removal when set to true.\n\n**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."},"is_eid":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://sign.dropbox.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"use_text_tags":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."},"expires_at":{"type":["integer","null"],"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."}},"title":"SignatureRequestSendRequest"},"SubCC":{"type":"object","properties":{"role":{"type":"string","description":"Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role."},"email_address":{"type":"string","format":"email","description":"The email address of the CC recipient."}},"required":["role","email_address"],"title":"SubCC"},"SubSignatureRequestTemplateSignerSmsPhoneNumberType":{"type":"string","enum":["authentication","delivery"],"description":"Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).","title":"SubSignatureRequestTemplateSignerSmsPhoneNumberType"},"SubSignatureRequestTemplateSigner":{"type":"object","properties":{"role":{"type":"string","description":"Must match an existing role in chosen Template(s). It's case-sensitive."},"name":{"type":"string","description":"The name of the signer."},"email_address":{"type":"string","format":"email","description":"The email address of the signer."},"pin":{"type":"string","description":"The 4- to 12-character access code that will secure this signer's signature page."},"sms_phone_number":{"type":"string","description":"An E.164 formatted phone number.\n\nBy using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n**NOTE:** Not available in test mode and requires a Standard plan or higher."},"sms_phone_number_type":{"$ref":"#/components/schemas/SubSignatureRequestTemplateSignerSmsPhoneNumberType","description":"Specifies the feature used with the `sms_phone_number`. Default `authentication`.\n\nIf `authentication`, signer is sent a verification code via SMS that is required to access the document.\n\nIf `delivery`, a link to complete the signature request is delivered via SMS (_and_ email)."}},"required":["role","name","email_address"],"title":"SubSignatureRequestTemplateSigner"},"SignatureRequestSendWithTemplateRequest":{"type":"object","properties":{"template_ids":{"type":"array","items":{"type":"string"},"description":"Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"ccs":{"type":"array","items":{"$ref":"#/components/schemas/SubCC"},"description":"Add CC email recipients. Required when a CC role exists for the Template."},"client_id":{"type":"string","description":"Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"An array defining values and options for custom fields. Required when a custom field exists in the Template."},"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"is_eid":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://sign.dropbox.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestTemplateSigner"},"description":"Add Signers to your Templated-based Signature Request."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."}},"required":["template_ids","signers"],"title":"SignatureRequestSendWithTemplateRequest"},"SubBulkSignerListCustomField":{"type":"object","properties":{"name":{"type":"string","description":"The name of the custom field. Must be the field's `name` or `api_id`."},"value":{"type":"string","description":"The value of the custom field."}},"required":["name","value"],"title":"SubBulkSignerListCustomField"},"SubBulkSignerList":{"type":"object","properties":{"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubBulkSignerListCustomField"},"description":"An array of custom field values."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestTemplateSigner"},"description":"Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.\n\nCurrently only templates with a single role are supported. All signers must have the same `role` value."}},"title":"SubBulkSignerList"},"SignatureRequestBulkSendWithTemplateRequest":{"type":"object","properties":{"template_ids":{"type":"array","items":{"type":"string"},"description":"Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."},"signer_file":{"type":"string","format":"binary","description":"`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **NOTE:** Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"},"signer_list":{"type":"array","items":{"$ref":"#/components/schemas/SubBulkSignerList"},"description":"`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"ccs":{"type":"array","items":{"$ref":"#/components/schemas/SubCC"},"description":"Add CC email recipients. Required when a CC role exists for the Template."},"client_id":{"type":"string","description":"The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."}},"required":["template_ids"],"title":"SignatureRequestBulkSendWithTemplateRequest"},"BulkSendJobResponse":{"type":"object","properties":{"bulk_send_job_id":{"type":["string","null"],"description":"The id of the BulkSendJob."},"total":{"type":"integer","description":"The total amount of Signature Requests queued for sending."},"is_creator":{"type":"boolean","description":"True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member."},"created_at":{"type":"integer","description":"Time that the BulkSendJob was created."}},"description":"Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.","title":"BulkSendJobResponse"},"BulkSendJobSendResponse":{"type":"object","properties":{"bulk_send_job":{"$ref":"#/components/schemas/BulkSendJobResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["bulk_send_job"],"title":"BulkSendJobSendResponse"},"SignatureRequestRemindRequest":{"type":"object","properties":{"email_address":{"type":"string","format":"email","description":"The email address of the signer to send a reminder to."},"name":{"type":"string","description":"The name of the signer to send a reminder to. Include if two or more signers share an email address."}},"required":["email_address"],"title":"SignatureRequestRemindRequest"},"SignatureRequestUpdateRequest":{"type":"object","properties":{"email_address":{"type":"string","format":"email","description":"The new email address for the recipient.\n\nThis will generate a new `signature_id` value.\n\n**NOTE:** Optional if `name` is provided."},"name":{"type":"string","description":"The new name for the recipient.\n\n**NOTE:** Optional if `email_address` is provided."},"signature_id":{"type":"string","description":"The signature ID for the recipient."},"expires_at":{"type":["integer","null"],"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."}},"required":["signature_id"],"title":"SignatureRequestUpdateRequest"},"signatureRequest_cancel_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"signatureRequest_cancel_Response_200"},"signatureRequest_remove_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"signatureRequest_remove_Response_200"},"SignatureRequestBulkCreateEmbeddedWithTemplateRequest":{"type":"object","properties":{"template_ids":{"type":"array","items":{"type":"string"},"description":"Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."},"signer_file":{"type":"string","format":"binary","description":"`signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:\n\n- `name`: the name of the signer filling the role of RoleName\n- `email_address`: email address of the signer filling the role of RoleName\n- `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)\n- `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)\n\n    By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).\n\n    **NOTE:** Not available in test mode and requires a Standard plan or higher.\n- `*_field`: any column with a _field\" suffix will be treated as a custom field (optional)\n\n    You may only specify field values here, any other options should be set in the custom_fields request parameter.\n\nExample CSV:\n\n```\nname, email_address, pin, company_field\nGeorge, george@example.com, d79a3td, ABC Corp\nMary, mary@example.com, gd9as5b, 123 LLC\n```"},"signer_list":{"type":"array","items":{"$ref":"#/components/schemas/SubBulkSignerList"},"description":"`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"ccs":{"type":"array","items":{"$ref":"#/components/schemas/SubCC"},"description":"Add CC email recipients. Required when a CC role exists for the Template."},"client_id":{"type":"string","description":"Client id of the app you're using to create this embedded signature request. Used for security purposes."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."}},"required":["template_ids","client_id"],"title":"SignatureRequestBulkCreateEmbeddedWithTemplateRequest"},"SignatureRequestCreateEmbeddedRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestSigner"},"description":"Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"grouped_signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestGroupedSigners"},"description":"Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_email_addresses":{"type":"array","items":{"type":"string","format":"email"},"description":"The email addresses that should be CCed."},"client_id":{"type":"string","description":"Client id of the app you're using to create this embedded signature request. Used for security purposes."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"hide_text_tags":{"type":"boolean","default":false,"description":"Enables automatic Text Tag removal when set to true.\n\n**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"use_text_tags":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."},"populate_auto_fill_fields":{"type":"boolean","default":false,"description":"Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."},"expires_at":{"type":["integer","null"],"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."}},"required":["client_id"],"title":"SignatureRequestCreateEmbeddedRequest"},"SignatureRequestCreateEmbeddedWithTemplateRequest":{"type":"object","properties":{"template_ids":{"type":"array","items":{"type":"string"},"description":"Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"ccs":{"type":"array","items":{"$ref":"#/components/schemas/SubCC"},"description":"Add CC email recipients. Required when a CC role exists for the Template."},"client_id":{"type":"string","description":"Client id of the app you're using to create this embedded signature request. Used for security purposes."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"An array defining values and options for custom fields. Required when a custom field exists in the Template."},"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestTemplateSigner"},"description":"Add Signers to your Templated-based Signature Request."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"populate_auto_fill_fields":{"type":"boolean","default":false,"description":"Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."}},"required":["template_ids","client_id","signers"],"title":"SignatureRequestCreateEmbeddedWithTemplateRequest"},"SignatureRequestEditRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestSigner"},"description":"Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"grouped_signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestGroupedSigners"},"description":"Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan and higher."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_email_addresses":{"type":"array","items":{"type":"string","format":"email"},"description":"The email addresses that should be CCed."},"client_id":{"type":"string","description":"The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"hide_text_tags":{"type":"boolean","default":false,"description":"Enables automatic Text Tag removal when set to true.\n\n**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."},"is_eid":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://sign.dropbox.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"use_text_tags":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."},"expires_at":{"type":["integer","null"],"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."}},"title":"SignatureRequestEditRequest"},"SignatureRequestEditEmbeddedRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestSigner"},"description":"Add Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"grouped_signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestGroupedSigners"},"description":"Add Grouped Signers to your Signature Request.\n\nThis endpoint requires either **signers** or **grouped_signers**, but not both."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_email_addresses":{"type":"array","items":{"type":"string","format":"email"},"description":"The email addresses that should be CCed."},"client_id":{"type":"string","description":"Client id of the app you're using to create this embedded signature request. Used for security purposes."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"hide_text_tags":{"type":"boolean","default":false,"description":"Enables automatic Text Tag removal when set to true.\n\n**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"use_text_tags":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`."},"populate_auto_fill_fields":{"type":"boolean","default":false,"description":"Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."},"expires_at":{"type":["integer","null"],"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."}},"required":["client_id"],"title":"SignatureRequestEditEmbeddedRequest"},"SignatureRequestEditEmbeddedWithTemplateRequest":{"type":"object","properties":{"template_ids":{"type":"array","items":{"type":"string"},"description":"Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"ccs":{"type":"array","items":{"$ref":"#/components/schemas/SubCC"},"description":"Add CC email recipients. Required when a CC role exists for the Template."},"client_id":{"type":"string","description":"Client id of the app you're using to create this embedded signature request. Used for security purposes."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"An array defining values and options for custom fields. Required when a custom field exists in the Template."},"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestTemplateSigner"},"description":"Add Signers to your Templated-based Signature Request."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"populate_auto_fill_fields":{"type":"boolean","default":false,"description":"Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."}},"required":["template_ids","client_id","signers"],"title":"SignatureRequestEditEmbeddedWithTemplateRequest"},"SignatureRequestEditWithTemplateRequest":{"type":"object","properties":{"template_ids":{"type":"array","items":{"type":"string"},"description":"Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"ccs":{"type":"array","items":{"$ref":"#/components/schemas/SubCC"},"description":"Add CC email recipients. Required when a CC role exists for the Template."},"client_id":{"type":"string","description":"Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"An array defining values and options for custom fields. Required when a custom field exists in the Template."},"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"is_eid":{"type":"boolean","default":false,"description":"Send with a value of `true` if you wish to enable\n[electronic identification (eID)](https://sign.dropbox.com/features/electronic-id),\nwhich requires the signer to verify their identity with an eID provider to sign a document.<br>\n**NOTE:** You need the eID add-on to use this feature. Please [contact sales](https://sign.dropbox.com/form/contact-sales) for more information. Cannot be used in `test_mode`. Only works on requests with one signer."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubSignatureRequestTemplateSigner"},"description":"Add Signers to your Templated-based Signature Request."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."}},"required":["template_ids","signers"],"title":"SignatureRequestEditWithTemplateRequest"},"TemplateResponseSignerRole":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Role."},"order":{"type":"integer","description":"If signer order is assigned this is the 0-based index for this role."}},"title":"TemplateResponseSignerRole"},"TemplateResponseCCRole":{"type":"object","properties":{"name":{"type":"string","description":"The name of the Role."}},"title":"TemplateResponseCCRole"},"TemplateResponseDocumentFieldGroupRule":{"type":"object","properties":{"requirement":{"type":"string","description":"Examples: `require_0-1` `require_1` `require_1-ormore`\n\n- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping).\n- Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping).\n- Radio groups require **at least** two fields per group."},"groupLabel":{"type":"string","description":"Name of the group"}},"description":"The rule used to validate checkboxes in the form field group. See [checkbox field grouping](/api/reference/constants/#checkbox-field-grouping).","title":"TemplateResponseDocumentFieldGroupRule"},"TemplateResponseDocumentFieldGroup":{"type":"object","properties":{"name":{"type":"string","description":"The name of the form field group."},"rule":{"$ref":"#/components/schemas/TemplateResponseDocumentFieldGroupRule"}},"title":"TemplateResponseDocumentFieldGroup"},"TemplateResponseFieldAvgTextLength":{"type":"object","properties":{"num_lines":{"type":"integer","description":"Number of lines."},"num_chars_per_line":{"type":"integer","description":"Number of characters per line."}},"description":"Average text length in this field.","title":"TemplateResponseFieldAvgTextLength"},"TemplateResponseDocumentFormFieldTextValidationType":{"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"],"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.","title":"TemplateResponseDocumentFormFieldTextValidationType"},"TemplateResponseDocumentFormFieldBase":{"oneOf":[{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"avg_text_length":{"$ref":"#/components/schemas/TemplateResponseFieldAvgTextLength"},"isMultiline":{"type":"boolean","description":"Whether this form field is multiline text."},"originalFontSize":{"type":"integer","description":"Original font size used in this form field's text."},"fontFamily":{"type":"string","description":"Font family used in this form field's text."},"validation_type":{"oneOf":[{"$ref":"#/components/schemas/TemplateResponseDocumentFormFieldTextValidationType"},{"type":"null"}],"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."},"validation_custom_regex":{"type":["string","null"],"description":"When `validation_type` is set to `custom_regex`, this specifies the custom regular expression pattern that will be used to validate the text field."},"validation_custom_regex_format_label":{"type":["string","null"],"description":"When `validation_type` is set to `custom_regex`, this specifies the error message displayed to the signer when the text does not match the provided regex pattern."},"group":{"type":["string","null"],"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."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"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."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"avg_text_length":{"$ref":"#/components/schemas/TemplateResponseFieldAvgTextLength"},"isMultiline":{"type":"boolean","description":"Whether this form field is multiline text."},"originalFontSize":{"type":"integer","description":"Original font size used in this form field's text."},"fontFamily":{"type":"string","description":"Font family used in this form field's text."},"group":{"type":["string","null"],"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."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"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."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":"string","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."}},"required":["type","group"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"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."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"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."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the form field."},"name":{"type":"string","description":"The name of the form field."},"signer":{"type":"string","description":"The signer of the Form Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"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."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentFormFieldBase`"}],"discriminator":{"propertyName":"type"},"description":"An array of Form Field objects containing the name and type of each named field.","title":"TemplateResponseDocumentFormFieldBase"},"TemplateResponseDocumentCustomFieldBase":{"oneOf":[{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"name":{"type":"string","description":"The name of the Custom Field."},"signer":{"type":["string","null"],"description":"The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."},"avg_text_length":{"$ref":"#/components/schemas/TemplateResponseFieldAvgTextLength"},"isMultiline":{"type":"boolean","description":"Whether this form field is multiline text."},"originalFontSize":{"type":"integer","description":"Original font size used in this form field's text."},"fontFamily":{"type":"string","description":"Font family used in this form field's text."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentCustomFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"The unique ID for this field."},"name":{"type":"string","description":"The name of the Custom Field."},"signer":{"type":["string","null"],"description":"The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender)."},"x":{"type":"integer","description":"The horizontal offset in pixels for this form field."},"y":{"type":"integer","description":"The vertical offset in pixels for this form field."},"width":{"type":"integer","description":"The width in pixels of this form field."},"height":{"type":"integer","description":"The height in pixels of this form field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentCustomFieldBase`"}],"discriminator":{"propertyName":"type"},"description":"An array of Form Field objects containing the name and type of each named field.","title":"TemplateResponseDocumentCustomFieldBase"},"TemplateResponseDocumentStaticFieldBase":{"oneOf":[{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"},{"type":"object","properties":{"type":{"type":"string"},"api_id":{"type":"string","description":"A unique id for the static field."},"name":{"type":"string","description":"The name of the static field."},"signer":{"type":"string","default":"me_now","description":"The signer of the Static Field."},"x":{"type":"integer","description":"The horizontal offset in pixels for this static field."},"y":{"type":"integer","description":"The vertical offset in pixels for this static field."},"width":{"type":"integer","description":"The width in pixels of this static field."},"height":{"type":"integer","description":"The height in pixels of this static field."},"required":{"type":"boolean","description":"Boolean showing whether or not this field is required."},"group":{"type":["string","null"],"description":"The name of the group this field is in. If this field is not a group, this defaults to `null`."}},"required":["type"],"description":"This class extends `TemplateResponseDocumentStaticFieldBase`"}],"discriminator":{"propertyName":"type"},"description":"An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.","title":"TemplateResponseDocumentStaticFieldBase"},"TemplateResponseDocument":{"type":"object","properties":{"name":{"type":"string","description":"Name of the associated file."},"index":{"type":"integer","description":"Document ordering, the lowest index is displayed first and the highest last (0-based indexing)."},"field_groups":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseDocumentFieldGroup"},"description":"An array of Form Field Group objects."},"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseDocumentFormFieldBase"},"description":"An array of Form Field objects containing the name and type of each named field."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseDocumentCustomFieldBase"},"description":"An array of Form Field objects containing the name and type of each named field."},"static_fields":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseDocumentStaticFieldBase"},"description":"An array describing static overlay fields. **NOTE:** Only available for certain subscriptions."}},"title":"TemplateResponseDocument"},"TemplateResponseAccountQuota":{"type":"object","properties":{"templates_left":{"type":"integer","description":"API templates remaining."},"api_signature_requests_left":{"type":"integer","description":"API signature requests remaining."},"documents_left":{"type":"integer","description":"Signature requests remaining."},"sms_verifications_left":{"type":"integer","description":"SMS verifications remaining."}},"description":"An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template.","title":"TemplateResponseAccountQuota"},"TemplateResponseAccount":{"type":"object","properties":{"account_id":{"type":"string","description":"The id of the Account."},"email_address":{"type":"string","description":"The email address associated with the Account."},"is_locked":{"type":"boolean","description":"Returns `true` if the user has been locked out of their account by a team admin."},"is_paid_hs":{"type":"boolean","description":"Returns `true` if the user has a paid Dropbox Sign account."},"is_paid_hf":{"type":"boolean","description":"Returns `true` if the user has a paid HelloFax account."},"quotas":{"$ref":"#/components/schemas/TemplateResponseAccountQuota"}},"title":"TemplateResponseAccount"},"TemplateResponse":{"type":"object","properties":{"template_id":{"type":"string","description":"The id of the Template."},"title":{"type":"string","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."},"message":{"type":"string","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."},"updated_at":{"type":"integer","description":"Time the template was last updated."},"is_embedded":{"type":["boolean","null"],"description":"`true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template."},"is_creator":{"type":"boolean","description":"`true` if you are the owner of this template, `false` if it's been shared with you by a team member."},"can_edit":{"type":"boolean","description":"Indicates whether edit rights have been granted to you by the owner (always `true` if that's you)."},"is_locked":{"type":"boolean","description":"Indicates whether the template is locked.\nIf `true`, then the template was created outside your quota and can only be used in `test_mode`.\nIf `false`, then the template is within your quota and can be used to create signature requests."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The metadata attached to the template."},"signer_roles":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseSignerRole"},"description":"An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."},"cc_roles":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseCCRole"},"description":"An array of the designated CC roles that must be specified when sending a SignatureRequest using this Template."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseDocument"},"description":"An array describing each document associated with this Template. Includes form field data for each document."},"custom_fields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TemplateResponseDocumentCustomFieldBase"},"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."},"named_form_fields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TemplateResponseDocumentFormFieldBase"},"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."},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponseAccount"},"description":"An array of the Accounts that can use this Template."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SignatureRequestResponseAttachment"},"description":"Signer attachments."}},"description":"Contains information about the templates you and your team have created.","title":"TemplateResponse"},"TemplateGetResponse":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/TemplateResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["template"],"title":"TemplateGetResponse"},"TemplateListResponse":{"type":"object","properties":{"templates":{"type":"array","items":{"$ref":"#/components/schemas/TemplateResponse"},"description":"List of templates that the API caller has access to."},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["templates","list_info"],"title":"TemplateListResponse"},"SubMergeFieldType":{"type":"string","enum":["text","checkbox"],"description":"The type of merge field.","title":"SubMergeFieldType"},"SubMergeField":{"type":"object","properties":{"name":{"type":"string","description":"The name of the merge field. Must be unique."},"type":{"$ref":"#/components/schemas/SubMergeFieldType","description":"The type of merge field."}},"required":["name","type"],"title":"SubMergeField"},"SubTemplateRole":{"type":"object","properties":{"name":{"type":"string","description":"The role name of the signer that will be displayed when the template is used to create a signature request."},"order":{"type":["integer","null"],"description":"The order in which this signer role is required to sign."}},"title":"SubTemplateRole"},"TemplateCreateRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan and higher."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_roles":{"type":"array","items":{"type":"string"},"description":"The CC roles that must be assigned when using the template to send a signature request"},"client_id":{"type":"string","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."},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"merge_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubMergeField"},"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.\nIf the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document."},"message":{"type":"string","description":"The default template email message."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"signer_roles":{"type":"array","items":{"$ref":"#/components/schemas/SubTemplateRole"},"description":"An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."},"subject":{"type":"string","description":"The template title (alias)."},"test_mode":{"type":"boolean","default":false,"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`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"use_preexisting_fields":{"type":"boolean","default":false,"description":"Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`)."}},"required":["form_fields_per_document","signer_roles"],"title":"TemplateCreateRequest"},"TemplateCreateResponseTemplate":{"type":"object","properties":{"template_id":{"type":"string","description":"The id of the Template."}},"description":"Template object with parameters: `template_id`.","title":"TemplateCreateResponseTemplate"},"TemplateCreateResponse":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/TemplateCreateResponseTemplate"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["template"],"title":"TemplateCreateResponse"},"SubEditorOptions":{"type":"object","properties":{"allow_edit_signers":{"type":"boolean","default":false,"description":"Allows requesters to edit the list of signers"},"allow_edit_documents":{"type":"boolean","default":false,"description":"Allows requesters to edit documents, including delete and add"}},"description":"This allows the requester to specify editor options when a preparing a document","title":"SubEditorOptions"},"TemplateCreateEmbeddedDraftRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"allow_ccs":{"type":"boolean","default":true,"description":"This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan and higher."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_roles":{"type":"array","items":{"type":"string"},"description":"The CC roles that must be assigned when using the template to send a signature request"},"client_id":{"type":"string","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."},"editor_options":{"$ref":"#/components/schemas/SubEditorOptions"},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"force_signer_roles":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the template signer roles."},"force_subject_message":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the template subject and message."},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"merge_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubMergeField"},"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.\nIf the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document."},"message":{"type":"string","description":"The default template email message."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"show_preview":{"type":"boolean","default":false,"description":"This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."},"show_progress_stepper":{"type":"boolean","default":true,"description":"When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."},"signer_roles":{"type":"array","items":{"$ref":"#/components/schemas/SubTemplateRole"},"description":"An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template."},"skip_me_now":{"type":"boolean","default":false,"description":"Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."},"subject":{"type":"string","description":"The template title (alias)."},"test_mode":{"type":"boolean","default":false,"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`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"use_preexisting_fields":{"type":"boolean","default":false,"description":"Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`)."}},"required":["client_id"],"title":"TemplateCreateEmbeddedDraftRequest"},"TemplateCreateEmbeddedDraftResponseTemplate":{"type":"object","properties":{"template_id":{"type":"string","description":"The id of the Template."},"edit_url":{"type":"string","description":"Link to edit the template."},"expires_at":{"type":"integer","description":"When the link expires."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"description":"Template object with parameters: `template_id`, `edit_url`, `expires_at`.","title":"TemplateCreateEmbeddedDraftResponseTemplate"},"TemplateCreateEmbeddedDraftResponse":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["template"],"title":"TemplateCreateEmbeddedDraftResponse"},"template_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"template_delete_Response_200"},"TemplateFilesTemplateIdGetParametersFileType":{"type":"string","enum":["pdf","zip"],"title":"TemplateFilesTemplateIdGetParametersFileType"},"TemplateUpdateFilesRequest":{"type":"object","properties":{"client_id":{"type":"string","description":"Client id of the app you're using to update this template."},"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to use for the template.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to use for the template.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"message":{"type":"string","description":"The new default template email message."},"subject":{"type":"string","description":"The new default template email subject."},"test_mode":{"type":"boolean","default":false,"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`."}},"title":"TemplateUpdateFilesRequest"},"TemplateUpdateFilesResponseTemplate":{"type":"object","properties":{"template_id":{"type":"string","description":"The id of the Template."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"description":"Contains template id","title":"TemplateUpdateFilesResponseTemplate"},"TemplateUpdateFilesResponse":{"type":"object","properties":{"template":{"$ref":"#/components/schemas/TemplateUpdateFilesResponseTemplate"}},"required":["template"],"title":"TemplateUpdateFilesResponse"},"TemplateAddUserRequest":{"type":"object","properties":{"account_id":{"type":"string","description":"The id of the Account to give access to the Template.\n**NOTE:** The account id prevails if email address is also provided."},"email_address":{"type":"string","format":"email","description":"The email address of the Account to give access to the Template.\n**NOTE:** The account id prevails if it is also provided."},"skip_notification":{"type":"boolean","default":false,"description":"If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`."}},"title":"TemplateAddUserRequest"},"TemplateRemoveUserRequest":{"type":"object","properties":{"account_id":{"type":"string","description":"The id or email address of the Account to remove access to the Template. The account id prevails if both are provided."},"email_address":{"type":"string","format":"email","description":"The id or email address of the Account to remove access to the Template. The account id prevails if both are provided."}},"title":"TemplateRemoveUserRequest"},"BulkSendJobGetResponseSignatureRequests":{"type":"object","properties":{"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test signature request. Test requests have no legal value. Defaults to `false`."},"signature_request_id":{"type":"string","description":"The id of the SignatureRequest."},"requester_email_address":{"type":["string","null"],"description":"The email address of the initiator of the SignatureRequest."},"title":{"type":"string","description":"The title the specified Account uses for the SignatureRequest."},"original_title":{"type":"string","description":"Default Label for account."},"subject":{"type":["string","null"],"description":"The subject in the email that was initially sent to the signers."},"message":{"type":["string","null"],"description":"The custom message in the email that was initially sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"The metadata attached to the signature request."},"created_at":{"type":"integer","description":"Time the signature request was created."},"expires_at":{"type":["integer","null"],"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."},"is_complete":{"type":"boolean","description":"Whether or not the SignatureRequest has been fully executed by all signers."},"is_declined":{"type":"boolean","description":"Whether or not the SignatureRequest has been declined by a signer."},"has_error":{"type":"boolean","description":"Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings)."},"files_url":{"type":"string","description":"The URL where a copy of the request's documents can be downloaded."},"signing_url":{"type":["string","null"],"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."},"details_url":{"type":"string","description":"The URL where the requester and the signers can view the current status of the SignatureRequest."},"cc_email_addresses":{"type":"array","items":{"type":"string"},"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."},"signing_redirect_url":{"type":["string","null"],"description":"The URL you want the signer redirected to after they successfully sign."},"final_copy_uri":{"type":["string","null"],"description":"The path where the completed document can be downloaded"},"template_ids":{"type":["array","null"],"items":{"type":"string"},"description":"Templates IDs used in this SignatureRequest (if any)."},"custom_fields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SignatureRequestResponseCustomFieldBase"},"description":"An array of Custom Field objects containing the name and type of each custom field.\n\n* Text Field uses `SignatureRequestResponseCustomFieldText`\n* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`"},"attachments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/SignatureRequestResponseAttachment"},"description":"Signer attachments."},"response_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/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."},"signatures":{"type":"array","items":{"$ref":"#/components/schemas/SignatureRequestResponseSignatures"},"description":"An array of signature objects, 1 for each signer."},"bulk_send_job_id":{"type":["string","null"],"description":"The id of the BulkSendJob."}},"title":"BulkSendJobGetResponseSignatureRequests"},"BulkSendJobGetResponse":{"type":"object","properties":{"bulk_send_job":{"$ref":"#/components/schemas/BulkSendJobResponse"},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"signature_requests":{"type":"array","items":{"$ref":"#/components/schemas/BulkSendJobGetResponseSignatureRequests"},"description":"Contains information about the Signature Requests sent in bulk."},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["bulk_send_job","list_info","signature_requests"],"title":"BulkSendJobGetResponse"},"BulkSendJobListResponse":{"type":"object","properties":{"bulk_send_jobs":{"type":"array","items":{"$ref":"#/components/schemas/BulkSendJobResponse"},"description":"Contains a list of BulkSendJobs that the API caller has access to."},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["bulk_send_jobs","list_info"],"title":"BulkSendJobListResponse"},"ReportCreateRequestReportTypeItems":{"type":"string","enum":["user_activity","document_status","sms_activity","fax_usage"],"title":"ReportCreateRequestReportTypeItems"},"ReportCreateRequest":{"type":"object","properties":{"end_date":{"type":"string","description":"The (inclusive) end date for the report data in `MM/DD/YYYY` format."},"report_type":{"type":"array","items":{"$ref":"#/components/schemas/ReportCreateRequestReportTypeItems"},"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)."},"start_date":{"type":"string","description":"The (inclusive) start date for the report data in `MM/DD/YYYY` format."}},"required":["end_date","report_type","start_date"],"title":"ReportCreateRequest"},"ReportResponseReportTypeItems":{"type":"string","enum":["user_activity","document_status","sms_activity","fax_usage"],"title":"ReportResponseReportTypeItems"},"ReportResponse":{"type":"object","properties":{"success":{"type":"string","description":"A message indicating the requested operation's success"},"start_date":{"type":"string","description":"The (inclusive) start date for the report data in MM/DD/YYYY format."},"end_date":{"type":"string","description":"The (inclusive) end date for the report data in MM/DD/YYYY format."},"report_type":{"type":"array","items":{"$ref":"#/components/schemas/ReportResponseReportTypeItems"},"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)."}},"description":"Contains information about the report request.","title":"ReportResponse"},"ReportCreateResponse":{"type":"object","properties":{"report":{"$ref":"#/components/schemas/ReportResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["report"],"title":"ReportCreateResponse"},"TeamResponse":{"type":"object","properties":{"name":{"type":"string","description":"The name of your Team"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountResponse"}},"invited_accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountResponse"},"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`."},"invited_emails":{"type":"array","items":{"type":"string"},"description":"A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account."}},"description":"Contains information about your team and its members","title":"TeamResponse"},"TeamGetResponse":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/TeamResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["team"],"title":"TeamGetResponse"},"TeamParentResponse":{"type":"object","properties":{"team_id":{"type":"string","description":"The id of a team"},"name":{"type":"string","description":"The name of a team"}},"description":"Information about the parent team if a team has one, set to `null` otherwise.","title":"TeamParentResponse"},"TeamInfoResponse":{"type":"object","properties":{"team_id":{"type":"string","description":"The id of a team"},"team_parent":{"$ref":"#/components/schemas/TeamParentResponse"},"name":{"type":"string","description":"The name of a team"},"num_members":{"type":"integer","description":"Number of members within a team"},"num_sub_teams":{"type":"integer","description":"Number of sub teams within a team"}},"title":"TeamInfoResponse"},"TeamGetInfoResponse":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/TeamInfoResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["team"],"title":"TeamGetInfoResponse"},"TeamMemberResponse":{"type":"object","properties":{"account_id":{"type":"string","description":"Account id of the team member."},"email_address":{"type":"string","description":"Email address of the team member."},"role":{"type":"string","description":"The specific role a member has on the team."}},"title":"TeamMemberResponse"},"TeamMembersResponse":{"type":"object","properties":{"team_members":{"type":"array","items":{"$ref":"#/components/schemas/TeamMemberResponse"},"description":"Contains a list of team members and their roles for a specific team."},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"}}},"required":["team_members","list_info"],"title":"TeamMembersResponse"},"SubTeamResponse":{"type":"object","properties":{"team_id":{"type":"string","description":"The id of a team"},"name":{"type":"string","description":"The name of a team"}},"title":"SubTeamResponse"},"TeamSubTeamsResponse":{"type":"object","properties":{"sub_teams":{"type":"array","items":{"$ref":"#/components/schemas/SubTeamResponse"},"description":"Contains a list with sub teams."},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"}}},"required":["sub_teams","list_info"],"title":"TeamSubTeamsResponse"},"TeamCreateRequest":{"type":"object","properties":{"name":{"type":"string","default":"Untitled Team","description":"The name of your Team."}},"title":"TeamCreateRequest"},"TeamUpdateRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of your Team."}},"title":"TeamUpdateRequest"},"team_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"team_delete_Response_200"},"TeamAddMemberRequestRole":{"type":"string","enum":["Member","Developer","Team Manager","Admin"],"description":"A role member will take in a new Team.\n\n**NOTE:** This parameter is used only if `team_id` is provided.","title":"TeamAddMemberRequestRole"},"TeamAddMemberRequest":{"type":"object","properties":{"account_id":{"type":"string","description":"`account_id` or `email_address` is required. If both are provided, the account id prevails.\n\nAccount id of the user to invite to your Team."},"email_address":{"type":"string","format":"email","description":"`account_id` or `email_address` is required, If both are provided, the account id prevails.\n\nEmail address of the user to invite to your Team."},"role":{"$ref":"#/components/schemas/TeamAddMemberRequestRole","description":"A role member will take in a new Team.\n\n**NOTE:** This parameter is used only if `team_id` is provided."}},"title":"TeamAddMemberRequest"},"TeamRemoveMemberRequestNewRole":{"type":"string","enum":["Member","Developer","Team Manager","Admin"],"description":"A new role member will take in a new Team.\n\n**NOTE:** This parameter is used only if `new_team_id` is provided.","title":"TeamRemoveMemberRequestNewRole"},"TeamRemoveMemberRequest":{"type":"object","properties":{"account_id":{"type":"string","description":"**account_id** or **email_address** is required. If both are provided, the account id prevails.\n\nAccount id to remove from your Team."},"email_address":{"type":"string","format":"email","description":"**account_id** or **email_address** is required. If both are provided, the account id prevails.\n\nEmail address of the Account to remove from your Team."},"new_owner_email_address":{"type":"string","format":"email","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.\n\n**NOTE:** Only available for Enterprise plans."},"new_team_id":{"type":"string","description":"Id of the new Team."},"new_role":{"$ref":"#/components/schemas/TeamRemoveMemberRequestNewRole","description":"A new role member will take in a new Team.\n\n**NOTE:** This parameter is used only if `new_team_id` is provided."}},"title":"TeamRemoveMemberRequest"},"SubUnclaimedDraftSigner":{"type":"object","properties":{"email_address":{"type":"string","format":"email","description":"The email address of the signer."},"name":{"type":"string","description":"The name of the signer."},"order":{"type":["integer","null"],"description":"The order the signer is required to sign in."}},"required":["email_address","name"],"title":"SubUnclaimedDraftSigner"},"UnclaimedDraftCreateRequestType":{"type":"string","enum":["send_document","request_signature"],"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.","title":"UnclaimedDraftCreateRequestType"},"UnclaimedDraftCreateRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_email_addresses":{"type":"array","items":{"type":"string","format":"email"},"description":"The email addresses that should be CCed."},"client_id":{"type":"string","description":"Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"hide_text_tags":{"type":"boolean","default":false,"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."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"show_progress_stepper":{"type":"boolean","default":true,"description":"When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubUnclaimedDraftSigner"},"description":"Add Signers to your Unclaimed Draft Signature Request."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"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":{"$ref":"#/components/schemas/UnclaimedDraftCreateRequestType","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."},"use_preexisting_fields":{"type":"boolean","default":false,"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."},"use_text_tags":{"type":"boolean","default":false,"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."},"expires_at":{"type":["integer","null"],"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.\n\n**NOTE:** This does not correspond to the **expires_at** returned in the response."}},"required":["type"],"title":"UnclaimedDraftCreateRequest"},"UnclaimedDraftResponse":{"type":"object","properties":{"signature_request_id":{"type":["string","null"],"description":"The ID of the signature request that is represented by this UnclaimedDraft."},"claim_url":{"type":"string","description":"The URL to be used to claim this UnclaimedDraft."},"signing_redirect_url":{"type":["string","null"],"description":"The URL you want signers redirected to after they successfully sign."},"requesting_redirect_url":{"type":["string","null"],"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.)."},"expires_at":{"type":["integer","null"],"description":"When the link expires."},"test_mode":{"type":"boolean","description":"Whether this is a test draft. Signature requests made from test drafts have no legal value."}},"description":"A group of documents that a user can take ownership of via the claim URL.","title":"UnclaimedDraftResponse"},"UnclaimedDraftCreateResponse":{"type":"object","properties":{"unclaimed_draft":{"$ref":"#/components/schemas/UnclaimedDraftResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["unclaimed_draft"],"title":"UnclaimedDraftCreateResponse"},"UnclaimedDraftCreateEmbeddedRequestType":{"type":"string","enum":["send_document","request_signature"],"default":"request_signature","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.","title":"UnclaimedDraftCreateEmbeddedRequestType"},"UnclaimedDraftCreateEmbeddedRequest":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"allow_ccs":{"type":"boolean","default":true,"description":"This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft."},"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan and higher."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/SubAttachment"},"description":"A list describing the attachments"},"cc_email_addresses":{"type":"array","items":{"type":"string","format":"email"},"description":"The email addresses that should be CCed."},"client_id":{"type":"string","description":"Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.\n\nPre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.\n\nFor using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template."},"editor_options":{"$ref":"#/components/schemas/SubEditorOptions"},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"force_signer_page":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the signers."},"force_subject_message":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the subject and message."},"form_field_groups":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldGroup"},"description":"Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`."},"form_field_rules":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldRule"},"description":"Conditional Logic rules for fields defined in `form_fields_per_document`."},"form_fields_per_document":{"type":"array","items":{"$ref":"#/components/schemas/SubFormFieldsPerDocumentBase"},"description":"The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)\n\n**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.\n\n* Text Field use `SubFormFieldsPerDocumentText`\n* Dropdown Field use `SubFormFieldsPerDocumentDropdown`\n* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`\n* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`\n* Radio Field use `SubFormFieldsPerDocumentRadio`\n* Signature Field use `SubFormFieldsPerDocumentSignature`\n* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`\n* Initials Field use `SubFormFieldsPerDocumentInitials`\n* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`\n* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`"},"hide_text_tags":{"type":"boolean","default":false,"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."},"hold_request":{"type":"boolean","default":false,"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`."},"is_for_embedded_signing":{"type":"boolean","default":false,"description":"The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"requester_email_address":{"type":"string","format":"email","description":"The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`."},"requesting_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully request a signature."},"show_preview":{"type":"boolean","description":"This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."},"show_progress_stepper":{"type":"boolean","default":true,"description":"When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubUnclaimedDraftSigner"},"description":"Add Signers to your Unclaimed Draft Signature Request."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"skip_me_now":{"type":"boolean","default":false,"description":"Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"test_mode":{"type":"boolean","default":false,"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":{"$ref":"#/components/schemas/UnclaimedDraftCreateEmbeddedRequestType","default":"request_signature","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."},"use_preexisting_fields":{"type":"boolean","default":false,"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."},"use_text_tags":{"type":"boolean","default":false,"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."},"populate_auto_fill_fields":{"type":"boolean","default":false,"description":"Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."},"expires_at":{"type":["integer","null"],"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.\n\n**NOTE:** This does not correspond to the **expires_at** returned in the response."}},"required":["client_id","requester_email_address"],"title":"UnclaimedDraftCreateEmbeddedRequest"},"SubUnclaimedDraftTemplateSigner":{"type":"object","properties":{"role":{"type":"string","description":"Must match an existing role in chosen Template(s)."},"name":{"type":"string","description":"The name of the signer filling the role of `role`."},"email_address":{"type":"string","format":"email","description":"The email address of the signer filling the role of `role`."}},"required":["role","name","email_address"],"title":"SubUnclaimedDraftTemplateSigner"},"UnclaimedDraftCreateEmbeddedWithTemplateRequest":{"type":"object","properties":{"allow_decline":{"type":"boolean","default":false,"description":"Allows signers to decline to sign a document if `true`. Defaults to `false`."},"allow_reassign":{"type":"boolean","default":false,"description":"Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.\n\n**NOTE:** Only available for Premium plan and higher."},"ccs":{"type":"array","items":{"$ref":"#/components/schemas/SubCC"},"description":"Add CC email recipients. Required when a CC role exists for the Template."},"client_id":{"type":"string","description":"Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubCustomField"},"description":"An array defining values and options for custom fields. Required when a custom field exists in the Template."},"editor_options":{"$ref":"#/components/schemas/SubEditorOptions"},"field_options":{"$ref":"#/components/schemas/SubFieldOptions"},"files":{"type":"array","items":{"type":"string","format":"binary"},"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.\n\n**files** or **file_urls[]** is required, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"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.\n\n**files** or **file_urls[]** is required, but not both."},"force_signer_roles":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the template signer roles."},"force_subject_message":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the template subject and message."},"hold_request":{"type":"boolean","default":false,"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`."},"is_for_embedded_signing":{"type":"boolean","default":false,"description":"The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`."},"message":{"type":"string","description":"The custom message in the email that will be sent to the signers."},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.\n\nEach request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long."},"preview_only":{"type":"boolean","default":false,"description":"This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).\n\n- `preview_only=true`: Allows requesters to enable the preview only experience.\n- `preview_only=false`: Allows requesters to disable the preview only experience.\n\n**NOTE:** This parameter overwrites `show_preview=1` (if set)."},"requester_email_address":{"type":"string","format":"email","description":"The email address of the user that should be designated as the requester of this draft."},"requesting_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully request a signature."},"show_preview":{"type":"boolean","default":false,"description":"This allows the requester to enable the editor/preview experience.\n\n- `show_preview=true`: Allows requesters to enable the editor/preview experience.\n- `show_preview=false`: Allows requesters to disable the editor/preview experience."},"show_progress_stepper":{"type":"boolean","default":true,"description":"When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."},"signers":{"type":"array","items":{"$ref":"#/components/schemas/SubUnclaimedDraftTemplateSigner"},"description":"Add Signers to your Templated-based Signature Request."},"signing_options":{"$ref":"#/components/schemas/SubSigningOptions"},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"skip_me_now":{"type":"boolean","default":false,"description":"Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`."},"subject":{"type":"string","description":"The subject in the email that will be sent to the signers."},"template_ids":{"type":"array","items":{"type":"string"},"description":"Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used."},"test_mode":{"type":"boolean","default":false,"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`."},"title":{"type":"string","description":"The title you want to assign to the SignatureRequest."},"populate_auto_fill_fields":{"type":"boolean","default":false,"description":"Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.\n\n**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature."},"allow_ccs":{"type":"boolean","default":false,"description":"This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft."}},"required":["client_id","requester_email_address","template_ids"],"title":"UnclaimedDraftCreateEmbeddedWithTemplateRequest"},"UnclaimedDraftEditAndResendRequest":{"type":"object","properties":{"client_id":{"type":"string","description":"Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app."},"editor_options":{"$ref":"#/components/schemas/SubEditorOptions"},"is_for_embedded_signing":{"type":"boolean","description":"The request created from this draft will also be signable in embedded mode if set to `true`."},"requester_email_address":{"type":"string","format":"email","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."},"requesting_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully request a signature."},"show_progress_stepper":{"type":"boolean","default":true,"description":"When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."},"signing_redirect_url":{"type":"string","description":"The URL you want signers redirected to after they successfully sign."},"test_mode":{"type":"boolean","default":false,"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`."}},"required":["client_id"],"title":"UnclaimedDraftEditAndResendRequest"},"EmbeddedSignUrlResponseEmbedded":{"type":"object","properties":{"sign_url":{"type":"string","description":"A signature url that can be opened in an iFrame."},"expires_at":{"type":"integer","description":"The specific time that the the `sign_url` link expires, in epoch."}},"description":"An object that contains necessary information to set up embedded signing.","title":"EmbeddedSignUrlResponseEmbedded"},"EmbeddedSignUrlResponse":{"type":"object","properties":{"embedded":{"$ref":"#/components/schemas/EmbeddedSignUrlResponseEmbedded"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["embedded"],"title":"EmbeddedSignUrlResponse"},"EmbeddedEditUrlRequest":{"type":"object","properties":{"allow_edit_ccs":{"type":"boolean","default":false,"description":"This allows the requester to enable/disable to add or change CC roles when editing the template."},"cc_roles":{"type":"array","items":{"type":"string"},"description":"The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request."},"editor_options":{"$ref":"#/components/schemas/SubEditorOptions"},"force_signer_roles":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the template signer roles."},"force_subject_message":{"type":"boolean","default":false,"description":"Provide users the ability to review/edit the template subject and message."},"merge_fields":{"type":"array","items":{"$ref":"#/components/schemas/SubMergeField"},"description":"Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.\n\nRemove all merge fields on the template by passing an empty array `[]`."},"preview_only":{"type":"boolean","default":false,"description":"This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).\n\n**NOTE:** This parameter overwrites `show_preview=true` (if set)."},"show_preview":{"type":"boolean","default":false,"description":"This allows the requester to enable the editor/preview experience."},"show_progress_stepper":{"type":"boolean","default":true,"description":"When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden."},"test_mode":{"type":"boolean","default":false,"description":"Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`."}},"title":"EmbeddedEditUrlRequest"},"EmbeddedEditUrlResponseEmbedded":{"type":"object","properties":{"edit_url":{"type":"string","description":"A template url that can be opened in an iFrame."},"expires_at":{"type":"integer","description":"The specific time that the the `edit_url` link expires, in epoch."}},"description":"An embedded template object.","title":"EmbeddedEditUrlResponseEmbedded"},"EmbeddedEditUrlResponse":{"type":"object","properties":{"embedded":{"$ref":"#/components/schemas/EmbeddedEditUrlResponseEmbedded"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["embedded"],"title":"EmbeddedEditUrlResponse"},"ApiAppResponseOAuth":{"type":"object","properties":{"callback_url":{"type":"string","description":"The app's OAuth callback URL."},"secret":{"type":["string","null"],"description":"The app's OAuth secret, or null if the app does not belong to user."},"scopes":{"type":"array","items":{"type":"string"},"description":"Array of OAuth scopes used by the app."},"charges_users":{"type":"boolean","description":"Boolean indicating whether the app owner or the account granting permission is billed for OAuth requests."}},"description":"An object describing the app's OAuth properties, or null if OAuth is not configured for the app.","title":"ApiAppResponseOAuth"},"ApiAppResponseOptions":{"type":"object","properties":{"can_insert_everywhere":{"type":"boolean","description":"Boolean denoting if signers can \"Insert Everywhere\" in one click while signing a document"}},"description":"An object with options that override account settings.","title":"ApiAppResponseOptions"},"ApiAppResponseOwnerAccount":{"type":"object","properties":{"account_id":{"type":"string","description":"The owner account's ID"},"email_address":{"type":"string","description":"The owner account's email address"}},"description":"An object describing the app's owner","title":"ApiAppResponseOwnerAccount"},"ApiAppResponseWhiteLabelingOptions":{"type":"object","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"}},"description":"An object with options to customize the app's signer page","title":"ApiAppResponseWhiteLabelingOptions"},"ApiAppResponse":{"type":"object","properties":{"callback_url":{"type":["string","null"],"description":"The app's callback URL (for events)"},"client_id":{"type":"string","description":"The app's client id"},"created_at":{"type":"integer","description":"The time that the app was created"},"domains":{"type":"array","items":{"type":"string"},"description":"The domain name(s) associated with the app"},"name":{"type":"string","description":"The name of the app"},"is_approved":{"type":"boolean","description":"Boolean to indicate if the app has been approved"},"oauth":{"$ref":"#/components/schemas/ApiAppResponseOAuth"},"options":{"$ref":"#/components/schemas/ApiAppResponseOptions"},"owner_account":{"$ref":"#/components/schemas/ApiAppResponseOwnerAccount"},"white_labeling_options":{"$ref":"#/components/schemas/ApiAppResponseWhiteLabelingOptions"}},"description":"Contains information about an API App.","title":"ApiAppResponse"},"ApiAppGetResponse":{"type":"object","properties":{"api_app":{"$ref":"#/components/schemas/ApiAppResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["api_app"],"title":"ApiAppGetResponse"},"ApiAppListResponse":{"type":"object","properties":{"api_apps":{"type":"array","items":{"$ref":"#/components/schemas/ApiAppResponse"},"description":"Contains information about API Apps."},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["api_apps","list_info"],"title":"ApiAppListResponse"},"SubOAuthScopesItems":{"type":"string","enum":["request_signature","basic_account_info","account_access","signature_request_access","template_access","team_access","api_app_access",""],"title":"SubOAuthScopesItems"},"SubOAuth":{"type":"object","properties":{"callback_url":{"type":"string","description":"The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)"},"scopes":{"type":"array","items":{"$ref":"#/components/schemas/SubOAuthScopesItems"},"description":"A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided)."}},"description":"OAuth related parameters.","title":"SubOAuth"},"SubOptions":{"type":"object","properties":{"can_insert_everywhere":{"type":"boolean","default":false,"description":"Determines if signers can use \"Insert Everywhere\" when signing a document."}},"description":"Additional options supported by API App.","title":"SubOptions"},"SubWhiteLabelingOptionsLegalVersion":{"type":"string","enum":["terms1","terms2"],"default":"terms1","title":"SubWhiteLabelingOptionsLegalVersion"},"SubWhiteLabelingOptions":{"type":"object","properties":{"header_background_color":{"type":"string","default":"#1a1a1a"},"legal_version":{"$ref":"#/components/schemas/SubWhiteLabelingOptionsLegalVersion","default":"terms1"},"link_color":{"type":"string","default":"#0061FE"},"page_background_color":{"type":"string","default":"#f7f8f9"},"primary_button_color":{"type":"string","default":"#0061FE"},"primary_button_color_hover":{"type":"string","default":"#0061FE"},"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":"#0061FE"},"secondary_button_text_color_hover":{"type":"string","default":"#0061FE"},"text_color1":{"type":"string","default":"#808080"},"text_color2":{"type":"string","default":"#ffffff"},"reset_to_default":{"type":"boolean","description":"Resets white labeling options to defaults. Only useful when updating an API App."}},"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)\n\nTake a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.","title":"SubWhiteLabelingOptions"},"ApiAppCreateRequest":{"type":"object","properties":{"callback_url":{"type":"string","description":"The URL at which the ApiApp should receive event callbacks."},"custom_logo_file":{"type":"string","format":"binary","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)"},"domains":{"type":"array","items":{"type":"string"},"description":"The domain names the ApiApp will be associated with."},"name":{"type":"string","description":"The name you want to assign to the ApiApp."},"oauth":{"$ref":"#/components/schemas/SubOAuth"},"options":{"$ref":"#/components/schemas/SubOptions"},"white_labeling_options":{"$ref":"#/components/schemas/SubWhiteLabelingOptions"}},"required":["domains","name"],"title":"ApiAppCreateRequest"},"ApiAppUpdateRequest":{"type":"object","properties":{"callback_url":{"type":"string","description":"The URL at which the API App should receive event callbacks."},"custom_logo_file":{"type":"string","format":"binary","description":"An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)"},"domains":{"type":"array","items":{"type":"string"},"description":"The domain names the ApiApp will be associated with."},"name":{"type":"string","description":"The name you want to assign to the ApiApp."},"oauth":{"$ref":"#/components/schemas/SubOAuth"},"options":{"$ref":"#/components/schemas/SubOptions"},"white_labeling_options":{"$ref":"#/components/schemas/SubWhiteLabelingOptions"}},"title":"ApiAppUpdateRequest"},"FaxResponseTransmissionStatusCode":{"type":"string","enum":["success","transmitting","error_could_not_fax","error_unknown","error_busy","error_no_answer","error_disconnected","error_bad_destination"],"description":"Fax Transmission Status Code","title":"FaxResponseTransmissionStatusCode"},"FaxResponseTransmission":{"type":"object","properties":{"recipient":{"type":"string","description":"Fax Transmission Recipient"},"status_code":{"$ref":"#/components/schemas/FaxResponseTransmissionStatusCode","description":"Fax Transmission Status Code"},"sent_at":{"type":"integer","description":"Fax Transmission Sent Timestamp"}},"required":["recipient","status_code"],"title":"FaxResponseTransmission"},"FaxResponse":{"type":"object","properties":{"fax_id":{"type":"string","description":"Fax ID"},"title":{"type":"string","description":"Fax Title"},"original_title":{"type":"string","description":"Fax Original Title"},"subject":{"type":["string","null"],"description":"Fax Subject"},"message":{"type":["string","null"],"description":"Fax Message"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Fax Metadata"},"created_at":{"type":"integer","description":"Fax Created At Timestamp"},"sender":{"type":"string","description":"Fax Sender Email"},"files_url":{"type":"string","description":"Fax Files URL"},"final_copy_uri":{"type":["string","null"],"description":"The path where the completed document can be downloaded"},"transmissions":{"type":"array","items":{"$ref":"#/components/schemas/FaxResponseTransmission"},"description":"Fax Transmissions List"}},"required":["fax_id","title","original_title","metadata","created_at","sender","files_url","transmissions"],"title":"FaxResponse"},"FaxGetResponse":{"type":"object","properties":{"fax":{"$ref":"#/components/schemas/FaxResponse"},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/WarningResponse"},"description":"A list of warnings."}},"required":["fax"],"title":"FaxGetResponse"},"FaxListResponse":{"type":"object","properties":{"faxes":{"type":"array","items":{"$ref":"#/components/schemas/FaxResponse"}},"list_info":{"$ref":"#/components/schemas/ListInfoResponse"}},"required":["faxes","list_info"],"title":"FaxListResponse"},"FaxSendRequest":{"type":"object","properties":{"recipient":{"type":"string","description":"Recipient of the fax \nCan be a phone number in E.164 format or email address"},"sender":{"type":"string","description":"Fax Send From Sender (used only with fax number)"},"files":{"type":"array","items":{"type":"string","format":"binary"},"description":"Use `files[]` to indicate the uploaded file(s) to fax\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"file_urls":{"type":"array","items":{"type":"string"},"description":"Use `file_urls[]` to have Dropbox Fax download the file(s) to fax\n\nThis endpoint requires either **files** or **file_urls[]**, but not both."},"test_mode":{"type":"boolean","default":false,"description":"API Test Mode Setting"},"cover_page_to":{"type":"string","description":"Fax cover page recipient information"},"cover_page_from":{"type":"string","description":"Fax cover page sender information"},"cover_page_message":{"type":"string","description":"Fax Cover Page Message"},"title":{"type":"string","description":"Fax Title"}},"required":["recipient"],"title":"FaxSendRequest"},"FaxLineResponseFaxLine":{"type":"object","properties":{"number":{"type":"string","description":"Number"},"created_at":{"type":"integer","description":"Created at"},"updated_at":{"type":"integer","description":"Updated at"},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/AccountResponse"}}},"title":"FaxLineResponseFaxLine"},"FaxLineResponse":{"type":"object","properties":{"fax_line":{"$ref":"#/components/schemas/FaxLineResponseFaxLine"},"warnings":{"$ref":"#/components/schemas/WarningResponse"}},"required":["fax_line"],"title":"FaxLineResponse"},"FaxLineListResponse":{"type":"object","properties":{"list_info":{"$ref":"#/components/schemas/ListInfoResponse"},"fax_lines":{"type":"array","items":{"$ref":"#/components/schemas/FaxLineResponseFaxLine"}},"warnings":{"$ref":"#/components/schemas/WarningResponse"}},"required":["list_info","fax_lines"],"title":"FaxLineListResponse"},"FaxLineCreateRequestCountry":{"type":"string","enum":["CA","US","UK"],"description":"Country of the area code","title":"FaxLineCreateRequestCountry"},"FaxLineCreateRequest":{"type":"object","properties":{"area_code":{"type":"integer","description":"Area code of the new Fax Line"},"country":{"$ref":"#/components/schemas/FaxLineCreateRequestCountry","description":"Country of the area code"},"city":{"type":"string","description":"City of the area code"},"account_id":{"type":"string","description":"Account ID of the account that will be assigned this new Fax Line"}},"required":["area_code","country"],"title":"FaxLineCreateRequest"},"FaxLineDeleteRequest":{"type":"object","properties":{"number":{"type":"string","description":"The Fax Line number"}},"required":["number"],"title":"FaxLineDeleteRequest"},"faxLine_delete_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"faxLine_delete_Response_200"},"FaxLineAddUserRequest":{"type":"object","properties":{"number":{"type":"string","description":"The Fax Line number"},"account_id":{"type":"string","description":"Account ID"},"email_address":{"type":"string","format":"email","description":"Email address"}},"required":["number"],"title":"FaxLineAddUserRequest"},"FaxLineRemoveUserRequest":{"type":"object","properties":{"number":{"type":"string","description":"The Fax Line number"},"account_id":{"type":"string","description":"Account ID of the user to remove access"},"email_address":{"type":"string","format":"email","description":"Email address of the user to remove access"}},"required":["number"],"title":"FaxLineRemoveUserRequest"},"FaxLineAreaCodesGetParametersCountry":{"type":"string","enum":["CA","US","UK"],"title":"FaxLineAreaCodesGetParametersCountry"},"FaxLineAreaCodesGetParametersState":{"type":"string","enum":["AK","AL","AR","AZ","CA","CO","CT","DC","DE","FL","GA","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MI","MN","MO","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VA","VT","WA","WI","WV","WY"],"title":"FaxLineAreaCodesGetParametersState"},"FaxLineAreaCodesGetParametersProvince":{"type":"string","enum":["AB","BC","MB","NB","NL","NT","NS","NU","ON","PE","QC","SK","YT"],"title":"FaxLineAreaCodesGetParametersProvince"},"FaxLineAreaCodeGetResponse":{"type":"object","properties":{"area_codes":{"type":"array","items":{"type":"integer"}}},"required":["area_codes"],"title":"FaxLineAreaCodeGetResponse"},"EventCallbackSignatureRequestViewedEventEventType":{"type":"string","enum":["signature_request_viewed"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestViewedEventEventType"},"EventCallbackRequestEventMetadata":{"type":"object","properties":{"related_signature_id":{"type":["string","null"],"description":"Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events."},"reported_for_account_id":{"type":["string","null"],"description":"Account ID the event was reported for."},"reported_for_app_id":{"type":["string","null"],"description":"App ID the event was reported for."},"event_message":{"type":["string","null"],"description":"Message about a declined or failed (due to error) signature flow."}},"description":"Specific metadata about the event.","title":"EventCallbackRequestEventMetadata"},"EventCallbackSignatureRequestViewedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestViewedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestViewedEvent"},"EventCallbackSignatureRequestViewed":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestViewedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestViewed"},"EventCallbackSignatureRequestSignedEventEventType":{"type":"string","enum":["signature_request_signed"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestSignedEventEventType"},"EventCallbackSignatureRequestSignedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestSignedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestSignedEvent"},"EventCallbackSignatureRequestSigned":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestSignedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestSigned"},"EventCallbackSignatureRequestSignerRemovedEventEventType":{"type":"string","enum":["signature_request_signer_removed"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestSignerRemovedEventEventType"},"EventCallbackSignatureRequestSignerRemovedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestSignerRemovedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestSignerRemovedEvent"},"EventCallbackSignatureRequestSignerRemoved":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestSignerRemovedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestSignerRemoved"},"EventCallbackSignatureRequestDownloadableEventEventType":{"type":"string","enum":["signature_request_downloadable"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestDownloadableEventEventType"},"EventCallbackSignatureRequestDownloadableEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestDownloadableEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestDownloadableEvent"},"EventCallbackSignatureRequestDownloadable":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestDownloadableEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestDownloadable"},"EventCallbackSignatureRequestSentEventEventType":{"type":"string","enum":["signature_request_sent"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestSentEventEventType"},"EventCallbackSignatureRequestSentEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestSentEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestSentEvent"},"EventCallbackSignatureRequestSent":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestSentEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestSent"},"EventCallbackSignatureRequestAllSignedEventEventType":{"type":"string","enum":["signature_request_all_signed"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestAllSignedEventEventType"},"EventCallbackSignatureRequestAllSignedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestAllSignedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestAllSignedEvent"},"EventCallbackSignatureRequestAllSigned":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestAllSignedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestAllSigned"},"EventCallbackSignatureRequestInvalidEventEventType":{"type":"string","enum":["signature_request_invalid"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestInvalidEventEventType"},"EventCallbackSignatureRequestInvalidEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestInvalidEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestInvalidEvent"},"EventCallbackSignatureRequestInvalid":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestInvalidEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestInvalid"},"EventCallbackSignatureRequestEmailBounceEventEventType":{"type":"string","enum":["signature_request_email_bounce"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestEmailBounceEventEventType"},"EventCallbackSignatureRequestEmailBounceEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestEmailBounceEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestEmailBounceEvent"},"EventCallbackSignatureRequestEmailBounce":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestEmailBounceEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestEmailBounce"},"EventCallbackSignatureRequestRemindEventEventType":{"type":"string","enum":["signature_request_remind"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestRemindEventEventType"},"EventCallbackSignatureRequestRemindEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestRemindEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestRemindEvent"},"EventCallbackSignatureRequestRemind":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestRemindEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestRemind"},"EventCallbackSignatureRequestIncompleteQesEventEventType":{"type":"string","enum":["signature_request_incomplete_qes"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestIncompleteQesEventEventType"},"EventCallbackSignatureRequestIncompleteQesEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestIncompleteQesEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestIncompleteQesEvent"},"EventCallbackSignatureRequestIncompleteQes":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestIncompleteQesEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestIncompleteQes"},"EventCallbackSignatureRequestDestroyedEventEventType":{"type":"string","enum":["signature_request_destroyed"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestDestroyedEventEventType"},"EventCallbackSignatureRequestDestroyedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestDestroyedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestDestroyedEvent"},"EventCallbackSignatureRequestDestroyed":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestDestroyedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestDestroyed"},"EventCallbackSignatureRequestCanceledEventEventType":{"type":"string","enum":["signature_request_canceled"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestCanceledEventEventType"},"EventCallbackSignatureRequestCanceledEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestCanceledEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestCanceledEvent"},"EventCallbackSignatureRequestCanceled":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestCanceledEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestCanceled"},"EventCallbackSignatureRequestDeclinedEventEventType":{"type":"string","enum":["signature_request_declined"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestDeclinedEventEventType"},"EventCallbackSignatureRequestDeclinedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestDeclinedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestDeclinedEvent"},"EventCallbackSignatureRequestDeclined":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestDeclinedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestDeclined"},"EventCallbackSignatureRequestExpiredEventEventType":{"type":"string","enum":["signature_request_expired"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestExpiredEventEventType"},"EventCallbackSignatureRequestExpiredEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestExpiredEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestExpiredEvent"},"EventCallbackSignatureRequestExpired":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestExpiredEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestExpired"},"EventCallbackSignatureRequestReassignedEventEventType":{"type":"string","enum":["signature_request_reassigned"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestReassignedEventEventType"},"EventCallbackSignatureRequestReassignedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestReassignedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestReassignedEvent"},"EventCallbackSignatureRequestReassigned":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestReassignedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestReassigned"},"EventCallbackSignatureRequestPreparedEventEventType":{"type":"string","enum":["signature_request_prepared"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignatureRequestPreparedEventEventType"},"EventCallbackSignatureRequestPreparedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignatureRequestPreparedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignatureRequestPreparedEvent"},"EventCallbackSignatureRequestPrepared":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignatureRequestPreparedEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignatureRequestPrepared"},"EventCallbackAccountConfirmedEventEventType":{"type":"string","enum":["account_confirmed"],"description":"Type of callback event that was triggered.","title":"EventCallbackAccountConfirmedEventEventType"},"EventCallbackAccountConfirmedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackAccountConfirmedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackAccountConfirmedEvent"},"EventCallbackAccountConfirmed":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackAccountConfirmedEvent"},"account":{"$ref":"#/components/schemas/AccountResponse"}},"required":["event"],"title":"EventCallbackAccountConfirmed"},"EventCallbackUnknownErrorEventEventType":{"type":"string","enum":["unknown_error"],"description":"Type of callback event that was triggered.","title":"EventCallbackUnknownErrorEventEventType"},"EventCallbackUnknownErrorEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackUnknownErrorEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackUnknownErrorEvent"},"EventCallbackUnknownError":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackUnknownErrorEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackUnknownError"},"EventCallbackFileErrorEventEventType":{"type":"string","enum":["file_error"],"description":"Type of callback event that was triggered.","title":"EventCallbackFileErrorEventEventType"},"EventCallbackFileErrorEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackFileErrorEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackFileErrorEvent"},"EventCallbackFileError":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackFileErrorEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackFileError"},"EventCallbackTemplateCreatedEventEventType":{"type":"string","enum":["template_created"],"description":"Type of callback event that was triggered.","title":"EventCallbackTemplateCreatedEventEventType"},"EventCallbackTemplateCreatedEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackTemplateCreatedEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackTemplateCreatedEvent"},"EventCallbackTemplateCreated":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackTemplateCreatedEvent"},"template":{"$ref":"#/components/schemas/TemplateResponse"}},"required":["event"],"title":"EventCallbackTemplateCreated"},"EventCallbackTemplateErrorEventEventType":{"type":"string","enum":["template_error"],"description":"Type of callback event that was triggered.","title":"EventCallbackTemplateErrorEventEventType"},"EventCallbackTemplateErrorEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackTemplateErrorEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackTemplateErrorEvent"},"EventCallbackTemplateError":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackTemplateErrorEvent"},"template":{"$ref":"#/components/schemas/TemplateResponse"}},"required":["event"],"title":"EventCallbackTemplateError"},"EventCallbackSignUrlInvalidEventEventType":{"type":"string","enum":["sign_url_invalid"],"description":"Type of callback event that was triggered.","title":"EventCallbackSignUrlInvalidEventEventType"},"EventCallbackSignUrlInvalidEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackSignUrlInvalidEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackSignUrlInvalidEvent"},"EventCallbackSignUrlInvalid":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackSignUrlInvalidEvent"},"signature_request":{"$ref":"#/components/schemas/SignatureRequestResponse"}},"required":["event"],"title":"EventCallbackSignUrlInvalid"},"EventCallbackCallbackTestEventEventType":{"type":"string","enum":["callback_test"],"description":"Type of callback event that was triggered.","title":"EventCallbackCallbackTestEventEventType"},"EventCallbackCallbackTestEvent":{"type":"object","properties":{"event_time":{"type":"string","description":"Time the event was created (using Unix time)."},"event_type":{"$ref":"#/components/schemas/EventCallbackCallbackTestEventEventType","description":"Type of callback event that was triggered."},"event_hash":{"type":"string","description":"Generated hash used to verify source of event data."},"event_metadata":{"$ref":"#/components/schemas/EventCallbackRequestEventMetadata"}},"required":["event_time","event_type","event_hash"],"description":"Basic information about the event that occurred.","title":"EventCallbackCallbackTestEvent"},"EventCallbackCallbackTest":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/EventCallbackCallbackTestEvent"}},"required":["event"],"title":"EventCallbackCallbackTest"},"EventCallbackPayload":{"oneOf":[{"$ref":"#/components/schemas/EventCallbackSignatureRequestViewed"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestSigned"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestSignerRemoved"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestDownloadable"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestSent"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestAllSigned"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestInvalid"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestEmailBounce"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestRemind"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestIncompleteQes"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestDestroyed"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestCanceled"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestDeclined"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestExpired"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestReassigned"},{"$ref":"#/components/schemas/EventCallbackSignatureRequestPrepared"},{"$ref":"#/components/schemas/EventCallbackAccountConfirmed"},{"$ref":"#/components/schemas/EventCallbackUnknownError"},{"$ref":"#/components/schemas/EventCallbackFileError"},{"$ref":"#/components/schemas/EventCallbackTemplateCreated"},{"$ref":"#/components/schemas/EventCallbackTemplateError"},{"$ref":"#/components/schemas/EventCallbackSignUrlInvalid"},{"$ref":"#/components/schemas/EventCallbackCallbackTest"}],"description":"JSON payload delivered for a webhook event. The concrete shape is selected by `event.event_type`.","title":"EventCallbackPayload"}},"securitySchemes":{"Basic":{"type":"http","scheme":"basic","description":"Your API key can be used to make calls to the Dropbox Sign API. See [Authentication](/api/reference/authentication) for more information.\n✅ Supported by Try it console (calls sent in `test_mode` only).            \n"},"Bearer":{"type":"http","scheme":"bearer","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.\n  ❌ **Not supported** by Try it console.\n"}}}}