Remove all merge fields on the template by passing an empty array `[]`. | [optional]
-**PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
**Note**: This parameter overwrites `show_preview=true` (if set). | [optional] [default to false]
+**PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
**NOTE:** This parameter overwrites `show_preview=true` (if set). | [optional] [default to false]
**ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience. | [optional] [default to false]
**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]
**TestMode** | **bool** | Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`. | [optional] [default to false]
diff --git a/docs/SignatureRequestApi.md b/docs/SignatureRequestApi.md
index 8ca9434..60f6e1b 100644
--- a/docs/SignatureRequestApi.md
+++ b/docs/SignatureRequestApi.md
@@ -9,10 +9,6 @@ All URIs are relative to *https://api.hellosign.com/v3*
| [**SignatureRequestCancel**](SignatureRequestApi.md#signaturerequestcancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request |
| [**SignatureRequestCreateEmbedded**](SignatureRequestApi.md#signaturerequestcreateembedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request |
| [**SignatureRequestCreateEmbeddedWithTemplate**](SignatureRequestApi.md#signaturerequestcreateembeddedwithtemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template |
-| [**SignatureRequestEdit**](SignatureRequestApi.md#signaturerequestedit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request |
-| [**SignatureRequestEditEmbedded**](SignatureRequestApi.md#signaturerequesteditembedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request |
-| [**SignatureRequestEditEmbeddedWithTemplate**](SignatureRequestApi.md#signaturerequesteditembeddedwithtemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template |
-| [**SignatureRequestEditWithTemplate**](SignatureRequestApi.md#signaturerequesteditwithtemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template |
| [**SignatureRequestFiles**](SignatureRequestApi.md#signaturerequestfiles) | **GET** /signature_request/files/{signature_request_id} | Download Files |
| [**SignatureRequestFilesAsDataUri**](SignatureRequestApi.md#signaturerequestfilesasdatauri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri |
| [**SignatureRequestFilesAsFileUrl**](SignatureRequestApi.md#signaturerequestfilesasfileurl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url |
@@ -31,7 +27,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
Embedded Bulk Send with Template
-Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
### Example
```csharp
@@ -174,7 +170,7 @@ catch (ApiException e)
Bulk Send with Template
-Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
### Example
```csharp
@@ -316,7 +312,7 @@ catch (ApiException e)
Cancel Incomplete Signature Request
-Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
### Example
```csharp
@@ -408,7 +404,7 @@ void (empty response body)
Create Embedded Signature Request
-Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+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.
### Example
```csharp
@@ -543,7 +539,7 @@ catch (ApiException e)
Create Embedded Signature Request with Template
-Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+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.
### Example
```csharp
@@ -645,551 +641,6 @@ catch (ApiException e)
- **Accept**: application/json
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
-| **4XX** | failed_operation | - |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-
-# **SignatureRequestEdit**
-> SignatureRequestGetResponse SignatureRequestEdit (string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest)
-
-Edit Signature Request
-
-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. **NOTE:** Edit and resend will not deduct your signature request quota.
-
-### Example
-```csharp
-using System;
-using System.Collections.Generic;
-using System.IO;
-using Dropbox.Sign.Api;
-using Dropbox.Sign.Client;
-using Dropbox.Sign.Model;
-
-public class Example
-{
- public static void Main()
- {
- var config = new Configuration();
- // Configure HTTP basic authorization: api_key
- config.Username = "YOUR_API_KEY";
-
- // or, configure Bearer (JWT) authorization: oauth2
- // config.AccessToken = "YOUR_BEARER_TOKEN";
-
- var signatureRequestApi = new SignatureRequestApi(config);
-
- var signer1 = new SubSignatureRequestSigner(
- emailAddress: "jack@example.com",
- name: "Jack",
- order: 0
- );
-
- var signer2 = new SubSignatureRequestSigner(
- emailAddress: "jill@example.com",
- name: "Jill",
- order: 1
- );
-
- var signingOptions = new SubSigningOptions(
- draw: true,
- type: true,
- upload: true,
- phone: true,
- defaultType: SubSigningOptions.DefaultTypeEnum.Draw
- );
-
- var subFieldOptions = new SubFieldOptions(
- dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY
- );
-
- var metadata = new Dictionary()
- {
- ["custom_id"] = 1234,
- ["custom_text"] = "NDA #9"
- };
-
- var files = new List {
- new FileStream(
- "./example_signature_request.pdf",
- FileMode.Open,
- FileAccess.Read,
- FileShare.Read
- )
- };
-
- var data = new SignatureRequestEditRequest(
- title: "NDA with Acme Co.",
- subject: "The NDA we talked about",
- message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
- signers: new List(){signer1, signer2},
- ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"},
- files: files,
- metadata: metadata,
- signingOptions: signingOptions,
- fieldOptions: subFieldOptions,
- testMode: true
- );
-
- var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";
-
- try
- {
- var result = signatureRequestApi.SignatureRequestEdit(signatureRequestId, data);
- Console.WriteLine(result);
- }
- catch (ApiException e)
- {
- Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
- Console.WriteLine("Status Code: " + e.ErrorCode);
- Console.WriteLine(e.StackTrace);
- }
- }
-}
-
-```
-
-#### Using the SignatureRequestEditWithHttpInfo variant
-This returns an ApiResponse object which contains the response data, status code and headers.
-
-```csharp
-try
-{
- // Edit Signature Request
- ApiResponse response = apiInstance.SignatureRequestEditWithHttpInfo(signatureRequestId, signatureRequestEditRequest);
- Debug.Write("Status Code: " + response.StatusCode);
- Debug.Write("Response Headers: " + response.Headers);
- Debug.Write("Response Body: " + response.Data);
-}
-catch (ApiException e)
-{
- Debug.Print("Exception when calling SignatureRequestApi.SignatureRequestEditWithHttpInfo: " + e.Message);
- Debug.Print("Status Code: " + e.ErrorCode);
- Debug.Print(e.StackTrace);
-}
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-|------|------|-------------|-------|
-| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | |
-| **signatureRequestEditRequest** | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md) | | |
-
-### Return type
-
-[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
-| **4XX** | failed_operation | - |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-
-# **SignatureRequestEditEmbedded**
-> SignatureRequestGetResponse SignatureRequestEditEmbedded (string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest)
-
-Edit Embedded Signature Request
-
-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.
-
-### Example
-```csharp
-using System;
-using System.Collections.Generic;
-using System.IO;
-using Dropbox.Sign.Api;
-using Dropbox.Sign.Client;
-using Dropbox.Sign.Model;
-
-public class Example
-{
- public static void Main()
- {
- var config = new Configuration();
- // Configure HTTP basic authorization: api_key
- config.Username = "YOUR_API_KEY";
-
- // or, configure Bearer (JWT) authorization: oauth2
- // config.AccessToken = "YOUR_BEARER_TOKEN";
-
- var signatureRequestApi = new SignatureRequestApi(config);
-
- var signer1 = new SubSignatureRequestSigner(
- emailAddress: "jack@example.com",
- name: "Jack",
- order: 0
- );
-
- var signer2 = new SubSignatureRequestSigner(
- emailAddress: "jill@example.com",
- name: "Jill",
- order: 1
- );
-
- var signingOptions = new SubSigningOptions(
- draw: true,
- type: true,
- upload: true,
- phone: true,
- defaultType: SubSigningOptions.DefaultTypeEnum.Draw
- );
-
- var files = new List {
- new FileStream(
- "./example_signature_request.pdf",
- FileMode.Open,
- FileAccess.Read,
- FileShare.Read
- )
- };
-
- var data = new SignatureRequestEditEmbeddedRequest(
- clientId: "ec64a202072370a737edf4a0eb7f4437",
- title: "NDA with Acme Co.",
- subject: "The NDA we talked about",
- message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.",
- signers: new List(){signer1, signer2},
- ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"},
- files: files,
- signingOptions: signingOptions,
- testMode: true
- );
-
- var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";
-
- try
- {
- var result = signatureRequestApi.SignatureRequestEditEmbedded(
- signatureRequestId,
- data
- );
- Console.WriteLine(result);
- }
- catch (ApiException e)
- {
- Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
- Console.WriteLine("Status Code: " + e.ErrorCode);
- Console.WriteLine(e.StackTrace);
- }
- }
-}
-
-```
-
-#### Using the SignatureRequestEditEmbeddedWithHttpInfo variant
-This returns an ApiResponse object which contains the response data, status code and headers.
-
-```csharp
-try
-{
- // Edit Embedded Signature Request
- ApiResponse response = apiInstance.SignatureRequestEditEmbeddedWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedRequest);
- Debug.Write("Status Code: " + response.StatusCode);
- Debug.Write("Response Headers: " + response.Headers);
- Debug.Write("Response Body: " + response.Data);
-}
-catch (ApiException e)
-{
- Debug.Print("Exception when calling SignatureRequestApi.SignatureRequestEditEmbeddedWithHttpInfo: " + e.Message);
- Debug.Print("Status Code: " + e.ErrorCode);
- Debug.Print(e.StackTrace);
-}
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-|------|------|-------------|-------|
-| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | |
-| **signatureRequestEditEmbeddedRequest** | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md) | | |
-
-### Return type
-
-[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
-| **4XX** | failed_operation | - |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-
-# **SignatureRequestEditEmbeddedWithTemplate**
-> SignatureRequestGetResponse SignatureRequestEditEmbeddedWithTemplate (string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest)
-
-Edit Embedded Signature Request with Template
-
-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.
-
-### Example
-```csharp
-using System;
-using System.Collections.Generic;
-using Dropbox.Sign.Api;
-using Dropbox.Sign.Client;
-using Dropbox.Sign.Model;
-
-public class Example
-{
- public static void Main()
- {
- var config = new Configuration();
- // Configure HTTP basic authorization: api_key
- config.Username = "YOUR_API_KEY";
-
- // or, configure Bearer (JWT) authorization: oauth2
- // config.AccessToken = "YOUR_BEARER_TOKEN";
-
- var signatureRequestApi = new SignatureRequestApi(config);
-
- var signer1 = new SubSignatureRequestTemplateSigner(
- role: "Client",
- name: "George"
- );
-
- var subSigningOptions = new SubSigningOptions(
- draw: true,
- type: true,
- upload: true,
- phone: false,
- defaultType: SubSigningOptions.DefaultTypeEnum.Draw
- );
-
- var data = new SignatureRequestEditEmbeddedWithTemplateRequest(
- clientId: "ec64a202072370a737edf4a0eb7f4437",
- templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"},
- subject: "Purchase Order",
- message: "Glad we could come to an agreement.",
- signers: new List(){signer1},
- signingOptions: subSigningOptions,
- testMode: true
- );
-
- var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";
-
- try
- {
- var result = signatureRequestApi.SignatureRequestEditEmbeddedWithTemplate(
- signatureRequestId,
- data
- );
- Console.WriteLine(result);
- }
- catch (ApiException e)
- {
- Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
- Console.WriteLine("Status Code: " + e.ErrorCode);
- Console.WriteLine(e.StackTrace);
- }
- }
-}
-
-```
-
-#### Using the SignatureRequestEditEmbeddedWithTemplateWithHttpInfo variant
-This returns an ApiResponse object which contains the response data, status code and headers.
-
-```csharp
-try
-{
- // Edit Embedded Signature Request with Template
- ApiResponse response = apiInstance.SignatureRequestEditEmbeddedWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest);
- Debug.Write("Status Code: " + response.StatusCode);
- Debug.Write("Response Headers: " + response.Headers);
- Debug.Write("Response Body: " + response.Data);
-}
-catch (ApiException e)
-{
- Debug.Print("Exception when calling SignatureRequestApi.SignatureRequestEditEmbeddedWithTemplateWithHttpInfo: " + e.Message);
- Debug.Print("Status Code: " + e.ErrorCode);
- Debug.Print(e.StackTrace);
-}
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-|------|------|-------------|-------|
-| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | |
-| **signatureRequestEditEmbeddedWithTemplateRequest** | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md) | | |
-
-### Return type
-
-[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, multipart/form-data
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
-| **4XX** | failed_operation | - |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-
-# **SignatureRequestEditWithTemplate**
-> SignatureRequestGetResponse SignatureRequestEditWithTemplate (string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest)
-
-Edit Signature Request With Template
-
-Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
-
-### Example
-```csharp
-using System;
-using System.Collections.Generic;
-using Dropbox.Sign.Api;
-using Dropbox.Sign.Client;
-using Dropbox.Sign.Model;
-
-public class Example
-{
- public static void Main()
- {
- var config = new Configuration();
- // Configure HTTP basic authorization: api_key
- config.Username = "YOUR_API_KEY";
-
- // or, configure Bearer (JWT) authorization: oauth2
- // config.AccessToken = "YOUR_BEARER_TOKEN";
-
- var signatureRequestApi = new SignatureRequestApi(config);
-
- var signer1 = new SubSignatureRequestTemplateSigner(
- role: "Client",
- emailAddress: "george@example.com",
- name: "George"
- );
-
- var cc1 = new SubCC(
- role: "Accounting",
- emailAddress: "accouting@emaple.com"
- );
-
- var customField1 = new SubCustomField(
- name: "Cost",
- value: "$20,000",
- editor: "Client",
- required: true
- );
-
- var signingOptions = new SubSigningOptions(
- draw: true,
- type: true,
- upload: true,
- phone: false,
- defaultType: SubSigningOptions.DefaultTypeEnum.Draw
- );
-
- var data = new SignatureRequestEditWithTemplateRequest(
- templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"},
- subject: "Purchase Order",
- message: "Glad we could come to an agreement.",
- signers: new List(){signer1},
- ccs: new List(){cc1},
- customFields: new List(){customField1},
- signingOptions: signingOptions,
- testMode: true
- );
-
- var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f";
-
- try
- {
- var result = signatureRequestApi.SignatureRequestEditWithTemplate(signatureRequestId, data);
- Console.WriteLine(result);
- }
- catch (ApiException e)
- {
- Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message);
- Console.WriteLine("Status Code: " + e.ErrorCode);
- Console.WriteLine(e.StackTrace);
- }
- }
-}
-
-```
-
-#### Using the SignatureRequestEditWithTemplateWithHttpInfo variant
-This returns an ApiResponse object which contains the response data, status code and headers.
-
-```csharp
-try
-{
- // Edit Signature Request With Template
- ApiResponse response = apiInstance.SignatureRequestEditWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditWithTemplateRequest);
- Debug.Write("Status Code: " + response.StatusCode);
- Debug.Write("Response Headers: " + response.Headers);
- Debug.Write("Response Body: " + response.Data);
-}
-catch (ApiException e)
-{
- Debug.Print("Exception when calling SignatureRequestApi.SignatureRequestEditWithTemplateWithHttpInfo: " + e.Message);
- Debug.Print("Status Code: " + e.ErrorCode);
- Debug.Print(e.StackTrace);
-}
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-|------|------|-------------|-------|
-| **signatureRequestId** | **string** | The id of the SignatureRequest to edit. | |
-| **signatureRequestEditWithTemplateRequest** | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md) | | |
-
-### Return type
-
-[**SignatureRequestGetResponse**](SignatureRequestGetResponse.md)
-
-### Authorization
-
-[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: application/json, multipart/form-data
- - **Accept**: application/json
-
-
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
@@ -1783,7 +1234,7 @@ catch (ApiException e)
Send Request Reminder
-Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
+Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
### Example
```csharp
@@ -2250,7 +1701,7 @@ catch (ApiException e)
Update Signature Request
-Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
### Example
```csharp
diff --git a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md
index 390b05f..7feccc8 100644
--- a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md
+++ b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. |
**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. |
-**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional]
+**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional]
**SignerList** | [**List<SubBulkSignerList>**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional]
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional]
diff --git a/docs/SignatureRequestBulkSendWithTemplateRequest.md b/docs/SignatureRequestBulkSendWithTemplateRequest.md
index 25a6b8e..8eb63a7 100644
--- a/docs/SignatureRequestBulkSendWithTemplateRequest.md
+++ b/docs/SignatureRequestBulkSendWithTemplateRequest.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. |
-**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional]
+**SignerFile** | **System.IO.Stream** | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | [optional]
**SignerList** | [**List<SubBulkSignerList>**](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | [optional]
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional]
diff --git a/docs/SignatureRequestCreateEmbeddedRequest.md b/docs/SignatureRequestCreateEmbeddedRequest.md
index c352757..20d996c 100644
--- a/docs/SignatureRequestCreateEmbeddedRequest.md
+++ b/docs/SignatureRequestCreateEmbeddedRequest.md
@@ -10,15 +10,15 @@ Name | Type | Description | Notes
**Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
**GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan. | [optional] [default to false]
+**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**NOTE:** Only available for Premium plan. | [optional] [default to false]
**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional]
**CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional]
**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional]
**FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional]
**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | 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`. | [optional]
**FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional]
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
-**HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.
**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]
+**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
+**HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.
**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]
**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
**TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
**UseTextTags** | **bool** | 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`. | [optional] [default to false]
-**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
+**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
**ExpiresAt** | **int?** | 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. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md
index 6c88f25..20a3531 100644
--- a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md
+++ b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional]
**TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
-**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
+**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SignatureRequestEditEmbeddedRequest.md b/docs/SignatureRequestEditEmbeddedRequest.md
deleted file mode 100644
index fda25d6..0000000
--- a/docs/SignatureRequestEditEmbeddedRequest.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# Dropbox.Sign.Model.SignatureRequestEditEmbeddedRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. |
-**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
-**GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
-**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan. | [optional] [default to false]
-**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional]
-**CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional]
-**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional]
-**FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional]
-**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | 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`. | [optional]
-**FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional]
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
-**HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.
**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]
-**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
-**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
-**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]
-**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional]
-**TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
-**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
-**UseTextTags** | **bool** | 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`. | [optional] [default to false]
-**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
-**ExpiresAt** | **int?** | 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. | [optional]
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
diff --git a/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md b/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md
deleted file mode 100644
index babd85a..0000000
--- a/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# Dropbox.Sign.Model.SignatureRequestEditEmbeddedWithTemplateRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. |
-**ClientId** | **string** | Client id of the app you're using to create this embedded signature request. Used for security purposes. |
-**Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. |
-**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional]
-**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional]
-**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
-**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
-**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]
-**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional]
-**TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
-**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
-**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
diff --git a/docs/SignatureRequestEditRequest.md b/docs/SignatureRequestEditRequest.md
deleted file mode 100644
index ef99b90..0000000
--- a/docs/SignatureRequestEditRequest.md
+++ /dev/null
@@ -1,35 +0,0 @@
-# Dropbox.Sign.Model.SignatureRequestEditRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
-**GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
-**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher. | [optional] [default to false]
-**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional]
-**CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional]
-**ClientId** | **string** | 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. | [optional]
-**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional]
-**FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional]
-**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | 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`. | [optional]
-**FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional]
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
-**HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.
**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]
-**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
-**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
-**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
-**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
-**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]
-**SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional]
-**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional]
-**TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
-**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
-**UseTextTags** | **bool** | 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`. | [optional] [default to false]
-**ExpiresAt** | **int?** | 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. | [optional]
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
diff --git a/docs/SignatureRequestEditWithTemplateRequest.md b/docs/SignatureRequestEditWithTemplateRequest.md
deleted file mode 100644
index 70e53b8..0000000
--- a/docs/SignatureRequestEditWithTemplateRequest.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# Dropbox.Sign.Model.SignatureRequestEditWithTemplateRequest
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. |
-**Signers** | [**List<SubSignatureRequestTemplateSigner>**](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. |
-**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional]
-**ClientId** | **string** | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | [optional]
-**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional]
-**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
-**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
-**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
-**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
-**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]
-**SigningRedirectUrl** | **string** | The URL you want signers redirected to after they successfully sign. | [optional]
-**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional]
-**TestMode** | **bool** | Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
-**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
-
diff --git a/docs/SignatureRequestSendRequest.md b/docs/SignatureRequestSendRequest.md
index 7828aba..545f976 100644
--- a/docs/SignatureRequestSendRequest.md
+++ b/docs/SignatureRequestSendRequest.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
**GroupedSigners** | [**List<SubSignatureRequestGroupedSigners>**](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.
This endpoint requires either **signers** or **grouped_signers**, but not both. | [optional]
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher. | [optional] [default to false]
+**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]
**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional]
**CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional]
**ClientId** | **string** | 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. | [optional]
@@ -17,10 +17,10 @@ Name | Type | Description | Notes
**FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional]
**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | 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`. | [optional]
**FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional]
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
-**HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.
**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]
-**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
-**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
+**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
+**HideTextTags** | **bool** | Enables automatic Text Tag removal when set to true.
**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | [optional] [default to false]
+**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
+**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]
diff --git a/docs/SignatureRequestSendWithTemplateRequest.md b/docs/SignatureRequestSendWithTemplateRequest.md
index 1f9dd83..e77a9a1 100644
--- a/docs/SignatureRequestSendWithTemplateRequest.md
+++ b/docs/SignatureRequestSendWithTemplateRequest.md
@@ -12,8 +12,8 @@ Name | Type | Description | Notes
**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional]
**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
-**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
+**IsQualifiedSignature** | **bool** | Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer's identity.<br> **NOTE:** QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
+**IsEid** | **bool** | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [optional] [default to false]
**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
**SigningOptions** | [**SubSigningOptions**](SubSigningOptions.md) | | [optional]
diff --git a/docs/SignatureRequestUpdateRequest.md b/docs/SignatureRequestUpdateRequest.md
index 8e0d141..7aa6991 100644
--- a/docs/SignatureRequestUpdateRequest.md
+++ b/docs/SignatureRequestUpdateRequest.md
@@ -5,8 +5,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**SignatureId** | **string** | The signature ID for the recipient. |
-**EmailAddress** | **string** | The new email address for the recipient.
This will generate a new `signature_id` value.
**NOTE**: Optional if `name` is provided. | [optional]
-**Name** | **string** | The new name for the recipient.
**NOTE**: Optional if `email_address` is provided. | [optional]
+**EmailAddress** | **string** | The new email address for the recipient.
This will generate a new `signature_id` value.
**NOTE:** Optional if `name` is provided. | [optional]
+**Name** | **string** | The new name for the recipient.
**NOTE:** Optional if `email_address` is provided. | [optional]
**ExpiresAt** | **int?** | 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. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubAttachment.md b/docs/SubAttachment.md
index 74b36fa..80d4f5c 100644
--- a/docs/SubAttachment.md
+++ b/docs/SubAttachment.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | The name of attachment. |
-**SignerIndex** | **int** | The signer's index in the `signers` parameter (0-based indexing).
**NOTE**: Only one signer can be assigned per attachment. |
+**SignerIndex** | **int** | The signer's index in the `signers` parameter (0-based indexing).
**NOTE:** Only one signer can be assigned per attachment. |
**Instructions** | **string** | The instructions for uploading the attachment. | [optional]
**Required** | **bool** | Determines if the attachment must be uploaded. | [optional] [default to false]
diff --git a/docs/SubCustomField.md b/docs/SubCustomField.md
index afd45b9..27ee651 100644
--- a/docs/SubCustomField.md
+++ b/docs/SubCustomField.md
@@ -6,7 +6,7 @@ When used together with merge fields, `custom_fields` allows users to add pre-fi
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **string** | 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. |
-**Editor** | **string** | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.
**Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. | [optional]
+**Editor** | **string** | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.
**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. | [optional]
**Required** | **bool** | 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`. | [optional] [default to false]
**Value** | **string** | The string that resolves (aka "pre-fills") to the merge field on the final document(s) used for signing. | [optional]
diff --git a/docs/SubFieldOptions.md b/docs/SubFieldOptions.md
index a9e1551..d0c68db 100644
--- a/docs/SubFieldOptions.md
+++ b/docs/SubFieldOptions.md
@@ -5,7 +5,7 @@ This allows the requester to specify field options for a signature request.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**DateFormat** | **string** | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
**Note**: Only available for Premium and higher. |
+**DateFormat** | **string** | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
**NOTE:** Only available for Premium and higher. |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubFormFieldsPerDocumentBase.md b/docs/SubFormFieldsPerDocumentBase.md
index 552260e..cadb43e 100644
--- a/docs/SubFormFieldsPerDocumentBase.md
+++ b/docs/SubFormFieldsPerDocumentBase.md
@@ -1,5 +1,5 @@
# Dropbox.Sign.Model.SubFormFieldsPerDocumentBase
-The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
+The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
## Properties
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Type** | **string** | |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
diff --git a/docs/SubFormFieldsPerDocumentCheckbox.md b/docs/SubFormFieldsPerDocumentCheckbox.md
index 9ddab0d..2befe92 100644
--- a/docs/SubFormFieldsPerDocumentCheckbox.md
+++ b/docs/SubFormFieldsPerDocumentCheckbox.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
diff --git a/docs/SubFormFieldsPerDocumentCheckboxMerge.md b/docs/SubFormFieldsPerDocumentCheckboxMerge.md
index 2273fb0..61cd723 100644
--- a/docs/SubFormFieldsPerDocumentCheckboxMerge.md
+++ b/docs/SubFormFieldsPerDocumentCheckboxMerge.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
diff --git a/docs/SubFormFieldsPerDocumentDateSigned.md b/docs/SubFormFieldsPerDocumentDateSigned.md
index 3f4d425..3a9f886 100644
--- a/docs/SubFormFieldsPerDocumentDateSigned.md
+++ b/docs/SubFormFieldsPerDocumentDateSigned.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
**Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).
- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional]
**Type** | **string** | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to "date_signed"]
**FontFamily** | **string** | Font family for the field. | [optional]
-**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
+**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubFormFieldsPerDocumentDropdown.md b/docs/SubFormFieldsPerDocumentDropdown.md
index 71502f7..4e40162 100644
--- a/docs/SubFormFieldsPerDocumentDropdown.md
+++ b/docs/SubFormFieldsPerDocumentDropdown.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
**Options** | **List<string>** | Array of string values representing dropdown values. |
**Content** | **string** | Selected value in `options` array. Value must exist in array. | [optional]
**FontFamily** | **string** | Font family for the field. | [optional]
-**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
+**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubFormFieldsPerDocumentHyperlink.md b/docs/SubFormFieldsPerDocumentHyperlink.md
index 0da5f6e..6b3845f 100644
--- a/docs/SubFormFieldsPerDocumentHyperlink.md
+++ b/docs/SubFormFieldsPerDocumentHyperlink.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
**Content** | **string** | Link Text. |
**ContentUrl** | **string** | Link URL. |
**FontFamily** | **string** | Font family for the field. | [optional]
-**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
+**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubFormFieldsPerDocumentInitials.md b/docs/SubFormFieldsPerDocumentInitials.md
index 37c32ef..8047860 100644
--- a/docs/SubFormFieldsPerDocumentInitials.md
+++ b/docs/SubFormFieldsPerDocumentInitials.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
diff --git a/docs/SubFormFieldsPerDocumentRadio.md b/docs/SubFormFieldsPerDocumentRadio.md
index 7c828ab..3340d56 100644
--- a/docs/SubFormFieldsPerDocumentRadio.md
+++ b/docs/SubFormFieldsPerDocumentRadio.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
diff --git a/docs/SubFormFieldsPerDocumentSignature.md b/docs/SubFormFieldsPerDocumentSignature.md
index 380f23c..ed8823d 100644
--- a/docs/SubFormFieldsPerDocumentSignature.md
+++ b/docs/SubFormFieldsPerDocumentSignature.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
diff --git a/docs/SubFormFieldsPerDocumentText.md b/docs/SubFormFieldsPerDocumentText.md
index 8c9b043..b40010e 100644
--- a/docs/SubFormFieldsPerDocumentText.md
+++ b/docs/SubFormFieldsPerDocumentText.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
@@ -20,12 +20,12 @@ Name | Type | Description | Notes
**AutoFillType** | **string** | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | [optional]
**LinkId** | **string** | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | [optional]
**Masked** | **bool** | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | [optional]
-**ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.
**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | [optional]
+**ValidationType** | **string** | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.
**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | [optional]
**ValidationCustomRegex** | **string** | | [optional]
**ValidationCustomRegexFormatLabel** | **string** | | [optional]
**Content** | **string** | Content of a `me_now` text field | [optional]
**FontFamily** | **string** | Font family for the field. | [optional]
-**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
+**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubFormFieldsPerDocumentTextMerge.md b/docs/SubFormFieldsPerDocumentTextMerge.md
index 92525c9..8611416 100644
--- a/docs/SubFormFieldsPerDocumentTextMerge.md
+++ b/docs/SubFormFieldsPerDocumentTextMerge.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**ApiId** | **string** | An identifier for the field that is unique across all documents in the request. |
**Height** | **int** | Size of the field in pixels. |
**Required** | **bool** | Whether this field is required. |
-**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE**: To set the value of the field as the preparer you must set this to `me_now`
**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
+**Signer** | **string** | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
**NOTE:** To set the value of the field as the preparer you must set this to `me_now`
**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. |
**Width** | **int** | Size of the field in pixels. |
**X** | **int** | Location coordinates of the field in pixels. |
**Y** | **int** | Location coordinates of the field in pixels. |
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
**Page** | **int?** | Page in the document where the field should be placed (requires documents be PDF files).
- When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them. | [optional]
**Type** | **string** | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to "text-merge"]
**FontFamily** | **string** | Font family for the field. | [optional]
-**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
+**FontSize** | **int** | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [optional] [default to 12]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubSignatureRequestGroupedSigners.md b/docs/SubSignatureRequestGroupedSigners.md
index 91d63c4..8ae84f7 100644
--- a/docs/SubSignatureRequestGroupedSigners.md
+++ b/docs/SubSignatureRequestGroupedSigners.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Group** | **string** | The name of the group. |
-**Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Signers belonging to this Group.
**NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. |
+**Signers** | [**List<SubSignatureRequestSigner>**](SubSignatureRequestSigner.md) | Signers belonging to this Group.
**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. |
**Order** | **int?** | The order the group is required to sign in. Use this instead of Signer-level `order`. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubSignatureRequestSigner.md b/docs/SubSignatureRequestSigner.md
index ff9f42c..a130657 100644
--- a/docs/SubSignatureRequestSigner.md
+++ b/docs/SubSignatureRequestSigner.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**EmailAddress** | **string** | The email address of the signer. |
**Order** | **int?** | The order the signer is required to sign in. | [optional]
**Pin** | **string** | The 4- to 12-character access code that will secure this signer's signature page. | [optional]
-**SmsPhoneNumber** | **string** | An E.164 formatted phone number.
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**Note**: Not available in test mode and requires a Standard plan or higher. | [optional]
+**SmsPhoneNumber** | **string** | An E.164 formatted phone number.
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**NOTE:** Not available in test mode and requires a Standard plan or higher. | [optional]
**SmsPhoneNumberType** | **string** | Specifies the feature used with the `sms_phone_number`. Default `authentication`.
If `authentication`, signer is sent a verification code via SMS that is required to access the document.
If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubSignatureRequestTemplateSigner.md b/docs/SubSignatureRequestTemplateSigner.md
index 042f8a6..4a30406 100644
--- a/docs/SubSignatureRequestTemplateSigner.md
+++ b/docs/SubSignatureRequestTemplateSigner.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**Name** | **string** | The name of the signer. |
**EmailAddress** | **string** | The email address of the signer. |
**Pin** | **string** | The 4- to 12-character access code that will secure this signer's signature page. | [optional]
-**SmsPhoneNumber** | **string** | An E.164 formatted phone number.
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**Note**: Not available in test mode and requires a Standard plan or higher. | [optional]
+**SmsPhoneNumber** | **string** | An E.164 formatted phone number.
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**NOTE:** Not available in test mode and requires a Standard plan or higher. | [optional]
**SmsPhoneNumberType** | **string** | Specifies the feature used with the `sms_phone_number`. Default `authentication`.
If `authentication`, signer is sent a verification code via SMS that is required to access the document.
If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/SubSigningOptions.md b/docs/SubSigningOptions.md
index 06bf010..c0ec40e 100644
--- a/docs/SubSigningOptions.md
+++ b/docs/SubSigningOptions.md
@@ -1,5 +1,5 @@
# Dropbox.Sign.Model.SubSigningOptions
-This allows the requester to specify the types allowed for creating a signature. **Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
+This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
## Properties
diff --git a/docs/TeamAddMemberRequest.md b/docs/TeamAddMemberRequest.md
index 6aedea2..89478f0 100644
--- a/docs/TeamAddMemberRequest.md
+++ b/docs/TeamAddMemberRequest.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | **string** | `account_id` or `email_address` is required. If both are provided, the account id prevails.
Account id of the user to invite to your Team. | [optional]
**EmailAddress** | **string** | `account_id` or `email_address` is required, If both are provided, the account id prevails.
Email address of the user to invite to your Team. | [optional]
-**Role** | **string** | A role member will take in a new Team.
**Note**: This parameter is used only if `team_id` is provided. | [optional]
+**Role** | **string** | A role member will take in a new Team.
**NOTE:** This parameter is used only if `team_id` is provided. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TeamRemoveMemberRequest.md b/docs/TeamRemoveMemberRequest.md
index 9f0aa91..bc227b9 100644
--- a/docs/TeamRemoveMemberRequest.md
+++ b/docs/TeamRemoveMemberRequest.md
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccountId** | **string** | **account_id** or **email_address** is required. If both are provided, the account id prevails.
Account id to remove from your Team. | [optional]
**EmailAddress** | **string** | **account_id** or **email_address** is required. If both are provided, the account id prevails.
Email address of the Account to remove from your Team. | [optional]
-**NewOwnerEmailAddress** | **string** | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.
**Note**: Only available for Enterprise plans. | [optional]
+**NewOwnerEmailAddress** | **string** | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.
**NOTE:** Only available for Enterprise plans. | [optional]
**NewTeamId** | **string** | Id of the new Team. | [optional]
-**NewRole** | **string** | A new role member will take in a new Team.
**Note**: This parameter is used only if `new_team_id` is provided. | [optional]
+**NewRole** | **string** | A new role member will take in a new Team.
**NOTE:** This parameter is used only if `new_team_id` is provided. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateAddUserRequest.md b/docs/TemplateAddUserRequest.md
index c251e7f..059dc1e 100644
--- a/docs/TemplateAddUserRequest.md
+++ b/docs/TemplateAddUserRequest.md
@@ -4,8 +4,8 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**AccountId** | **string** | The id of the Account to give access to the Template. <b>Note</b> The account id prevails if email address is also provided. | [optional]
-**EmailAddress** | **string** | The email address of the Account to give access to the Template. <b>Note</b> The account id prevails if it is also provided. | [optional]
+**AccountId** | **string** | The id of the Account to give access to the Template. **NOTE:** The account id prevails if email address is also provided. | [optional]
+**EmailAddress** | **string** | The email address of the Account to give access to the Template. **NOTE:** The account id prevails if it is also provided. | [optional]
**SkipNotification** | **bool** | If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. | [optional] [default to false]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateCreateEmbeddedDraftRequest.md b/docs/TemplateCreateEmbeddedDraftRequest.md
index 38768f1..0ce33cb 100644
--- a/docs/TemplateCreateEmbeddedDraftRequest.md
+++ b/docs/TemplateCreateEmbeddedDraftRequest.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
**AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template. | [optional] [default to true]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher. | [optional] [default to false]
+**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]
**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional]
**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional]
**EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional]
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the template subject and message. | [optional] [default to false]
**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | 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`. | [optional]
**FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional]
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
+**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
**MergeFields** | [**List<SubMergeField>**](SubMergeField.md) | Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document. | [optional]
**Message** | **string** | The default template email message. | [optional]
**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
diff --git a/docs/TemplateCreateRequest.md b/docs/TemplateCreateRequest.md
index 5db5320..a0e9860 100644
--- a/docs/TemplateCreateRequest.md
+++ b/docs/TemplateCreateRequest.md
@@ -4,11 +4,11 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` |
+**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` |
**SignerRoles** | [**List<SubTemplateRole>**](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. |
**Files** | **List<System.IO.Stream>** | Use `files[]` to indicate the uploaded file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher. | [optional] [default to false]
+**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]
**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional]
**CcRoles** | **List<string>** | The CC roles that must be assigned when using the template to send a signature request | [optional]
**ClientId** | **string** | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | [optional]
diff --git a/docs/TemplateResponseDocument.md b/docs/TemplateResponseDocument.md
index 12b5c7a..09b0716 100644
--- a/docs/TemplateResponseDocument.md
+++ b/docs/TemplateResponseDocument.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**FieldGroups** | [**List<TemplateResponseDocumentFieldGroup>**](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | [optional]
**FormFields** | [**List<TemplateResponseDocumentFormFieldBase>**](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional]
**CustomFields** | [**List<TemplateResponseDocumentCustomFieldBase>**](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | [optional]
-**StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **Note** only available for certain subscriptions. | [optional]
+**StaticFields** | [**List<TemplateResponseDocumentStaticFieldBase>**](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/TemplateResponseDocumentStaticFieldBase.md b/docs/TemplateResponseDocumentStaticFieldBase.md
index 3404b70..4af0019 100644
--- a/docs/TemplateResponseDocumentStaticFieldBase.md
+++ b/docs/TemplateResponseDocumentStaticFieldBase.md
@@ -1,5 +1,5 @@
# Dropbox.Sign.Model.TemplateResponseDocumentStaticFieldBase
-An array describing static overlay fields. **Note** only available for certain subscriptions.
+An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.
## Properties
diff --git a/docs/UnclaimedDraftApi.md b/docs/UnclaimedDraftApi.md
index f5fe710..458e5d3 100644
--- a/docs/UnclaimedDraftApi.md
+++ b/docs/UnclaimedDraftApi.md
@@ -161,7 +161,7 @@ catch (ApiException e)
Create Embedded Unclaimed Draft
-Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
+Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
### Example
```csharp
@@ -271,7 +271,7 @@ catch (ApiException e)
Create Embedded Unclaimed Draft with Template
-Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
+Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
### Example
```csharp
@@ -384,7 +384,7 @@ catch (ApiException e)
Edit and Resend Unclaimed Draft
-Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
+Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set. **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
### Example
```csharp
diff --git a/docs/UnclaimedDraftCreateEmbeddedRequest.md b/docs/UnclaimedDraftCreateEmbeddedRequest.md
index 17bcd03..0da15d2 100644
--- a/docs/UnclaimedDraftCreateEmbeddedRequest.md
+++ b/docs/UnclaimedDraftCreateEmbeddedRequest.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**FileUrls** | **List<string>** | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
This endpoint requires either **files** or **file_urls[]**, but not both. | [optional]
**AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to true]
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher. | [optional] [default to false]
+**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]
**Attachments** | [**List<SubAttachment>**](SubAttachment.md) | A list describing the attachments | [optional]
**CcEmailAddresses** | **List<string>** | The email addresses that should be CCed. | [optional]
**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | [optional]
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**ForceSubjectMessage** | **bool** | Provide users the ability to review/edit the subject and message. | [optional] [default to false]
**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | 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`. | [optional]
**FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional]
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
+**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
**HideTextTags** | **bool** | 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. | [optional] [default to false]
**HoldRequest** | **bool** | 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`. | [optional] [default to false]
**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]
@@ -38,8 +38,8 @@ Name | Type | Description | Notes
**Type** | **string** | 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. | [optional] [default to TypeEnum.RequestSignature]
**UsePreexistingFields** | **bool** | 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. | [optional] [default to false]
**UseTextTags** | **bool** | 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. | [optional] [default to false]
-**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
-**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
**Note**: This does not correspond to the **expires_at** returned in the response. | [optional]
+**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
+**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
index 930494f..1dc85f6 100644
--- a/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
+++ b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
**RequesterEmailAddress** | **string** | The email address of the user that should be designated as the requester of this draft. |
**TemplateIds** | **List<string>** | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. |
**AllowDecline** | **bool** | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [optional] [default to false]
-**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**Note**: Only available for Premium plan and higher. | [optional] [default to false]
+**AllowReassign** | **bool** | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
**NOTE:** Only available for Premium plan and higher. | [optional] [default to false]
**Ccs** | [**List<SubCC>**](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | [optional]
**CustomFields** | [**List<SubCustomField>**](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | [optional]
**EditorOptions** | [**SubEditorOptions**](SubEditorOptions.md) | | [optional]
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**IsForEmbeddedSigning** | **bool** | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [optional] [default to false]
**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
-**PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.
**Note**: This parameter overwrites `show_preview=1` (if set). | [optional] [default to false]
+**PreviewOnly** | **bool** | This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
- `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience.
**NOTE:** This parameter overwrites `show_preview=1` (if set). | [optional] [default to false]
**RequestingRedirectUrl** | **string** | The URL you want signers redirected to after they successfully request a signature. | [optional]
**ShowPreview** | **bool** | This allows the requester to enable the editor/preview experience.
- `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience. | [optional] [default to false]
**ShowProgressStepper** | **bool** | When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden. | [optional] [default to true]
@@ -32,7 +32,7 @@ Name | Type | Description | Notes
**Subject** | **string** | The subject in the email that will be sent to the signers. | [optional]
**TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
**Title** | **string** | The title you want to assign to the SignatureRequest. | [optional]
-**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
+**PopulateAutoFillFields** | **bool** | Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
**NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature. | [optional] [default to false]
**AllowCcs** | **bool** | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [optional] [default to false]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/docs/UnclaimedDraftCreateRequest.md b/docs/UnclaimedDraftCreateRequest.md
index 758bdfc..71ef91f 100644
--- a/docs/UnclaimedDraftCreateRequest.md
+++ b/docs/UnclaimedDraftCreateRequest.md
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
**FieldOptions** | [**SubFieldOptions**](SubFieldOptions.md) | | [optional]
**FormFieldGroups** | [**List<SubFormFieldGroup>**](SubFormFieldGroup.md) | 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`. | [optional]
**FormFieldRules** | [**List<SubFormFieldRule>**](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | [optional]
-**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
+**FormFieldsPerDocument** | [**List<SubFormFieldsPerDocumentBase>**](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | [optional]
**HideTextTags** | **bool** | 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. | [optional] [default to false]
**Message** | **string** | The custom message in the email that will be sent to the signers. | [optional]
**Metadata** | **Dictionary<string, Object>** | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | [optional]
@@ -27,7 +27,7 @@ Name | Type | Description | Notes
**TestMode** | **bool** | Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`. | [optional] [default to false]
**UsePreexistingFields** | **bool** | 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. | [optional] [default to false]
**UseTextTags** | **bool** | 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. | [optional] [default to false]
-**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
**Note**: This does not correspond to the **expires_at** returned in the response. | [optional]
+**ExpiresAt** | **int?** | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
**NOTE:** This does not correspond to the **expires_at** returned in the response. | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
diff --git a/openapi-config.yaml b/openapi-config.yaml
index e52a5e8..6c07db6 100644
--- a/openapi-config.yaml
+++ b/openapi-config.yaml
@@ -5,7 +5,7 @@ additionalProperties:
packageAuthors: Dropbox Sign API Team
packageCompany: Dropbox Sign API Team
packageDescription: Client library for using the Dropbox Sign API
- packageVersion: 1.4.0
+ packageVersion: 1.4.1
packageTitle: Dropbox Sign .Net SDK
sortModelPropertiesByRequiredFlag: true
optionalEmitDefaultValues: true
diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml
index d77d984..6a2f61a 100644
--- a/openapi-sdk.yaml
+++ b/openapi-sdk.yaml
@@ -1684,7 +1684,7 @@ paths:
description: |-
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- **NOTE**: Only available for Standard plan and higher.
+ **NOTE:** Only available for Standard plan and higher.
operationId: signatureRequestBulkCreateEmbeddedWithTemplate
requestBody:
required: true
@@ -1794,7 +1794,7 @@ paths:
description: |-
Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter.
- **NOTE**: Only available for Standard plan and higher.
+ **NOTE:** Only available for Standard plan and higher.
operationId: signatureRequestBulkSendWithTemplate
requestBody:
required: true
@@ -1910,7 +1910,7 @@ paths:
To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.
- **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+ **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
operationId: signatureRequestCancel
parameters:
-
@@ -2013,7 +2013,7 @@ paths:
tags:
- 'Signature Request'
summary: 'Create Embedded Signature Request'
- description: 'Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
+ description: 'Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
operationId: signatureRequestCreateEmbedded
requestBody:
required: true
@@ -2123,7 +2123,7 @@ paths:
tags:
- 'Signature Request'
summary: 'Create Embedded Signature Request with Template'
- description: 'Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
+ description: 'Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.'
operationId: signatureRequestCreateEmbeddedWithTemplate
requestBody:
required: true
@@ -2226,39 +2226,35 @@ paths:
seo:
title: 'Signature Request with Template | Dropbox Sign for Developers'
description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.'
- '/signature_request/edit/{signature_request_id}':
- put:
+ '/signature_request/files/{signature_request_id}':
+ get:
tags:
- 'Signature Request'
- summary: 'Edit Signature Request'
+ summary: 'Download Files'
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.
+ Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file.
- **NOTE:** Edit and resend will not deduct your signature request quota.
- operationId: signatureRequestEdit
+ If the files are currently being prepared, a status code of `409` will be returned instead.
+ operationId: signatureRequestFiles
parameters:
-
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to edit.'
+ description: 'The id of the SignatureRequest to retrieve.'
required: true
schema:
type: string
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditRequest'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestEditRequestDefaultExample'
- grouped_signers_example:
- $ref: '#/components/examples/SignatureRequestEditRequestGroupedSignersExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditRequest'
+ -
+ name: file_type
+ in: query
+ description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.'
+ schema:
+ type: string
+ default: pdf
+ enum:
+ - pdf
+ - zip
responses:
200:
description: 'successful operation'
@@ -2270,12 +2266,14 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/json:
+ application/pdf:
schema:
- $ref: '#/components/schemas/SignatureRequestGetResponse'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestEditResponseExample'
+ type: string
+ format: binary
+ application/zip:
+ schema:
+ type: string
+ format: binary
4XX:
description: failed_operation
content:
@@ -2295,6 +2293,8 @@ paths:
$ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
+ 410_example:
+ $ref: '#/components/examples/Error410ResponseExample'
429_example:
$ref: '#/components/examples/Error429ResponseExample'
4XX_example:
@@ -2311,78 +2311,65 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestEdit.php
+ $ref: examples/SignatureRequestFiles.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestEdit.cs
+ $ref: examples/SignatureRequestFiles.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestEdit.js
+ $ref: examples/SignatureRequestFiles.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestEdit.ts
+ $ref: examples/SignatureRequestFiles.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestEdit.java
+ $ref: examples/SignatureRequestFiles.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestEdit.rb
+ $ref: examples/SignatureRequestFiles.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestEdit.py
+ $ref: examples/SignatureRequestFiles.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestEdit.sh
+ $ref: examples/SignatureRequestFiles.sh
x-meta:
seo:
- title: 'Edit Signature Request | REST API | Dropbox Sign for Developers'
- description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.'
- x-hideOn: doc
- x-beta: closed
- '/signature_request/edit_embedded/{signature_request_id}':
- put:
+ title: 'Download Files | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here'
+ '/signature_request/files_as_data_uri/{signature_request_id}':
+ get:
tags:
- 'Signature Request'
- summary: '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.'
- operationId: signatureRequestEditEmbedded
+ summary: 'Download Files as Data Uri'
+ description: |-
+ Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).
+
+ If the files are currently being prepared, a status code of `409` will be returned instead.
+ operationId: signatureRequestFilesAsDataUri
parameters:
-
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to edit.'
+ description: 'The id of the SignatureRequest to retrieve.'
required: true
schema:
type: string
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestDefaultExample'
- grouped_signers_example:
- $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSignersExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest'
responses:
200:
description: 'successful operation'
@@ -2396,10 +2383,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SignatureRequestGetResponse'
+ $ref: '#/components/schemas/FileResponseDataUri'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestEditEmbeddedResponseExample'
+ $ref: '#/components/examples/SignatureRequestFilesResponseExample'
4XX:
description: failed_operation
content:
@@ -2419,6 +2406,8 @@ paths:
$ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
+ 410_example:
+ $ref: '#/components/examples/Error410ResponseExample'
429_example:
$ref: '#/components/examples/Error429ResponseExample'
4XX_example:
@@ -2428,82 +2417,79 @@ paths:
api_key: []
-
oauth2:
+ - request_signature
- signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestEditEmbedded.php
+ $ref: examples/SignatureRequestFilesAsDataUri.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestEditEmbedded.cs
+ $ref: examples/SignatureRequestFilesAsDataUri.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestEditEmbedded.js
+ $ref: examples/SignatureRequestFilesAsDataUri.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestEditEmbedded.ts
+ $ref: examples/SignatureRequestFilesAsDataUri.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestEditEmbedded.java
+ $ref: examples/SignatureRequestFilesAsDataUri.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestEditEmbedded.rb
+ $ref: examples/SignatureRequestFilesAsDataUri.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestEditEmbedded.py
+ $ref: examples/SignatureRequestFilesAsDataUri.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestEditEmbedded.sh
+ $ref: examples/SignatureRequestFilesAsDataUri.sh
x-meta:
seo:
- title: 'Edit Embedded Signature Request | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.'
- x-hideOn: doc
- x-beta: closed
- '/signature_request/edit_embedded_with_template/{signature_request_id}':
- put:
+ title: 'Download Files | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here'
+ '/signature_request/files_as_file_url/{signature_request_id}':
+ get:
tags:
- 'Signature Request'
- summary: '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.'
- operationId: signatureRequestEditEmbeddedWithTemplate
+ summary: 'Download Files as File Url'
+ description: |-
+ Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only).
+
+ If the files are currently being prepared, a status code of `409` will be returned instead.
+ operationId: signatureRequestFilesAsFileUrl
parameters:
-
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to edit.'
+ description: 'The id of the SignatureRequest to retrieve.'
required: true
schema:
type: string
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest'
+ -
+ name: force_download
+ in: query
+ description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
+ schema:
+ type: integer
+ default: 1
responses:
200:
description: 'successful operation'
@@ -2517,10 +2503,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SignatureRequestGetResponse'
+ $ref: '#/components/schemas/FileResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponseExample'
+ $ref: '#/components/examples/SignatureRequestFilesResponseExample'
4XX:
description: failed_operation
content:
@@ -2540,6 +2526,8 @@ paths:
$ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
+ 410_example:
+ $ref: '#/components/examples/Error410ResponseExample'
429_example:
$ref: '#/components/examples/Error429ResponseExample'
4XX_example:
@@ -2549,85 +2537,69 @@ paths:
api_key: []
-
oauth2:
+ - request_signature
- signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.php
+ $ref: examples/SignatureRequestFilesAsFileUrl.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.cs
+ $ref: examples/SignatureRequestFilesAsFileUrl.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.js
+ $ref: examples/SignatureRequestFilesAsFileUrl.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.ts
+ $ref: examples/SignatureRequestFilesAsFileUrl.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.java
+ $ref: examples/SignatureRequestFilesAsFileUrl.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.rb
+ $ref: examples/SignatureRequestFilesAsFileUrl.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.py
+ $ref: examples/SignatureRequestFilesAsFileUrl.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestEditEmbeddedWithTemplate.sh
+ $ref: examples/SignatureRequestFilesAsFileUrl.sh
x-meta:
seo:
- title: 'Signature Request with Template | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.'
- x-hideOn: doc
- x-beta: closed
- '/signature_request/edit_with_template/{signature_request_id}':
- put:
+ title: 'Download Files | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here'
+ '/signature_request/{signature_request_id}':
+ get:
tags:
- 'Signature Request'
- summary: 'Edit Signature Request With Template'
- description: |-
- Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter.
-
- **NOTE:** Edit and resend will not deduct your signature request quota.
- operationId: signatureRequestEditWithTemplate
+ summary: 'Get Signature Request'
+ description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.'
+ operationId: signatureRequestGet
parameters:
-
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to edit.'
+ description: 'The id of the SignatureRequest to retrieve.'
required: true
schema:
type: string
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestEditWithTemplateRequestDefaultExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest'
responses:
200:
description: 'successful operation'
@@ -2644,7 +2616,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestEditWithTemplateResponseExample'
+ $ref: '#/components/examples/SignatureRequestGetResponseExample'
4XX:
description: failed_operation
content:
@@ -2662,10 +2634,8 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
+ 410_example:
+ $ref: '#/components/examples/Error410ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -2680,77 +2650,84 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestEditWithTemplate.php
+ $ref: examples/SignatureRequestGet.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestEditWithTemplate.cs
+ $ref: examples/SignatureRequestGet.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestEditWithTemplate.js
+ $ref: examples/SignatureRequestGet.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestEditWithTemplate.ts
+ $ref: examples/SignatureRequestGet.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestEditWithTemplate.java
+ $ref: examples/SignatureRequestGet.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestEditWithTemplate.rb
+ $ref: examples/SignatureRequestGet.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestEditWithTemplate.py
+ $ref: examples/SignatureRequestGet.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestEditWithTemplate.sh
+ $ref: examples/SignatureRequestGet.sh
x-meta:
seo:
- title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers'
- description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.'
- x-hideOn: doc
- x-beta: closed
- '/signature_request/files/{signature_request_id}':
+ title: 'Get Signature Request | Documentation | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.'
+ /signature_request/list:
get:
tags:
- 'Signature Request'
- summary: 'Download Files'
+ summary: 'List Signature Requests'
description: |-
- Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file.
+ 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.
- If the files are currently being prepared, a status code of `409` will be returned instead.
- operationId: signatureRequestFiles
+ Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
+ operationId: signatureRequestList
parameters:
-
- name: signature_request_id
- in: path
- description: 'The id of the SignatureRequest to retrieve.'
- required: true
+ name: account_id
+ in: query
+ description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.'
schema:
type: string
- example: fa5c8a0b0f492d768749333ad6fcc214c111e967
-
- name: file_type
+ name: page
in: query
- description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.'
+ description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.'
+ schema:
+ type: integer
+ default: 1
+ example: 1
+ -
+ name: page_size
+ in: query
+ description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
+ schema:
+ type: integer
+ default: 20
+ -
+ name: query
+ in: query
+ description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.'
schema:
type: string
- default: pdf
- enum:
- - pdf
- - zip
responses:
200:
description: 'successful operation'
@@ -2762,14 +2739,12 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/pdf:
- schema:
- type: string
- format: binary
- application/zip:
+ application/json:
schema:
- type: string
- format: binary
+ $ref: '#/components/schemas/SignatureRequestListResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/SignatureRequestListResponseExample'
4XX:
description: failed_operation
content:
@@ -2785,14 +2760,8 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
- 410_example:
- $ref: '#/components/examples/Error410ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -2807,61 +2776,58 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestFiles.php
+ $ref: examples/SignatureRequestList.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestFiles.cs
+ $ref: examples/SignatureRequestList.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestFiles.js
+ $ref: examples/SignatureRequestList.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestFiles.ts
+ $ref: examples/SignatureRequestList.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestFiles.java
+ $ref: examples/SignatureRequestList.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestFiles.rb
+ $ref: examples/SignatureRequestList.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestFiles.py
+ $ref: examples/SignatureRequestList.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestFiles.sh
+ $ref: examples/SignatureRequestList.sh
x-meta:
seo:
- title: 'Download Files | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here'
- '/signature_request/files_as_data_uri/{signature_request_id}':
- get:
+ title: 'List Signature Requests | REST API | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.'
+ '/signature_request/release_hold/{signature_request_id}':
+ post:
tags:
- 'Signature Request'
- summary: 'Download Files as Data Uri'
- description: |-
- Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).
-
- If the files are currently being prepared, a status code of `409` will be returned instead.
- operationId: signatureRequestFilesAsDataUri
- parameters:
- -
+ summary: 'Release On-Hold Signature Request'
+ description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.'
+ operationId: signatureRequestReleaseHold
+ parameters:
+ -
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to retrieve.'
+ description: 'The id of the SignatureRequest to release.'
required: true
schema:
type: string
@@ -2879,10 +2845,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/FileResponseDataUri'
+ $ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestFilesResponseExample'
+ $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample'
4XX:
description: failed_operation
content:
@@ -2900,12 +2866,6 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 410_example:
- $ref: '#/components/examples/Error410ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -2913,79 +2873,80 @@ paths:
api_key: []
-
oauth2:
- - request_signature
- signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestFilesAsDataUri.php
+ $ref: examples/SignatureRequestReleaseHold.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestFilesAsDataUri.cs
+ $ref: examples/SignatureRequestReleaseHold.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestFilesAsDataUri.js
+ $ref: examples/SignatureRequestReleaseHold.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestFilesAsDataUri.ts
+ $ref: examples/SignatureRequestReleaseHold.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestFilesAsDataUri.java
+ $ref: examples/SignatureRequestReleaseHold.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestFilesAsDataUri.rb
+ $ref: examples/SignatureRequestReleaseHold.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestFilesAsDataUri.py
+ $ref: examples/SignatureRequestReleaseHold.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestFilesAsDataUri.sh
+ $ref: examples/SignatureRequestReleaseHold.sh
x-meta:
seo:
- title: 'Download Files | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here'
- '/signature_request/files_as_file_url/{signature_request_id}':
- get:
+ title: 'Release On-Hold Signature Request | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.'
+ '/signature_request/remind/{signature_request_id}':
+ post:
tags:
- 'Signature Request'
- summary: 'Download Files as File Url'
+ summary: 'Send Request Reminder'
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).
+ 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.
- If the files are currently being prepared, a status code of `409` will be returned instead.
- operationId: signatureRequestFilesAsFileUrl
+ **NOTE:** This action can **not** be used with embedded signature requests.
+ operationId: signatureRequestRemind
parameters:
-
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to retrieve.'
+ description: 'The id of the SignatureRequest to send a reminder for.'
required: true
schema:
type: string
example: fa5c8a0b0f492d768749333ad6fcc214c111e967
- -
- name: force_download
- in: query
- description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
- schema:
- type: integer
- default: 1
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SignatureRequestRemindRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample'
responses:
200:
description: 'successful operation'
@@ -2999,10 +2960,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/FileResponse'
+ $ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestFilesResponseExample'
+ $ref: '#/components/examples/SignatureRequestRemindResponseExample'
4XX:
description: failed_operation
content:
@@ -3040,58 +3001,63 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.php
+ $ref: examples/SignatureRequestRemind.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.cs
+ $ref: examples/SignatureRequestRemind.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.js
+ $ref: examples/SignatureRequestRemind.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.ts
+ $ref: examples/SignatureRequestRemind.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.java
+ $ref: examples/SignatureRequestRemind.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.rb
+ $ref: examples/SignatureRequestRemind.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.py
+ $ref: examples/SignatureRequestRemind.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestFilesAsFileUrl.sh
+ $ref: examples/SignatureRequestRemind.sh
x-meta:
seo:
- title: 'Download Files | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here'
- '/signature_request/{signature_request_id}':
- get:
+ title: 'Send Request Reminder | REST API | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.'
+ '/signature_request/remove/{signature_request_id}':
+ post:
tags:
- 'Signature Request'
- summary: 'Get Signature Request'
- description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.'
- operationId: signatureRequestGet
+ summary: 'Remove Signature Request Access'
+ description: |-
+ Removes your access to a completed signature request. This action is **not reversible**.
+
+ The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s).
+
+ Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
+ operationId: signatureRequestRemove
parameters:
-
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to retrieve.'
+ description: 'The id of the SignatureRequest to remove.'
required: true
schema:
type: string
@@ -3107,12 +3073,7 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestGetResponse'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestGetResponseExample'
+ application/json: {}
4XX:
description: failed_operation
content:
@@ -3130,6 +3091,8 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
+ 409_example:
+ $ref: '#/components/examples/Error409ResponseExample'
410_example:
$ref: '#/components/examples/Error410ResponseExample'
4XX_example:
@@ -3137,93 +3100,72 @@ paths:
security:
-
api_key: []
- -
- oauth2:
- - request_signature
- - signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestGet.php
+ $ref: examples/SignatureRequestRemove.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestGet.cs
+ $ref: examples/SignatureRequestRemove.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestGet.js
+ $ref: examples/SignatureRequestRemove.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestGet.ts
+ $ref: examples/SignatureRequestRemove.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestGet.java
+ $ref: examples/SignatureRequestRemove.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestGet.rb
+ $ref: examples/SignatureRequestRemove.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestGet.py
+ $ref: examples/SignatureRequestRemove.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestGet.sh
+ $ref: examples/SignatureRequestRemove.sh
x-meta:
seo:
- title: 'Get Signature Request | Documentation | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.'
- /signature_request/list:
- get:
+ title: 'Remove Signature Request Access | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.'
+ /signature_request/send:
+ post:
tags:
- 'Signature Request'
- summary: 'List Signature Requests'
- description: |-
- Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.
-
- Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.
- operationId: signatureRequestList
- parameters:
- -
- name: account_id
- in: query
- description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.'
- schema:
- type: string
- -
- name: page
- in: query
- description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.'
- schema:
- type: integer
- default: 1
- example: 1
- -
- name: page_size
- in: query
- description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
- schema:
- type: integer
- default: 20
- -
- name: query
- in: query
- description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.'
- schema:
- type: string
+ summary: 'Send Signature Request'
+ description: 'Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.'
+ operationId: signatureRequestSend
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SignatureRequestSendRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample'
+ grouped_signers_example:
+ $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/SignatureRequestSendRequest'
responses:
200:
description: 'successful operation'
@@ -3237,10 +3179,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SignatureRequestListResponse'
+ $ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestListResponseExample'
+ $ref: '#/components/examples/SignatureRequestSendResponseExample'
4XX:
description: failed_operation
content:
@@ -3258,6 +3200,8 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -3272,62 +3216,65 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestList.php
+ $ref: examples/SignatureRequestSend.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestList.cs
+ $ref: examples/SignatureRequestSend.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestList.js
+ $ref: examples/SignatureRequestSend.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestList.ts
+ $ref: examples/SignatureRequestSend.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestList.java
+ $ref: examples/SignatureRequestSend.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestList.rb
+ $ref: examples/SignatureRequestSend.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestList.py
+ $ref: examples/SignatureRequestSend.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestList.sh
+ $ref: examples/SignatureRequestSend.sh
x-meta:
seo:
- title: 'List Signature Requests | REST API | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.'
- '/signature_request/release_hold/{signature_request_id}':
+ title: 'Send Signature Request | REST API | Dropbox Sign for Developers'
+ description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.'
+ /signature_request/send_with_template:
post:
tags:
- 'Signature Request'
- summary: 'Release On-Hold Signature Request'
- description: 'Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.'
- operationId: signatureRequestReleaseHold
- parameters:
- -
- name: signature_request_id
- in: path
- description: 'The id of the SignatureRequest to release.'
- required: true
- schema:
- type: string
- example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+ summary: 'Send with Template'
+ description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.'
+ operationId: signatureRequestSendWithTemplate
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest'
responses:
200:
description: 'successful operation'
@@ -3344,7 +3291,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample'
+ $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample'
4XX:
description: failed_operation
content:
@@ -3360,76 +3307,79 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
- 4XX_example:
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
+ 4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
-
api_key: []
-
oauth2:
+ - request_signature
- signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestReleaseHold.php
+ $ref: examples/SignatureRequestSendWithTemplate.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestReleaseHold.cs
+ $ref: examples/SignatureRequestSendWithTemplate.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestReleaseHold.js
+ $ref: examples/SignatureRequestSendWithTemplate.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestReleaseHold.ts
+ $ref: examples/SignatureRequestSendWithTemplate.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestReleaseHold.java
+ $ref: examples/SignatureRequestSendWithTemplate.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestReleaseHold.rb
+ $ref: examples/SignatureRequestSendWithTemplate.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestReleaseHold.py
+ $ref: examples/SignatureRequestSendWithTemplate.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestReleaseHold.sh
+ $ref: examples/SignatureRequestSendWithTemplate.sh
x-meta:
seo:
- title: 'Release On-Hold Signature Request | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.'
- '/signature_request/remind/{signature_request_id}':
+ title: 'Send with Template | API Documentation | Dropbox Sign for Developers'
+ description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.'
+ '/signature_request/update/{signature_request_id}':
post:
tags:
- 'Signature Request'
- summary: 'Send Request Reminder'
+ summary: 'Update Signature Request'
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.
+ 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.
- **NOTE**: This action can **not** be used with embedded signature requests.
- operationId: signatureRequestRemind
+ Updating the email address of a signer will generate a new `signature_id` value.
+
+ **NOTE:** This action cannot be performed on a signature request with an appended signature page.
+ operationId: signatureRequestUpdate
parameters:
-
name: signature_request_id
in: path
- description: 'The id of the SignatureRequest to send a reminder for.'
+ description: 'The id of the SignatureRequest to update.'
required: true
schema:
type: string
@@ -3439,10 +3389,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SignatureRequestRemindRequest'
+ $ref: '#/components/schemas/SignatureRequestUpdateRequest'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample'
+ $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample'
responses:
200:
description: 'successful operation'
@@ -3459,7 +3409,7 @@ paths:
$ref: '#/components/schemas/SignatureRequestGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestRemindResponseExample'
+ $ref: '#/components/examples/SignatureRequestUpdateResponseExample'
4XX:
description: failed_operation
content:
@@ -3477,12 +3427,6 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 410_example:
- $ref: '#/components/examples/Error410ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -3490,74 +3434,79 @@ paths:
api_key: []
-
oauth2:
- - request_signature
- signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestRemind.php
+ $ref: examples/SignatureRequestUpdate.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestRemind.cs
+ $ref: examples/SignatureRequestUpdate.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestRemind.js
+ $ref: examples/SignatureRequestUpdate.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestRemind.ts
+ $ref: examples/SignatureRequestUpdate.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestRemind.java
+ $ref: examples/SignatureRequestUpdate.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestRemind.rb
+ $ref: examples/SignatureRequestUpdate.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestRemind.py
+ $ref: examples/SignatureRequestUpdate.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestRemind.sh
+ $ref: examples/SignatureRequestUpdate.sh
x-meta:
seo:
- title: 'Send Request Reminder | REST API | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.'
- '/signature_request/remove/{signature_request_id}':
- post:
+ title: 'Update Signature Request | REST API | Dropbox Sign for Developers'
+ description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.'
+ /team/add_member:
+ put:
tags:
- - 'Signature Request'
- summary: 'Remove Signature Request Access'
- description: |-
- Removes your access to a completed signature request. This action is **not reversible**.
-
- The signature request must be fully executed by all parties (signed or declined to sign). Other parties will continue to maintain access to the completed signature request document(s).
-
- Unlike /signature_request/cancel, this endpoint is synchronous and your access will be immediately removed. Upon successful removal, this endpoint will return a 200 OK response.
- operationId: signatureRequestRemove
+ - Team
+ summary: 'Add User to Team'
+ description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.'
+ operationId: teamAddMember
parameters:
-
- name: signature_request_id
- in: path
- description: 'The id of the SignatureRequest to remove.'
- required: true
+ name: team_id
+ in: query
+ description: 'The id of the team.'
+ required: false
schema:
type: string
- example: fa5c8a0b0f492d768749333ad6fcc214c111e967
+ example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamAddMemberRequest'
+ examples:
+ email_address:
+ $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample'
+ account_id:
+ $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample'
responses:
200:
description: 'successful operation'
@@ -3569,7 +3518,12 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/json: {}
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamGetResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TeamAddMemberResponseExample'
4XX:
description: failed_operation
content:
@@ -3587,81 +3541,75 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 410_example:
- $ref: '#/components/examples/Error410ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
-
api_key: []
+ -
+ oauth2:
+ - team_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestRemove.php
+ $ref: examples/TeamAddMember.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestRemove.cs
+ $ref: examples/TeamAddMember.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestRemove.js
+ $ref: examples/TeamAddMember.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestRemove.ts
+ $ref: examples/TeamAddMember.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestRemove.java
+ $ref: examples/TeamAddMember.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestRemove.rb
+ $ref: examples/TeamAddMember.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestRemove.py
+ $ref: examples/TeamAddMember.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestRemove.sh
+ $ref: examples/TeamAddMember.sh
x-meta:
seo:
- title: 'Remove Signature Request Access | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.'
- /signature_request/send:
+ title: 'Add User to Team | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.'
+ /team/create:
post:
tags:
- - 'Signature Request'
- summary: 'Send Signature Request'
- description: 'Creates and sends a new SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents.'
- operationId: signatureRequestSend
+ - Team
+ summary: 'Create Team'
+ description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.'
+ operationId: teamCreate
requestBody:
required: true
content:
application/json:
schema:
- $ref: '#/components/schemas/SignatureRequestSendRequest'
+ $ref: '#/components/schemas/TeamCreateRequest'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample'
- grouped_signers_example:
- $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SignatureRequestSendRequest'
+ $ref: '#/components/examples/TeamCreateRequestDefaultExample'
responses:
200:
description: 'successful operation'
@@ -3675,10 +3623,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SignatureRequestGetResponse'
+ $ref: '#/components/schemas/TeamGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestSendResponseExample'
+ $ref: '#/components/examples/TeamCreateResponseExample'
4XX:
description: failed_operation
content:
@@ -3694,10 +3642,6 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -3705,72 +3649,59 @@ paths:
api_key: []
-
oauth2:
- - request_signature
- - signature_request_access
+ - team_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestSend.php
+ $ref: examples/TeamCreate.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestSend.cs
+ $ref: examples/TeamCreate.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestSend.js
+ $ref: examples/TeamCreate.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestSend.ts
+ $ref: examples/TeamCreate.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestSend.java
+ $ref: examples/TeamCreate.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestSend.rb
+ $ref: examples/TeamCreate.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestSend.py
+ $ref: examples/TeamCreate.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestSend.sh
+ $ref: examples/TeamCreate.sh
x-meta:
seo:
- title: 'Send Signature Request | REST API | Dropbox Sign for Developers'
- description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.'
- /signature_request/send_with_template:
- post:
+ title: 'Create Team | REST API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.'
+ /team/destroy:
+ delete:
tags:
- - 'Signature Request'
- summary: 'Send with Template'
- description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.'
- operationId: signatureRequestSendWithTemplate
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest'
+ - Team
+ summary: 'Delete Team'
+ description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).'
+ operationId: teamDelete
responses:
200:
description: 'successful operation'
@@ -3781,13 +3712,6 @@ paths:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestGetResponse'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample'
4XX:
description: failed_operation
content:
@@ -3803,8 +3727,6 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -3812,83 +3734,59 @@ paths:
api_key: []
-
oauth2:
- - request_signature
- - signature_request_access
+ - team_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestSendWithTemplate.php
+ $ref: examples/TeamDelete.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestSendWithTemplate.cs
+ $ref: examples/TeamDelete.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestSendWithTemplate.js
+ $ref: examples/TeamDelete.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestSendWithTemplate.ts
+ $ref: examples/TeamDelete.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestSendWithTemplate.java
+ $ref: examples/TeamDelete.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestSendWithTemplate.rb
+ $ref: examples/TeamDelete.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestSendWithTemplate.py
+ $ref: examples/TeamDelete.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestSendWithTemplate.sh
+ $ref: examples/TeamDelete.sh
x-meta:
seo:
- title: 'Send with Template | API Documentation | Dropbox Sign for Developers'
- description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.'
- '/signature_request/update/{signature_request_id}':
- post:
+ title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.'
+ /team:
+ get:
tags:
- - 'Signature Request'
- summary: 'Update Signature Request'
- description: |-
- Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.
-
- Updating the email address of a signer will generate a new `signature_id` value.
-
- **NOTE**: This action cannot be performed on a signature request with an appended signature page.
- operationId: signatureRequestUpdate
- parameters:
- -
- name: signature_request_id
- in: path
- description: 'The id of the SignatureRequest to update.'
- required: true
- schema:
- type: string
- example: fa5c8a0b0f492d768749333ad6fcc214c111e967
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SignatureRequestUpdateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample'
+ - Team
+ summary: 'Get Team'
+ description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.'
+ operationId: teamGet
responses:
200:
description: 'successful operation'
@@ -3902,10 +3800,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/SignatureRequestGetResponse'
+ $ref: '#/components/schemas/TeamGetResponse'
examples:
default_example:
- $ref: '#/components/examples/SignatureRequestUpdateResponseExample'
+ $ref: '#/components/examples/TeamGetResponseExample'
4XX:
description: failed_operation
content:
@@ -3922,7 +3820,7 @@ paths:
403_example:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
- $ref: '#/components/examples/Error404ResponseExample'
+ $ref: '#/components/examples/TeamDoesNotExistResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -3930,79 +3828,67 @@ paths:
api_key: []
-
oauth2:
- - signature_request_access
+ - team_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/SignatureRequestUpdate.php
+ $ref: examples/TeamGet.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/SignatureRequestUpdate.cs
+ $ref: examples/TeamGet.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/SignatureRequestUpdate.js
+ $ref: examples/TeamGet.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/SignatureRequestUpdate.ts
+ $ref: examples/TeamGet.ts
-
lang: Java
label: Java
source:
- $ref: examples/SignatureRequestUpdate.java
+ $ref: examples/TeamGet.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/SignatureRequestUpdate.rb
+ $ref: examples/TeamGet.rb
-
lang: Python
label: Python
source:
- $ref: examples/SignatureRequestUpdate.py
+ $ref: examples/TeamGet.py
-
lang: cURL
label: cURL
source:
- $ref: examples/SignatureRequestUpdate.sh
+ $ref: examples/TeamGet.sh
x-meta:
seo:
- title: 'Update Signature Request | REST API | Dropbox Sign for Developers'
- description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.'
- /team/add_member:
+ title: 'Get Team | REST API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.'
put:
tags:
- Team
- summary: 'Add User to Team'
- description: 'Invites a user (specified using the `email_address` parameter) to your Team. If the user does not currently have a Dropbox Sign Account, a new one will be created for them. If a user is already a part of another Team, a `team_invite_failed` error will be returned.'
- operationId: teamAddMember
- parameters:
- -
- name: team_id
- in: query
- description: 'The id of the team.'
- required: false
- schema:
- type: string
- example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
+ summary: 'Update Team'
+ description: 'Updates the name of your Team.'
+ operationId: teamUpdate
requestBody:
required: true
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamAddMemberRequest'
+ $ref: '#/components/schemas/TeamUpdateRequest'
examples:
- email_address:
- $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample'
- account_id:
- $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample'
+ default_example:
+ $ref: '#/components/examples/TeamUpdateRequestDefaultExample'
responses:
200:
description: 'successful operation'
@@ -4019,7 +3905,7 @@ paths:
$ref: '#/components/schemas/TeamGetResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamAddMemberResponseExample'
+ $ref: '#/components/examples/TeamUpdateResponseExample'
4XX:
description: failed_operation
content:
@@ -4035,8 +3921,6 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4050,62 +3934,62 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TeamAddMember.php
+ $ref: examples/TeamUpdate.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamAddMember.cs
+ $ref: examples/TeamUpdate.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamAddMember.js
+ $ref: examples/TeamUpdate.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamAddMember.ts
+ $ref: examples/TeamUpdate.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamAddMember.java
+ $ref: examples/TeamUpdate.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamAddMember.rb
+ $ref: examples/TeamUpdate.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamAddMember.py
+ $ref: examples/TeamUpdate.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamAddMember.sh
+ $ref: examples/TeamUpdate.sh
x-meta:
seo:
- title: 'Add User to Team | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.'
- /team/create:
- post:
+ title: 'Update Team | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.'
+ /team/info:
+ get:
tags:
- Team
- summary: 'Create Team'
- description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.'
- operationId: teamCreate
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TeamCreateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/TeamCreateRequestDefaultExample'
+ summary: 'Get Team Info'
+ description: 'Provides information about a team.'
+ operationId: teamInfo
+ parameters:
+ -
+ name: team_id
+ in: query
+ description: 'The id of the team.'
+ required: false
+ schema:
+ type: string
+ example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
responses:
200:
description: 'successful operation'
@@ -4119,10 +4003,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamGetResponse'
+ $ref: '#/components/schemas/TeamGetInfoResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamCreateResponseExample'
+ $ref: '#/components/examples/TeamGetInfoResponseExample'
4XX:
description: failed_operation
content:
@@ -4138,6 +4022,10 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
+ 409_example:
+ $ref: '#/components/examples/Error409ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4151,53 +4039,61 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TeamCreate.php
+ $ref: examples/TeamInfo.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamCreate.cs
+ $ref: examples/TeamInfo.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamCreate.js
+ $ref: examples/TeamInfo.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamCreate.ts
+ $ref: examples/TeamInfo.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamCreate.java
+ $ref: examples/TeamInfo.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamCreate.rb
+ $ref: examples/TeamInfo.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamCreate.py
+ $ref: examples/TeamInfo.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamCreate.sh
+ $ref: examples/TeamInfo.sh
x-meta:
seo:
- title: 'Create Team | REST API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.'
- /team/destroy:
- delete:
+ title: 'Get Team Info | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.'
+ /team/invites:
+ get:
tags:
- Team
- summary: 'Delete Team'
- description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).'
- operationId: teamDelete
+ summary: 'List Team Invites'
+ description: 'Provides a list of team invites (and their roles).'
+ operationId: teamInvites
+ parameters:
+ -
+ name: email_address
+ in: query
+ description: 'The email address for which to display the team invites.'
+ required: false
+ schema:
+ type: string
responses:
200:
description: 'successful operation'
@@ -4208,6 +4104,13 @@ paths:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamInvitesResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TeamInvitesResponseExample'
4XX:
description: failed_operation
content:
@@ -4230,59 +4133,85 @@ paths:
api_key: []
-
oauth2:
- - team_access
+ - account_access
+ - basic_account_info
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TeamDelete.php
+ $ref: examples/TeamInvites.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamDelete.cs
+ $ref: examples/TeamInvites.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamDelete.js
+ $ref: examples/TeamInvites.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamDelete.ts
+ $ref: examples/TeamInvites.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamDelete.java
+ $ref: examples/TeamInvites.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamDelete.rb
+ $ref: examples/TeamInvites.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamDelete.py
+ $ref: examples/TeamInvites.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamDelete.sh
+ $ref: examples/TeamInvites.sh
x-meta:
seo:
- title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.'
- /team:
+ title: 'List Team Invites | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.'
+ '/team/members/{team_id}':
get:
tags:
- Team
- summary: 'Get Team'
- description: 'Returns information about your Team as well as a list of its members. If you do not belong to a Team, a 404 error with an error_name of "not_found" will be returned.'
- operationId: teamGet
+ summary: 'List Team Members'
+ description: 'Provides a paginated list of members (and their roles) that belong to a given team.'
+ operationId: teamMembers
+ parameters:
+ -
+ name: team_id
+ in: path
+ description: 'The id of the team that a member list is being requested from.'
+ required: true
+ schema:
+ type: string
+ example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
+ -
+ name: page
+ in: query
+ description: 'Which page number of the team member list to return. Defaults to `1`.'
+ schema:
+ type: integer
+ default: 1
+ -
+ name: page_size
+ in: query
+ description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
+ schema:
+ type: integer
+ default: 20
+ maximum: 100
+ minimum: 1
responses:
200:
description: 'successful operation'
@@ -4296,10 +4225,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamGetResponse'
+ $ref: '#/components/schemas/TeamMembersResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamGetResponseExample'
+ $ref: '#/components/examples/TeamMembersResponseExample'
4XX:
description: failed_operation
content:
@@ -4315,8 +4244,10 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/TeamDoesNotExistResponseExample'
+ 409_example:
+ $ref: '#/components/examples/Error409ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4330,63 +4261,66 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TeamGet.php
+ $ref: examples/TeamMembers.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamGet.cs
+ $ref: examples/TeamMembers.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamGet.js
+ $ref: examples/TeamMembers.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamGet.ts
+ $ref: examples/TeamMembers.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamGet.java
+ $ref: examples/TeamMembers.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamGet.rb
+ $ref: examples/TeamMembers.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamGet.py
+ $ref: examples/TeamMembers.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamGet.sh
+ $ref: examples/TeamMembers.sh
x-meta:
seo:
- title: 'Get Team | REST API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.'
- put:
+ title: 'List Team Members | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.'
+ /team/remove_member:
+ post:
tags:
- Team
- summary: 'Update Team'
- description: 'Updates the name of your Team.'
- operationId: teamUpdate
+ summary: 'Remove User from Team'
+ description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.'
+ operationId: teamRemoveMember
requestBody:
required: true
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamUpdateRequest'
+ $ref: '#/components/schemas/TeamRemoveMemberRequest'
examples:
- default_example:
- $ref: '#/components/examples/TeamUpdateRequestDefaultExample'
+ email_address:
+ $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample'
+ account_id:
+ $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample'
responses:
- 200:
+ 201:
description: 'successful operation'
headers:
X-RateLimit-Limit:
@@ -4401,7 +4335,7 @@ paths:
$ref: '#/components/schemas/TeamGetResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamUpdateResponseExample'
+ $ref: '#/components/examples/TeamRemoveMemberResponseExample'
4XX:
description: failed_operation
content:
@@ -4417,6 +4351,8 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4430,62 +4366,78 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TeamUpdate.php
+ $ref: examples/TeamRemoveMember.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamUpdate.cs
+ $ref: examples/TeamRemoveMember.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamUpdate.js
+ $ref: examples/TeamRemoveMember.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamUpdate.ts
+ $ref: examples/TeamRemoveMember.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamUpdate.java
+ $ref: examples/TeamRemoveMember.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamUpdate.rb
+ $ref: examples/TeamRemoveMember.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamUpdate.py
+ $ref: examples/TeamRemoveMember.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamUpdate.sh
+ $ref: examples/TeamRemoveMember.sh
x-meta:
seo:
- title: 'Update Team | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.'
- /team/info:
+ title: 'Remove User from Team | REST API | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.'
+ '/team/sub_teams/{team_id}':
get:
tags:
- Team
- summary: 'Get Team Info'
- description: 'Provides information about a team.'
- operationId: teamInfo
+ summary: 'List Sub Teams'
+ description: 'Provides a paginated list of sub teams that belong to a given team.'
+ operationId: teamSubTeams
parameters:
-
name: team_id
- in: query
- description: 'The id of the team.'
- required: false
+ in: path
+ description: 'The id of the parent Team.'
+ required: true
schema:
type: string
example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
+ -
+ name: page
+ in: query
+ description: 'Which page number of the SubTeam List to return. Defaults to `1`.'
+ schema:
+ type: integer
+ default: 1
+ -
+ name: page_size
+ in: query
+ description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
+ schema:
+ type: integer
+ default: 20
+ maximum: 100
+ minimum: 1
responses:
200:
description: 'successful operation'
@@ -4499,10 +4451,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamGetInfoResponse'
+ $ref: '#/components/schemas/TeamSubTeamsResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamGetInfoResponseExample'
+ $ref: '#/components/examples/TeamSubTeamsResponseExample'
4XX:
description: failed_operation
content:
@@ -4535,61 +4487,71 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TeamInfo.php
+ $ref: examples/TeamSubTeams.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamInfo.cs
+ $ref: examples/TeamSubTeams.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamInfo.js
+ $ref: examples/TeamSubTeams.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamInfo.ts
+ $ref: examples/TeamSubTeams.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamInfo.java
+ $ref: examples/TeamSubTeams.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamInfo.rb
+ $ref: examples/TeamSubTeams.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamInfo.py
+ $ref: examples/TeamSubTeams.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamInfo.sh
+ $ref: examples/TeamSubTeams.sh
x-meta:
seo:
- title: 'Get Team Info | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.'
- /team/invites:
- get:
+ title: 'List Sub Teams | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.'
+ '/template/add_user/{template_id}':
+ post:
tags:
- - Team
- summary: 'List Team Invites'
- description: 'Provides a list of team invites (and their roles).'
- operationId: teamInvites
+ - Template
+ summary: 'Add User to Template'
+ description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.'
+ operationId: templateAddUser
parameters:
-
- name: email_address
- in: query
- description: 'The email address for which to display the team invites.'
- required: false
+ name: template_id
+ in: path
+ description: 'The id of the Template to give the Account access to.'
+ required: true
schema:
type: string
+ example: f57db65d3f933b5316d398057a36176831451a35
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplateAddUserRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TemplateAddUserRequestDefaultExample'
responses:
200:
description: 'successful operation'
@@ -4603,10 +4565,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamInvitesResponse'
+ $ref: '#/components/schemas/TemplateGetResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamInvitesResponseExample'
+ $ref: '#/components/examples/TemplateAddUserResponseExample'
4XX:
description: failed_operation
content:
@@ -4622,6 +4584,8 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4629,85 +4593,77 @@ paths:
api_key: []
-
oauth2:
- - account_access
- - basic_account_info
+ - template_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TeamInvites.php
+ $ref: examples/TemplateAddUser.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamInvites.cs
+ $ref: examples/TemplateAddUser.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamInvites.js
+ $ref: examples/TemplateAddUser.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamInvites.ts
+ $ref: examples/TemplateAddUser.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamInvites.java
+ $ref: examples/TemplateAddUser.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamInvites.rb
+ $ref: examples/TemplateAddUser.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamInvites.py
+ $ref: examples/TemplateAddUser.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamInvites.sh
+ $ref: examples/TemplateAddUser.sh
x-meta:
seo:
- title: 'List Team Invites | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.'
- '/team/members/{team_id}':
- get:
+ title: 'Add User to Template | REST API | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.'
+ /template/create:
+ post:
tags:
- - Team
- summary: 'List Team Members'
- description: 'Provides a paginated list of members (and their roles) that belong to a given team.'
- operationId: teamMembers
- parameters:
- -
- name: team_id
- in: path
- description: 'The id of the team that a member list is being requested from.'
- required: true
- schema:
- type: string
- example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
- -
- name: page
- in: query
- description: 'Which page number of the team member list to return. Defaults to `1`.'
- schema:
- type: integer
- default: 1
- -
- name: page_size
- in: query
- description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
- schema:
- type: integer
- default: 20
- maximum: 100
- minimum: 1
+ - Template
+ summary: 'Create Template'
+ description: 'Creates a template that can then be used.'
+ operationId: templateCreate
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplateCreateRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TemplateCreateRequestDefaultExample'
+ form_fields_per_document:
+ $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample'
+ form_field_groups:
+ $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample'
+ form_field_rules:
+ $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/TemplateCreateRequest'
responses:
200:
description: 'successful operation'
@@ -4721,10 +4677,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamMembersResponse'
+ $ref: '#/components/schemas/TemplateCreateResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamMembersResponseExample'
+ $ref: '#/components/examples/TemplateCreateResponseExample'
4XX:
description: failed_operation
content:
@@ -4740,10 +4696,10 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4751,72 +4707,79 @@ paths:
api_key: []
-
oauth2:
- - team_access
+ - template_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TeamMembers.php
+ $ref: examples/TemplateCreate.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamMembers.cs
+ $ref: examples/TemplateCreate.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamMembers.js
+ $ref: examples/TemplateCreate.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamMembers.ts
+ $ref: examples/TemplateCreate.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamMembers.java
+ $ref: examples/TemplateCreate.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamMembers.rb
+ $ref: examples/TemplateCreate.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamMembers.py
+ $ref: examples/TemplateCreate.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamMembers.sh
+ $ref: examples/TemplateCreate.sh
x-meta:
seo:
- title: 'List Team Members | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.'
- /team/remove_member:
+ title: 'Create Template | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.'
+ /template/create_embedded_draft:
post:
tags:
- - Team
- summary: 'Remove User from Team'
- description: 'Removes the provided user Account from your Team. If the Account had an outstanding invitation to your Team, the invitation will be expired. If you choose to transfer documents from the removed Account to an Account provided in the `new_owner_email_address` parameter (available only for Enterprise plans), the response status code will be 201, which indicates that your request has been queued but not fully executed.'
- operationId: teamRemoveMember
+ - Template
+ summary: 'Create Embedded Template Draft'
+ description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.'
+ operationId: templateCreateEmbeddedDraft
requestBody:
required: true
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamRemoveMemberRequest'
+ $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest'
examples:
- email_address:
- $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample'
- account_id:
- $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample'
+ default_example:
+ $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample'
+ form_fields_per_document:
+ $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample'
+ form_field_groups:
+ $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample'
+ form_field_rules:
+ $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest'
responses:
- 201:
+ 200:
description: 'successful operation'
headers:
X-RateLimit-Limit:
@@ -4828,10 +4791,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TeamGetResponse'
+ $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse'
examples:
default_example:
- $ref: '#/components/examples/TeamRemoveMemberResponseExample'
+ $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample'
4XX:
description: failed_operation
content:
@@ -4849,6 +4812,8 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
+ 409_example:
+ $ref: '#/components/examples/Error409ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4856,84 +4821,68 @@ paths:
api_key: []
-
oauth2:
- - team_access
+ - template_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TeamRemoveMember.php
+ $ref: examples/TemplateCreateEmbeddedDraft.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamRemoveMember.cs
+ $ref: examples/TemplateCreateEmbeddedDraft.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamRemoveMember.js
+ $ref: examples/TemplateCreateEmbeddedDraft.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamRemoveMember.ts
+ $ref: examples/TemplateCreateEmbeddedDraft.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamRemoveMember.java
+ $ref: examples/TemplateCreateEmbeddedDraft.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamRemoveMember.rb
+ $ref: examples/TemplateCreateEmbeddedDraft.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamRemoveMember.py
+ $ref: examples/TemplateCreateEmbeddedDraft.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamRemoveMember.sh
+ $ref: examples/TemplateCreateEmbeddedDraft.sh
x-meta:
seo:
- title: 'Remove User from Team | REST API | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.'
- '/team/sub_teams/{team_id}':
- get:
+ title: 'Create Embedded Template Draft | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.'
+ '/template/delete/{template_id}':
+ post:
tags:
- - Team
- summary: 'List Sub Teams'
- description: 'Provides a paginated list of sub teams that belong to a given team.'
- operationId: teamSubTeams
+ - Template
+ summary: 'Delete Template'
+ description: 'Completely deletes the template specified from the account.'
+ operationId: templateDelete
parameters:
-
- name: team_id
+ name: template_id
in: path
- description: 'The id of the parent Team.'
+ description: 'The id of the Template to delete.'
required: true
schema:
type: string
- example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
- -
- name: page
- in: query
- description: 'Which page number of the SubTeam List to return. Defaults to `1`.'
- schema:
- type: integer
- default: 1
- -
- name: page_size
- in: query
- description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
- schema:
- type: integer
- default: 20
- maximum: 100
- minimum: 1
+ example: f57db65d3f933b5316d398057a36176831451a35
responses:
200:
description: 'successful operation'
@@ -4945,12 +4894,7 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/json:
- schema:
- $ref: '#/components/schemas/TeamSubTeamsResponse'
- examples:
- default_example:
- $ref: '#/components/examples/TeamSubTeamsResponseExample'
+ application/json: {}
4XX:
description: failed_operation
content:
@@ -4966,10 +4910,10 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -4977,77 +4921,80 @@ paths:
api_key: []
-
oauth2:
- - team_access
+ - template_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TeamSubTeams.php
+ $ref: examples/TemplateDelete.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TeamSubTeams.cs
+ $ref: examples/TemplateDelete.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TeamSubTeams.js
+ $ref: examples/TemplateDelete.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TeamSubTeams.ts
+ $ref: examples/TemplateDelete.ts
-
lang: Java
label: Java
source:
- $ref: examples/TeamSubTeams.java
+ $ref: examples/TemplateDelete.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TeamSubTeams.rb
+ $ref: examples/TemplateDelete.rb
-
lang: Python
label: Python
source:
- $ref: examples/TeamSubTeams.py
+ $ref: examples/TemplateDelete.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TeamSubTeams.sh
+ $ref: examples/TemplateDelete.sh
x-meta:
seo:
- title: 'List Sub Teams | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.'
- '/template/add_user/{template_id}':
- post:
+ title: 'Delete Template | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.'
+ '/template/files/{template_id}':
+ get:
tags:
- Template
- summary: 'Add User to Template'
- description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.'
- operationId: templateAddUser
+ summary: 'Get Template Files'
+ description: |-
+ Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file.
+
+ If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
+ operationId: templateFiles
parameters:
-
name: template_id
in: path
- description: 'The id of the Template to give the Account access to.'
+ description: 'The id of the template files to retrieve.'
required: true
schema:
type: string
example: f57db65d3f933b5316d398057a36176831451a35
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TemplateAddUserRequest'
- examples:
- default_example:
- $ref: '#/components/examples/TemplateAddUserRequestDefaultExample'
+ -
+ name: file_type
+ in: query
+ description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.'
+ schema:
+ type: string
+ enum:
+ - pdf
+ - zip
responses:
200:
description: 'successful operation'
@@ -5059,12 +5006,14 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/json:
+ application/pdf:
schema:
- $ref: '#/components/schemas/TemplateGetResponse'
- examples:
- default_example:
- $ref: '#/components/examples/TemplateAddUserResponseExample'
+ type: string
+ format: binary
+ application/zip:
+ schema:
+ type: string
+ format: binary
4XX:
description: failed_operation
content:
@@ -5082,6 +5031,12 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
+ 409_example:
+ $ref: '#/components/examples/Error409ResponseExample'
+ 422_example:
+ $ref: '#/components/examples/Error422ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -5095,71 +5050,65 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TemplateAddUser.php
+ $ref: examples/TemplateFiles.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateAddUser.cs
+ $ref: examples/TemplateFiles.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateAddUser.js
+ $ref: examples/TemplateFiles.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateAddUser.ts
+ $ref: examples/TemplateFiles.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateAddUser.java
+ $ref: examples/TemplateFiles.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateAddUser.rb
+ $ref: examples/TemplateFiles.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateAddUser.py
+ $ref: examples/TemplateFiles.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateAddUser.sh
+ $ref: examples/TemplateFiles.sh
x-meta:
seo:
- title: 'Add User to Template | REST API | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.'
- /template/create:
- post:
+ title: 'Get Template Files | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.'
+ '/template/files_as_data_uri/{template_id}':
+ get:
tags:
- Template
- summary: 'Create Template'
- description: 'Creates a template that can then be used.'
- operationId: templateCreate
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TemplateCreateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/TemplateCreateRequestDefaultExample'
- form_fields_per_document:
- $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample'
- form_field_groups:
- $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample'
- form_field_rules:
- $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/TemplateCreateRequest'
+ summary: 'Get Template Files as Data Uri'
+ description: |-
+ Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).
+
+ If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
+ operationId: templateFilesAsDataUri
+ parameters:
+ -
+ name: template_id
+ in: path
+ description: 'The id of the template files to retrieve.'
+ required: true
+ schema:
+ type: string
+ example: f57db65d3f933b5316d398057a36176831451a35
responses:
200:
description: 'successful operation'
@@ -5173,10 +5122,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateCreateResponse'
+ $ref: '#/components/schemas/FileResponseDataUri'
examples:
default_example:
- $ref: '#/components/examples/TemplateCreateResponseExample'
+ $ref: '#/components/examples/TemplateFilesResponseExample'
4XX:
description: failed_operation
content:
@@ -5196,6 +5145,10 @@ paths:
$ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
+ 422_example:
+ $ref: '#/components/examples/Error422ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -5209,71 +5162,72 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TemplateCreate.php
+ $ref: examples/TemplateFilesAsDataUri.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateCreate.cs
+ $ref: examples/TemplateFilesAsDataUri.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateCreate.js
+ $ref: examples/TemplateFilesAsDataUri.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateCreate.ts
+ $ref: examples/TemplateFilesAsDataUri.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateCreate.java
+ $ref: examples/TemplateFilesAsDataUri.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateCreate.rb
+ $ref: examples/TemplateFilesAsDataUri.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateCreate.py
+ $ref: examples/TemplateFilesAsDataUri.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateCreate.sh
+ $ref: examples/TemplateFilesAsDataUri.sh
x-meta:
seo:
- title: 'Create Template | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.'
- /template/create_embedded_draft:
- post:
+ title: 'Get Template Files | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.'
+ '/template/files_as_file_url/{template_id}':
+ get:
tags:
- Template
- summary: 'Create Embedded Template Draft'
- description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.'
- operationId: templateCreateEmbeddedDraft
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest'
- examples:
- default_example:
- $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample'
- form_fields_per_document:
- $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample'
- form_field_groups:
- $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample'
- form_field_rules:
- $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest'
+ summary: 'Get Template Files as File Url'
+ description: |-
+ Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a url to the file (PDFs only).
+
+ If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
+ operationId: templateFilesAsFileUrl
+ parameters:
+ -
+ name: template_id
+ in: path
+ description: 'The id of the template files to retrieve.'
+ required: true
+ schema:
+ type: string
+ example: f57db65d3f933b5316d398057a36176831451a35
+ -
+ name: force_download
+ in: query
+ description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
+ schema:
+ type: integer
+ default: 1
responses:
200:
description: 'successful operation'
@@ -5287,10 +5241,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse'
+ $ref: '#/components/schemas/FileResponse'
examples:
default_example:
- $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample'
+ $ref: '#/components/examples/TemplateFilesResponseExample'
4XX:
description: failed_operation
content:
@@ -5310,6 +5264,10 @@ paths:
$ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
+ 422_example:
+ $ref: '#/components/examples/Error422ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -5323,58 +5281,58 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TemplateCreateEmbeddedDraft.php
+ $ref: examples/TemplateFilesAsFileUrl.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateCreateEmbeddedDraft.cs
+ $ref: examples/TemplateFilesAsFileUrl.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateCreateEmbeddedDraft.js
+ $ref: examples/TemplateFilesAsFileUrl.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateCreateEmbeddedDraft.ts
+ $ref: examples/TemplateFilesAsFileUrl.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateCreateEmbeddedDraft.java
+ $ref: examples/TemplateFilesAsFileUrl.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateCreateEmbeddedDraft.rb
+ $ref: examples/TemplateFilesAsFileUrl.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateCreateEmbeddedDraft.py
+ $ref: examples/TemplateFilesAsFileUrl.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateCreateEmbeddedDraft.sh
+ $ref: examples/TemplateFilesAsFileUrl.sh
x-meta:
seo:
- title: 'Create Embedded Template Draft | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.'
- '/template/delete/{template_id}':
- post:
+ title: 'Get Template Files | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.'
+ '/template/{template_id}':
+ get:
tags:
- Template
- summary: 'Delete Template'
- description: 'Completely deletes the template specified from the account.'
- operationId: templateDelete
+ summary: 'Get Template'
+ description: 'Returns the Template specified by the `template_id` parameter.'
+ operationId: templateGet
parameters:
-
name: template_id
in: path
- description: 'The id of the Template to delete.'
+ description: 'The id of the Template to retrieve.'
required: true
schema:
type: string
@@ -5390,7 +5348,12 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/json: {}
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplateGetResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TemplateGetResponseExample'
4XX:
description: failed_operation
content:
@@ -5408,8 +5371,8 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -5423,74 +5386,85 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TemplateDelete.php
+ $ref: examples/TemplateGet.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateDelete.cs
+ $ref: examples/TemplateGet.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateDelete.js
+ $ref: examples/TemplateGet.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateDelete.ts
+ $ref: examples/TemplateGet.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateDelete.java
+ $ref: examples/TemplateGet.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateDelete.rb
+ $ref: examples/TemplateGet.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateDelete.py
+ $ref: examples/TemplateGet.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateDelete.sh
+ $ref: examples/TemplateGet.sh
x-meta:
seo:
- title: 'Delete Template | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.'
- '/template/files/{template_id}':
+ title: 'Get Template | API Documentation | Dropbox Sign for Developers'
+ description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.'
+ /template/list:
get:
tags:
- Template
- summary: 'Get Template Files'
+ summary: 'List Templates'
description: |-
- Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file.
+ Returns a list of the Templates that are accessible by you.
- If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
- operationId: templateFiles
+ Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
+ operationId: templateList
parameters:
-
- name: template_id
- in: path
- description: 'The id of the template files to retrieve.'
- required: true
+ name: account_id
+ in: query
+ description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.'
schema:
type: string
- example: f57db65d3f933b5316d398057a36176831451a35
-
- name: file_type
+ name: page
in: query
- description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.'
+ description: 'Which page number of the Template List to return. Defaults to `1`.'
+ schema:
+ type: integer
+ default: 1
+ -
+ name: page_size
+ in: query
+ description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
+ schema:
+ type: integer
+ default: 20
+ maximum: 100
+ minimum: 1
+ -
+ name: query
+ in: query
+ description: 'String that includes search terms and/or fields to be used to filter the Template objects.'
schema:
type: string
- enum:
- - pdf
- - zip
responses:
200:
description: 'successful operation'
@@ -5502,14 +5476,12 @@ paths:
X-Ratelimit-Reset:
$ref: '#/components/headers/X-Ratelimit-Reset'
content:
- application/pdf:
- schema:
- type: string
- format: binary
- application/zip:
+ application/json:
schema:
- type: string
- format: binary
+ $ref: '#/components/schemas/TemplateListResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TemplateListResponseExample'
4XX:
description: failed_operation
content:
@@ -5525,12 +5497,8 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
- 422_example:
- $ref: '#/components/examples/Error422ResponseExample'
429_example:
$ref: '#/components/examples/Error429ResponseExample'
4XX_example:
@@ -5546,65 +5514,71 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TemplateFiles.php
+ $ref: examples/TemplateList.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateFiles.cs
+ $ref: examples/TemplateList.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateFiles.js
+ $ref: examples/TemplateList.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateFiles.ts
+ $ref: examples/TemplateList.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateFiles.java
+ $ref: examples/TemplateList.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateFiles.rb
+ $ref: examples/TemplateList.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateFiles.py
+ $ref: examples/TemplateList.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateFiles.sh
+ $ref: examples/TemplateList.sh
x-meta:
seo:
- title: 'Get Template Files | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.'
- '/template/files_as_data_uri/{template_id}':
- get:
+ title: 'List Templates | API Documentation | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.'
+ '/template/remove_user/{template_id}':
+ post:
tags:
- Template
- summary: 'Get Template Files as Data Uri'
- description: |-
- Obtain a copy of the current documents specified by the `template_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only).
-
- If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
- operationId: templateFilesAsDataUri
+ summary: 'Remove User from Template'
+ description: 'Removes the specified Account''s access to the specified Template.'
+ operationId: templateRemoveUser
parameters:
-
name: template_id
in: path
- description: 'The id of the template files to retrieve.'
+ description: 'The id of the Template to remove the Account''s access to.'
required: true
schema:
type: string
example: f57db65d3f933b5316d398057a36176831451a35
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplateRemoveUserRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample'
responses:
200:
description: 'successful operation'
@@ -5618,10 +5592,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/FileResponseDataUri'
+ $ref: '#/components/schemas/TemplateGetResponse'
examples:
default_example:
- $ref: '#/components/examples/TemplateFilesResponseExample'
+ $ref: '#/components/examples/TemplateRemoveUserResponseExample'
4XX:
description: failed_operation
content:
@@ -5639,12 +5613,6 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 422_example:
- $ref: '#/components/examples/Error422ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -5658,72 +5626,86 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TemplateFilesAsDataUri.php
+ $ref: examples/TemplateRemoveUser.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateFilesAsDataUri.cs
+ $ref: examples/TemplateRemoveUser.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateFilesAsDataUri.js
+ $ref: examples/TemplateRemoveUser.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateFilesAsDataUri.ts
+ $ref: examples/TemplateRemoveUser.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateFilesAsDataUri.java
+ $ref: examples/TemplateRemoveUser.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateFilesAsDataUri.rb
+ $ref: examples/TemplateRemoveUser.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateFilesAsDataUri.py
+ $ref: examples/TemplateRemoveUser.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateFilesAsDataUri.sh
+ $ref: examples/TemplateRemoveUser.sh
x-meta:
seo:
- title: 'Get Template Files | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.'
- '/template/files_as_file_url/{template_id}':
- get:
- tags:
- - Template
- summary: 'Get Template Files as File Url'
+ title: 'Remove User from Template | REST API | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.'
+ '/template/update_files/{template_id}':
+ post:
+ tags:
+ - Template
+ summary: 'Update Template Files'
description: |-
- 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).
+ Overlays a new file with the overlay of an existing template. The new file(s) must:
- If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
- operationId: templateFilesAsFileUrl
+ 1. have the same or higher page count
+ 2. the same orientation as the file(s) being replaced.
+
+ This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota.
+
+ Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks.
+
+ It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
+
+ If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
+ operationId: templateUpdateFiles
parameters:
-
name: template_id
in: path
- description: 'The id of the template files to retrieve.'
+ description: 'The ID of the template whose files to update.'
required: true
schema:
type: string
example: f57db65d3f933b5316d398057a36176831451a35
- -
- name: force_download
- in: query
- description: 'By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser.'
- schema:
- type: integer
- default: 1
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TemplateUpdateFilesRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/TemplateUpdateFilesRequest'
responses:
200:
description: 'successful operation'
@@ -5737,10 +5719,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/FileResponse'
+ $ref: '#/components/schemas/TemplateUpdateFilesResponse'
examples:
default_example:
- $ref: '#/components/examples/TemplateFilesResponseExample'
+ $ref: '#/components/examples/TemplateUpdateFilesResponseExample'
4XX:
description: failed_operation
content:
@@ -5760,8 +5742,6 @@ paths:
$ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
- 422_example:
- $ref: '#/components/examples/Error422ResponseExample'
429_example:
$ref: '#/components/examples/Error429ResponseExample'
4XX_example:
@@ -5777,62 +5757,71 @@ paths:
lang: PHP
label: PHP
source:
- $ref: examples/TemplateFilesAsFileUrl.php
+ $ref: examples/TemplateUpdateFiles.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateFilesAsFileUrl.cs
+ $ref: examples/TemplateUpdateFiles.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateFilesAsFileUrl.js
+ $ref: examples/TemplateUpdateFiles.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateFilesAsFileUrl.ts
+ $ref: examples/TemplateUpdateFiles.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateFilesAsFileUrl.java
+ $ref: examples/TemplateUpdateFiles.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateFilesAsFileUrl.rb
+ $ref: examples/TemplateUpdateFiles.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateFilesAsFileUrl.py
+ $ref: examples/TemplateUpdateFiles.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateFilesAsFileUrl.sh
+ $ref: examples/TemplateUpdateFiles.sh
x-meta:
seo:
- title: 'Get Template Files | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.'
- '/template/{template_id}':
- get:
+ title: 'Update Template Files | REST API | Dropbox Sign for Developers'
+ description: 'Overlays a new file with the overlay of an existing template'
+ /unclaimed_draft/create:
+ post:
tags:
- - Template
- summary: 'Get Template'
- description: 'Returns the Template specified by the `template_id` parameter.'
- operationId: templateGet
- parameters:
- -
- name: template_id
- in: path
- description: 'The id of the Template to retrieve.'
- required: true
- schema:
- type: string
- example: f57db65d3f933b5316d398057a36176831451a35
+ - 'Unclaimed Draft'
+ summary: 'Create Unclaimed Draft'
+ description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.'
+ operationId: unclaimedDraftCreate
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnclaimedDraftCreateRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample'
+ form_fields_per_document:
+ $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample'
+ form_field_groups:
+ $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample'
+ form_field_rules:
+ $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/UnclaimedDraftCreateRequest'
responses:
200:
description: 'successful operation'
@@ -5846,10 +5835,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateGetResponse'
+ $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
default_example:
- $ref: '#/components/examples/TemplateGetResponseExample'
+ $ref: '#/components/examples/UnclaimedDraftCreateResponseExample'
4XX:
description: failed_operation
content:
@@ -5865,10 +5854,6 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -5876,91 +5861,80 @@ paths:
api_key: []
-
oauth2:
- - template_access
+ - signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TemplateGet.php
+ $ref: examples/UnclaimedDraftCreate.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateGet.cs
+ $ref: examples/UnclaimedDraftCreate.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateGet.js
+ $ref: examples/UnclaimedDraftCreate.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateGet.ts
+ $ref: examples/UnclaimedDraftCreate.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateGet.java
+ $ref: examples/UnclaimedDraftCreate.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateGet.rb
+ $ref: examples/UnclaimedDraftCreate.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateGet.py
+ $ref: examples/UnclaimedDraftCreate.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateGet.sh
+ $ref: examples/UnclaimedDraftCreate.sh
x-meta:
seo:
- title: 'Get Template | API Documentation | Dropbox Sign for Developers'
- description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.'
- /template/list:
- get:
+ title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.'
+ /unclaimed_draft/create_embedded:
+ post:
tags:
- - Template
- summary: 'List Templates'
+ - 'Unclaimed Draft'
+ summary: 'Create Embedded Unclaimed Draft'
description: |-
- Returns a list of the Templates that are accessible by you.
+ 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.
- Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
- operationId: templateList
- parameters:
- -
- name: account_id
- in: query
- description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.'
- schema:
- type: string
- -
- name: page
- in: query
- description: 'Which page number of the Template List to return. Defaults to `1`.'
- schema:
- type: integer
- default: 1
- -
- name: page_size
- in: query
- description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.'
- schema:
- type: integer
- default: 20
- maximum: 100
- minimum: 1
- -
- name: query
- in: query
- description: 'String that includes search terms and/or fields to be used to filter the Template objects.'
- schema:
- type: string
+ **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
+ operationId: unclaimedDraftCreateEmbedded
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample'
+ form_fields_per_document:
+ $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample'
+ form_field_groups:
+ $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample'
+ form_field_rules:
+ $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest'
responses:
200:
description: 'successful operation'
@@ -5974,10 +5948,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateListResponse'
+ $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
default_example:
- $ref: '#/components/examples/TemplateListResponseExample'
+ $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample'
4XX:
description: failed_operation
content:
@@ -5993,10 +5967,10 @@ paths:
$ref: '#/components/examples/Error402ResponseExample'
403_example:
$ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -6004,80 +5978,78 @@ paths:
api_key: []
-
oauth2:
- - template_access
+ - request_signature
+ - signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TemplateList.php
+ $ref: examples/UnclaimedDraftCreateEmbedded.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateList.cs
+ $ref: examples/UnclaimedDraftCreateEmbedded.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateList.js
+ $ref: examples/UnclaimedDraftCreateEmbedded.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateList.ts
+ $ref: examples/UnclaimedDraftCreateEmbedded.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateList.java
+ $ref: examples/UnclaimedDraftCreateEmbedded.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateList.rb
+ $ref: examples/UnclaimedDraftCreateEmbedded.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateList.py
+ $ref: examples/UnclaimedDraftCreateEmbedded.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateList.sh
+ $ref: examples/UnclaimedDraftCreateEmbedded.sh
x-meta:
seo:
- title: 'List Templates | API Documentation | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.'
- '/template/remove_user/{template_id}':
+ title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.'
+ /unclaimed_draft/create_embedded_with_template:
post:
tags:
- - Template
- summary: 'Remove User from Template'
- description: 'Removes the specified Account''s access to the specified Template.'
- operationId: templateRemoveUser
- parameters:
- -
- name: template_id
- in: path
- description: 'The id of the Template to remove the Account''s access to.'
- required: true
- schema:
- type: string
- example: f57db65d3f933b5316d398057a36176831451a35
+ - 'Unclaimed Draft'
+ summary: 'Create Embedded Unclaimed Draft with Template'
+ description: |-
+ Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
+
+ **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
+ operationId: unclaimedDraftCreateEmbeddedWithTemplate
requestBody:
required: true
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateRemoveUserRequest'
+ $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest'
examples:
default_example:
- $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample'
- responses:
- 200:
- description: 'successful operation'
+ $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample'
+ multipart/form-data:
+ schema:
+ $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest'
+ responses:
+ 200:
+ description: 'successful operation'
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
@@ -6088,10 +6060,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateGetResponse'
+ $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
default_example:
- $ref: '#/components/examples/TemplateRemoveUserResponseExample'
+ $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample'
4XX:
description: failed_operation
content:
@@ -6109,6 +6081,10 @@ paths:
$ref: '#/components/examples/Error403ResponseExample'
404_example:
$ref: '#/components/examples/Error404ResponseExample'
+ 409_example:
+ $ref: '#/components/examples/Error409ResponseExample'
+ 429_example:
+ $ref: '#/components/examples/Error429ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -6116,92 +6092,80 @@ paths:
api_key: []
-
oauth2:
- - template_access
+ - signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/TemplateRemoveUser.php
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/TemplateRemoveUser.cs
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/TemplateRemoveUser.js
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/TemplateRemoveUser.ts
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts
-
lang: Java
label: Java
source:
- $ref: examples/TemplateRemoveUser.java
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/TemplateRemoveUser.rb
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb
-
lang: Python
label: Python
source:
- $ref: examples/TemplateRemoveUser.py
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py
-
lang: cURL
label: cURL
source:
- $ref: examples/TemplateRemoveUser.sh
+ $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh
x-meta:
seo:
- title: 'Remove User from Template | REST API | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.'
- '/template/update_files/{template_id}':
+ title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.'
+ '/unclaimed_draft/edit_and_resend/{signature_request_id}':
post:
tags:
- - Template
- summary: 'Update Template Files'
+ - 'Unclaimed Draft'
+ summary: 'Edit and Resend Unclaimed Draft'
description: |-
- Overlays a new file with the overlay of an existing template. The new file(s) must:
-
- 1. have the same or higher page count
- 2. the same orientation as the file(s) being replaced.
-
- This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota.
-
- Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks.
-
- It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.
+ 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.
- If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
- operationId: templateUpdateFiles
+ **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
+ operationId: unclaimedDraftEditAndResend
parameters:
-
- name: template_id
+ name: signature_request_id
in: path
- description: 'The ID of the template whose files to update.'
+ description: 'The ID of the signature request to edit and resend.'
required: true
schema:
type: string
- example: f57db65d3f933b5316d398057a36176831451a35
+ example: fa5c8a0b0f492d768749333ad6fcc214c111e967
requestBody:
required: true
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateUpdateFilesRequest'
+ $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest'
examples:
default_example:
- $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/TemplateUpdateFilesRequest'
+ $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample'
responses:
200:
description: 'successful operation'
@@ -6215,10 +6179,10 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/TemplateUpdateFilesResponse'
+ $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
examples:
default_example:
- $ref: '#/components/examples/TemplateUpdateFilesResponseExample'
+ $ref: '#/components/examples/UnclaimedDraftEditAndResendExample'
4XX:
description: failed_operation
content:
@@ -6238,118 +6202,8 @@ paths:
$ref: '#/components/examples/Error404ResponseExample'
409_example:
$ref: '#/components/examples/Error409ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
- 4XX_example:
- $ref: '#/components/examples/Error4XXResponseExample'
- security:
- -
- api_key: []
- -
- oauth2:
- - template_access
- x-codeSamples:
- -
- lang: PHP
- label: PHP
- source:
- $ref: examples/TemplateUpdateFiles.php
- -
- lang: 'C#'
- label: 'C#'
- source:
- $ref: examples/TemplateUpdateFiles.cs
- -
- lang: JavaScript
- label: JavaScript
- source:
- $ref: examples/TemplateUpdateFiles.js
- -
- lang: TypeScript
- label: TypeScript
- source:
- $ref: examples/TemplateUpdateFiles.ts
- -
- lang: Java
- label: Java
- source:
- $ref: examples/TemplateUpdateFiles.java
- -
- lang: Ruby
- label: Ruby
- source:
- $ref: examples/TemplateUpdateFiles.rb
- -
- lang: Python
- label: Python
- source:
- $ref: examples/TemplateUpdateFiles.py
- -
- lang: cURL
- label: cURL
- source:
- $ref: examples/TemplateUpdateFiles.sh
- x-meta:
- seo:
- title: 'Update Template Files | REST API | Dropbox Sign for Developers'
- description: 'Overlays a new file with the overlay of an existing template'
- /unclaimed_draft/create:
- post:
- tags:
- - 'Unclaimed Draft'
- summary: 'Create Unclaimed Draft'
- description: 'Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the "Sign and send" or the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.'
- operationId: unclaimedDraftCreate
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample'
- form_fields_per_document:
- $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample'
- form_field_groups:
- $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample'
- form_field_rules:
- $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateRequest'
- responses:
- 200:
- description: 'successful operation'
- headers:
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-Ratelimit-Reset:
- $ref: '#/components/headers/X-Ratelimit-Reset'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftCreateResponseExample'
- 4XX:
- description: failed_operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- examples:
- 400_example:
- $ref: '#/components/examples/Error400ResponseExample'
- 401_example:
- $ref: '#/components/examples/Error401ResponseExample'
- 402_example:
- $ref: '#/components/examples/Error402ResponseExample'
- 403_example:
- $ref: '#/components/examples/Error403ResponseExample'
+ 410_example:
+ $ref: '#/components/examples/Error410ResponseExample'
4XX_example:
$ref: '#/components/examples/Error4XXResponseExample'
security:
@@ -6357,957 +6211,305 @@ paths:
api_key: []
-
oauth2:
+ - request_signature
- signature_request_access
x-codeSamples:
-
lang: PHP
label: PHP
source:
- $ref: examples/UnclaimedDraftCreate.php
+ $ref: examples/UnclaimedDraftEditAndResend.php
-
lang: 'C#'
label: 'C#'
source:
- $ref: examples/UnclaimedDraftCreate.cs
+ $ref: examples/UnclaimedDraftEditAndResend.cs
-
lang: JavaScript
label: JavaScript
source:
- $ref: examples/UnclaimedDraftCreate.js
+ $ref: examples/UnclaimedDraftEditAndResend.js
-
lang: TypeScript
label: TypeScript
source:
- $ref: examples/UnclaimedDraftCreate.ts
+ $ref: examples/UnclaimedDraftEditAndResend.ts
-
lang: Java
label: Java
source:
- $ref: examples/UnclaimedDraftCreate.java
+ $ref: examples/UnclaimedDraftEditAndResend.java
-
lang: Ruby
label: Ruby
source:
- $ref: examples/UnclaimedDraftCreate.rb
+ $ref: examples/UnclaimedDraftEditAndResend.rb
-
lang: Python
label: Python
source:
- $ref: examples/UnclaimedDraftCreate.py
+ $ref: examples/UnclaimedDraftEditAndResend.py
-
lang: cURL
label: cURL
source:
- $ref: examples/UnclaimedDraftCreate.sh
+ $ref: examples/UnclaimedDraftEditAndResend.sh
x-meta:
seo:
- title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.'
- /unclaimed_draft/create_embedded:
- post:
- tags:
- - 'Unclaimed Draft'
- summary: 'Create Embedded Unclaimed Draft'
- description: |-
- Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
+ title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers'
+ description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.'
+components:
+ schemas:
+ AccountCreateRequest:
+ required:
+ - email_address
+ properties:
+ client_id:
+ description: |-
+ Used when creating a new account with OAuth authorization.
- **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
- operationId: unclaimedDraftCreateEmbedded
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample'
- form_fields_per_document:
- $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample'
- form_field_groups:
- $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample'
- form_field_rules:
- $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest'
- responses:
- 200:
- description: 'successful operation'
- headers:
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-Ratelimit-Reset:
- $ref: '#/components/headers/X-Ratelimit-Reset'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample'
- 4XX:
- description: failed_operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- examples:
- 400_example:
- $ref: '#/components/examples/Error400ResponseExample'
- 401_example:
- $ref: '#/components/examples/Error401ResponseExample'
- 402_example:
- $ref: '#/components/examples/Error402ResponseExample'
- 403_example:
- $ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 4XX_example:
- $ref: '#/components/examples/Error4XXResponseExample'
- security:
- -
- api_key: []
- -
- oauth2:
- - request_signature
- - signature_request_access
- x-codeSamples:
- -
- lang: PHP
- label: PHP
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.php
- -
- lang: 'C#'
- label: 'C#'
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.cs
- -
- lang: JavaScript
- label: JavaScript
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.js
- -
- lang: TypeScript
- label: TypeScript
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.ts
- -
- lang: Java
- label: Java
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.java
- -
- lang: Ruby
- label: Ruby
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.rb
- -
- lang: Python
- label: Python
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.py
- -
- lang: cURL
- label: cURL
- source:
- $ref: examples/UnclaimedDraftCreateEmbedded.sh
- x-meta:
- seo:
- title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.'
- /unclaimed_draft/create_embedded_with_template:
- post:
- tags:
- - 'Unclaimed Draft'
- summary: 'Create Embedded Unclaimed Draft with Template'
- description: |-
- Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the "Request signature" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.
-
- **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
- operationId: unclaimedDraftCreateEmbeddedWithTemplate
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample'
- multipart/form-data:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest'
- responses:
- 200:
- description: 'successful operation'
- headers:
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-Ratelimit-Reset:
- $ref: '#/components/headers/X-Ratelimit-Reset'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample'
- 4XX:
- description: failed_operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- examples:
- 400_example:
- $ref: '#/components/examples/Error400ResponseExample'
- 401_example:
- $ref: '#/components/examples/Error401ResponseExample'
- 402_example:
- $ref: '#/components/examples/Error402ResponseExample'
- 403_example:
- $ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 429_example:
- $ref: '#/components/examples/Error429ResponseExample'
- 4XX_example:
- $ref: '#/components/examples/Error4XXResponseExample'
- security:
- -
- api_key: []
- -
- oauth2:
- - signature_request_access
- x-codeSamples:
- -
- lang: PHP
- label: PHP
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php
- -
- lang: 'C#'
- label: 'C#'
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs
- -
- lang: JavaScript
- label: JavaScript
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js
- -
- lang: TypeScript
- label: TypeScript
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts
- -
- lang: Java
- label: Java
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java
- -
- lang: Ruby
- label: Ruby
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb
- -
- lang: Python
- label: Python
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py
- -
- lang: cURL
- label: cURL
- source:
- $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh
- x-meta:
- seo:
- title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.'
- '/unclaimed_draft/edit_and_resend/{signature_request_id}':
- post:
- tags:
- - 'Unclaimed Draft'
- summary: 'Edit and Resend Unclaimed Draft'
- description: |-
- Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set.
-
- **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign.
- operationId: unclaimedDraftEditAndResend
- parameters:
- -
- name: signature_request_id
- in: path
- description: 'The ID of the signature request to edit and resend.'
- required: true
- schema:
- type: string
- example: fa5c8a0b0f492d768749333ad6fcc214c111e967
- requestBody:
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample'
- responses:
- 200:
- description: 'successful operation'
- headers:
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-Ratelimit-Reset:
- $ref: '#/components/headers/X-Ratelimit-Reset'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UnclaimedDraftCreateResponse'
- examples:
- default_example:
- $ref: '#/components/examples/UnclaimedDraftEditAndResendExample'
- 4XX:
- description: failed_operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ErrorResponse'
- examples:
- 400_example:
- $ref: '#/components/examples/Error400ResponseExample'
- 401_example:
- $ref: '#/components/examples/Error401ResponseExample'
- 402_example:
- $ref: '#/components/examples/Error402ResponseExample'
- 403_example:
- $ref: '#/components/examples/Error403ResponseExample'
- 404_example:
- $ref: '#/components/examples/Error404ResponseExample'
- 409_example:
- $ref: '#/components/examples/Error409ResponseExample'
- 410_example:
- $ref: '#/components/examples/Error410ResponseExample'
- 4XX_example:
- $ref: '#/components/examples/Error4XXResponseExample'
- security:
- -
- api_key: []
- -
- oauth2:
- - request_signature
- - signature_request_access
- x-codeSamples:
- -
- lang: PHP
- label: PHP
- source:
- $ref: examples/UnclaimedDraftEditAndResend.php
- -
- lang: 'C#'
- label: 'C#'
- source:
- $ref: examples/UnclaimedDraftEditAndResend.cs
- -
- lang: JavaScript
- label: JavaScript
- source:
- $ref: examples/UnclaimedDraftEditAndResend.js
- -
- lang: TypeScript
- label: TypeScript
- source:
- $ref: examples/UnclaimedDraftEditAndResend.ts
- -
- lang: Java
- label: Java
- source:
- $ref: examples/UnclaimedDraftEditAndResend.java
- -
- lang: Ruby
- label: Ruby
- source:
- $ref: examples/UnclaimedDraftEditAndResend.rb
- -
- lang: Python
- label: Python
- source:
- $ref: examples/UnclaimedDraftEditAndResend.py
- -
- lang: cURL
- label: cURL
- source:
- $ref: examples/UnclaimedDraftEditAndResend.sh
- x-meta:
- seo:
- title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers'
- description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.'
-components:
- schemas:
- AccountCreateRequest:
- required:
- - email_address
- properties:
- client_id:
- description: |-
- Used when creating a new account with OAuth authorization.
-
- See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
- type: string
- client_secret:
- description: |-
- Used when creating a new account with OAuth authorization.
-
- See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
- type: string
- email_address:
- description: 'The email address which will be associated with the new Account.'
- type: string
- format: email
- locale:
- description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.'
- type: string
- type: object
- AccountUpdateRequest:
- properties:
- account_id:
- description: 'The ID of the Account'
- type: string
- nullable: true
- callback_url:
- description: 'The URL that Dropbox Sign should POST events to.'
- type: string
- locale:
- description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.'
- type: string
- type: object
- AccountVerifyRequest:
- required:
- - email_address
- properties:
- email_address:
- description: 'Email address to run the verification for.'
- type: string
- format: email
- type: object
- ApiAppCreateRequest:
- required:
- - name
- - domains
- properties:
- callback_url:
- description: 'The URL at which the ApiApp should receive event callbacks.'
- type: string
- custom_logo_file:
- description: 'An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)'
- type: string
- format: binary
- domains:
- description: 'The domain names the ApiApp will be associated with.'
- type: array
- items:
- type: string
- maxItems: 2
- minItems: 1
- name:
- description: 'The name you want to assign to the ApiApp.'
- type: string
- oauth:
- $ref: '#/components/schemas/SubOAuth'
- options:
- $ref: '#/components/schemas/SubOptions'
- white_labeling_options:
- $ref: '#/components/schemas/SubWhiteLabelingOptions'
- type: object
- ApiAppUpdateRequest:
- properties:
- callback_url:
- description: 'The URL at which the API App should receive event callbacks.'
- type: string
- custom_logo_file:
- description: 'An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)'
- type: string
- format: binary
- domains:
- description: 'The domain names the ApiApp will be associated with.'
- type: array
- items:
- type: string
- maxItems: 2
- name:
- description: 'The name you want to assign to the ApiApp.'
- type: string
- oauth:
- $ref: '#/components/schemas/SubOAuth'
- options:
- $ref: '#/components/schemas/SubOptions'
- white_labeling_options:
- $ref: '#/components/schemas/SubWhiteLabelingOptions'
- type: object
- EmbeddedEditUrlRequest:
- properties:
- allow_edit_ccs:
- description: 'This allows the requester to enable/disable to add or change CC roles when editing the template.'
- type: boolean
- default: false
- cc_roles:
- description: 'The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.'
- type: array
- items:
- type: string
- editor_options:
- $ref: '#/components/schemas/SubEditorOptions'
- force_signer_roles:
- description: 'Provide users the ability to review/edit the template signer roles.'
- type: boolean
- default: false
- force_subject_message:
- description: 'Provide users the ability to review/edit the template subject and message.'
- type: boolean
- default: false
- merge_fields:
- description: |-
- Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.
-
- Remove all merge fields on the template by passing an empty array `[]`.
- type: array
- items:
- $ref: '#/components/schemas/SubMergeField'
- preview_only:
- description: |-
- This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
-
- **Note**: This parameter overwrites `show_preview=true` (if set).
- type: boolean
- default: false
- show_preview:
- description: 'This allows the requester to enable the editor/preview experience.'
- type: boolean
- default: false
- show_progress_stepper:
- description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.'
- type: boolean
- default: true
- test_mode:
- description: 'Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.'
- type: boolean
- default: false
- type: object
- OAuthTokenGenerateRequest:
- required:
- - client_id
- - client_secret
- - code
- - state
- - grant_type
- properties:
- client_id:
- description: 'The client id of the app requesting authorization.'
- type: string
- client_secret:
- description: 'The secret token of your app.'
- type: string
- code:
- description: 'The code passed to your callback when the user granted access.'
- type: string
- grant_type:
- description: 'When generating a new token use `authorization_code`.'
- type: string
- default: authorization_code
- state:
- description: 'Same as the state you specified earlier.'
- type: string
- type: object
- OAuthTokenRefreshRequest:
- required:
- - grant_type
- - refresh_token
- properties:
- grant_type:
- description: 'When refreshing an existing token use `refresh_token`.'
- type: string
- default: refresh_token
- refresh_token:
- description: 'The token provided when you got the expired access token.'
- type: string
- type: object
- ReportCreateRequest:
- required:
- - start_date
- - end_date
- - report_type
- properties:
- end_date:
- description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.'
- type: string
- report_type:
- description: 'The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).'
- type: array
- items:
- type: string
- enum:
- - user_activity
- - document_status
- maxItems: 2
- minItems: 1
- start_date:
- description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.'
- type: string
- type: object
- SignatureRequestBulkCreateEmbeddedWithTemplateRequest:
- required:
- - client_id
- - template_ids
- properties:
- template_ids:
- description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.'
- type: array
- items:
- type: string
- signer_file:
- description: |-
- `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
-
- - `name`: the name of the signer filling the role of RoleName
- - `email_address`: email address of the signer filling the role of RoleName
- - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
- - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
-
- By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
-
- **Note**: Not available in test mode and requires a Standard plan or higher.
- - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
-
- You may only specify field values here, any other options should be set in the custom_fields request parameter.
-
- Example CSV:
-
- ```
- name, email_address, pin, company_field
- George, george@example.com, d79a3td, ABC Corp
- Mary, mary@example.com, gd9as5b, 123 LLC
- ```
- type: string
- format: binary
- signer_list:
- description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.'
- type: array
- items:
- $ref: '#/components/schemas/SubBulkSignerList'
- allow_decline:
- description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.'
- type: boolean
- default: false
- ccs:
- description: 'Add CC email recipients. Required when a CC role exists for the Template.'
- type: array
- items:
- $ref: '#/components/schemas/SubCC'
- client_id:
- description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.'
- type: string
- custom_fields:
- description: |-
- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
-
- Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
-
- For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
- type: array
- items:
- $ref: '#/components/schemas/SubCustomField'
- message:
- description: 'The custom message in the email that will be sent to the signers.'
- type: string
- maxLength: 5000
- metadata:
- description: |-
- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
-
- Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
- type: object
- maxItems: 10
- additionalProperties: {}
- signing_redirect_url:
- description: 'The URL you want signers redirected to after they successfully sign.'
- type: string
- subject:
- description: 'The subject in the email that will be sent to the signers.'
- type: string
- maxLength: 255
- test_mode:
- description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.'
- type: boolean
- default: false
- title:
- description: 'The title you want to assign to the SignatureRequest.'
- type: string
- maxLength: 255
- type: object
- SignatureRequestBulkSendWithTemplateRequest:
- required:
- - template_ids
- properties:
- template_ids:
- description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.'
- type: array
- items:
- type: string
- signer_file:
- description: |-
- `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
-
- - `name`: the name of the signer filling the role of RoleName
- - `email_address`: email address of the signer filling the role of RoleName
- - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
- - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
-
- By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
-
- **Note**: Not available in test mode and requires a Standard plan or higher.
- - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
-
- You may only specify field values here, any other options should be set in the custom_fields request parameter.
-
- Example CSV:
-
- ```
- name, email_address, pin, company_field
- George, george@example.com, d79a3td, ABC Corp
- Mary, mary@example.com, gd9as5b, 123 LLC
- ```
- type: string
- format: binary
- signer_list:
- description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.'
- type: array
- items:
- $ref: '#/components/schemas/SubBulkSignerList'
- allow_decline:
- description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.'
- type: boolean
- default: false
- ccs:
- description: 'Add CC email recipients. Required when a CC role exists for the Template.'
- type: array
- items:
- $ref: '#/components/schemas/SubCC'
- client_id:
- description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.'
- type: string
- custom_fields:
- description: |-
- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
-
- Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
-
- For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
- type: array
- items:
- $ref: '#/components/schemas/SubCustomField'
- message:
- description: 'The custom message in the email that will be sent to the signers.'
+ See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
type: string
- maxLength: 5000
- metadata:
+ client_secret:
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.
+ Used when creating a new account with OAuth authorization.
- Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
- type: object
- maxItems: 10
- additionalProperties: {}
- signing_redirect_url:
- description: 'The URL you want signers redirected to after they successfully sign.'
+ See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization)
type: string
- subject:
- description: 'The subject in the email that will be sent to the signers.'
+ email_address:
+ description: 'The email address which will be associated with the new Account.'
type: string
- maxLength: 255
- test_mode:
- description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.'
- type: boolean
- default: false
- title:
- description: 'The title you want to assign to the SignatureRequest.'
+ format: email
+ locale:
+ description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.'
type: string
- maxLength: 255
type: object
- SignatureRequestCreateEmbeddedRequest:
+ AccountUpdateRequest:
+ properties:
+ account_id:
+ description: 'The ID of the Account'
+ type: string
+ nullable: true
+ callback_url:
+ description: 'The URL that Dropbox Sign should POST events to.'
+ type: string
+ locale:
+ description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.'
+ type: string
+ type: object
+ AccountVerifyRequest:
required:
- - client_id
+ - email_address
properties:
- files:
- description: |-
- Use `files[]` to indicate the uploaded file(s) to send for signature.
-
- This endpoint requires either **files** or **file_urls[]**, but not both.
+ email_address:
+ description: 'Email address to run the verification for.'
+ type: string
+ format: email
+ type: object
+ ApiAppCreateRequest:
+ required:
+ - name
+ - domains
+ properties:
+ callback_url:
+ description: 'The URL at which the ApiApp should receive event callbacks.'
+ type: string
+ custom_logo_file:
+ description: 'An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)'
+ type: string
+ format: binary
+ domains:
+ description: 'The domain names the ApiApp will be associated with.'
type: array
items:
type: string
- format: binary
- file_urls:
- description: |-
- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
-
- This endpoint requires either **files** or **file_urls[]**, but not both.
+ maxItems: 2
+ minItems: 1
+ name:
+ description: 'The name you want to assign to the ApiApp.'
+ type: string
+ oauth:
+ $ref: '#/components/schemas/SubOAuth'
+ options:
+ $ref: '#/components/schemas/SubOptions'
+ white_labeling_options:
+ $ref: '#/components/schemas/SubWhiteLabelingOptions'
+ type: object
+ ApiAppUpdateRequest:
+ properties:
+ callback_url:
+ description: 'The URL at which the API App should receive event callbacks.'
+ type: string
+ custom_logo_file:
+ description: 'An image file to use as a custom logo in embedded contexts. (Only applies to some API plans)'
+ type: string
+ format: binary
+ domains:
+ description: 'The domain names the ApiApp will be associated with.'
type: array
items:
type: string
- signers:
- description: |-
- Add Signers to your Signature Request.
-
- This endpoint requires either **signers** or **grouped_signers**, but not both.
- type: array
- items:
- $ref: '#/components/schemas/SubSignatureRequestSigner'
- grouped_signers:
- description: |-
- Add Grouped Signers to your Signature Request.
-
- This endpoint requires either **signers** or **grouped_signers**, but not both.
+ maxItems: 2
+ name:
+ description: 'The name you want to assign to the ApiApp.'
+ type: string
+ oauth:
+ $ref: '#/components/schemas/SubOAuth'
+ options:
+ $ref: '#/components/schemas/SubOptions'
+ white_labeling_options:
+ $ref: '#/components/schemas/SubWhiteLabelingOptions'
+ type: object
+ EmbeddedEditUrlRequest:
+ properties:
+ allow_edit_ccs:
+ description: 'This allows the requester to enable/disable to add or change CC roles when editing the template.'
+ type: boolean
+ default: false
+ cc_roles:
+ description: 'The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.'
type: array
items:
- $ref: '#/components/schemas/SubSignatureRequestGroupedSigners'
- allow_decline:
- description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.'
+ type: string
+ editor_options:
+ $ref: '#/components/schemas/SubEditorOptions'
+ force_signer_roles:
+ description: 'Provide users the ability to review/edit the template signer roles.'
type: boolean
default: false
- allow_reassign:
- description: |-
- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
-
- **Note**: Only available for Premium plan.
+ force_subject_message:
+ description: 'Provide users the ability to review/edit the template subject and message.'
type: boolean
default: false
- attachments:
- description: 'A list describing the attachments'
- type: array
- items:
- $ref: '#/components/schemas/SubAttachment'
- cc_email_addresses:
- description: 'The email addresses that should be CCed.'
- type: array
- items:
- type: string
- format: email
- client_id:
- description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.'
- type: string
- custom_fields:
- description: |-
- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
-
- Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
-
- For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
- type: array
- items:
- $ref: '#/components/schemas/SubCustomField'
- field_options:
- $ref: '#/components/schemas/SubFieldOptions'
- form_field_groups:
- description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.'
- type: array
- items:
- $ref: '#/components/schemas/SubFormFieldGroup'
- form_field_rules:
- description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.'
- type: array
- items:
- $ref: '#/components/schemas/SubFormFieldRule'
- form_fields_per_document:
+ merge_fields:
description: |-
- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
-
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ 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.
- * Text Field use `SubFormFieldsPerDocumentText`
- * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
- * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
- * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
- * Radio Field use `SubFormFieldsPerDocumentRadio`
- * Signature Field use `SubFormFieldsPerDocumentSignature`
- * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
- * Initials Field use `SubFormFieldsPerDocumentInitials`
- * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
- * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
+ Remove all merge fields on the template by passing an empty array `[]`.
type: array
items:
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
- hide_text_tags:
+ $ref: '#/components/schemas/SubMergeField'
+ preview_only:
description: |-
- Enables automatic Text Tag removal when set to true.
+ This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
- **NOTE**: 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.
+ **NOTE:** This parameter overwrites `show_preview=true` (if set).
type: boolean
default: false
- message:
- description: 'The custom message in the email that will be sent to the signers.'
+ show_preview:
+ description: 'This allows the requester to enable the editor/preview experience.'
+ type: boolean
+ default: false
+ show_progress_stepper:
+ description: 'When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.'
+ type: boolean
+ default: true
+ test_mode:
+ description: 'Whether this is a test, locked templates will only be available for editing if this is set to `true`. Defaults to `false`.'
+ type: boolean
+ default: false
+ type: object
+ OAuthTokenGenerateRequest:
+ required:
+ - client_id
+ - client_secret
+ - code
+ - state
+ - grant_type
+ properties:
+ client_id:
+ description: 'The client id of the app requesting authorization.'
type: string
- maxLength: 5000
- metadata:
- description: |-
- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
-
- Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
- type: object
- maxItems: 10
- additionalProperties: {}
- signing_options:
- $ref: '#/components/schemas/SubSigningOptions'
- subject:
- description: 'The subject in the email that will be sent to the signers.'
+ client_secret:
+ description: 'The secret token of your app.'
+ type: string
+ code:
+ description: 'The code passed to your callback when the user granted access.'
+ type: string
+ grant_type:
+ description: 'When generating a new token use `authorization_code`.'
+ type: string
+ default: authorization_code
+ state:
+ description: 'Same as the state you specified earlier.'
+ type: string
+ type: object
+ OAuthTokenRefreshRequest:
+ required:
+ - grant_type
+ - refresh_token
+ properties:
+ grant_type:
+ description: 'When refreshing an existing token use `refresh_token`.'
type: string
- maxLength: 255
- test_mode:
- description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.'
- type: boolean
- default: false
- title:
- description: 'The title you want to assign to the SignatureRequest.'
+ default: refresh_token
+ refresh_token:
+ description: 'The token provided when you got the expired access token.'
type: string
- maxLength: 255
- use_text_tags:
- description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.'
- type: boolean
- default: false
- populate_auto_fill_fields:
- description: |-
- Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
-
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
- type: boolean
- default: false
- expires_at:
- description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
- type: integer
- nullable: true
type: object
- SignatureRequestCreateEmbeddedWithTemplateRequest:
+ ReportCreateRequest:
+ required:
+ - start_date
+ - end_date
+ - report_type
+ properties:
+ end_date:
+ description: 'The (inclusive) end date for the report data in `MM/DD/YYYY` format.'
+ type: string
+ report_type:
+ description: 'The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status).'
+ type: array
+ items:
+ type: string
+ enum:
+ - user_activity
+ - document_status
+ maxItems: 2
+ minItems: 1
+ start_date:
+ description: 'The (inclusive) start date for the report data in `MM/DD/YYYY` format.'
+ type: string
+ type: object
+ SignatureRequestBulkCreateEmbeddedWithTemplateRequest:
required:
- client_id
- template_ids
- - signers
properties:
template_ids:
description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.'
type: array
items:
type: string
+ signer_file:
+ description: |-
+ `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
+
+ - `name`: the name of the signer filling the role of RoleName
+ - `email_address`: email address of the signer filling the role of RoleName
+ - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
+ - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
+
+ By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
+
+ **NOTE:** Not available in test mode and requires a Standard plan or higher.
+ - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
+
+ You may only specify field values here, any other options should be set in the custom_fields request parameter.
+
+ Example CSV:
+
+ ```
+ name, email_address, pin, company_field
+ George, george@example.com, d79a3td, ABC Corp
+ Mary, mary@example.com, gd9as5b, 123 LLC
+ ```
+ type: string
+ format: binary
+ signer_list:
+ description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.'
+ type: array
+ items:
+ $ref: '#/components/schemas/SubBulkSignerList'
allow_decline:
description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.'
type: boolean
@@ -7321,27 +6523,15 @@ components:
description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.'
type: string
custom_fields:
- description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.'
- type: array
- items:
- $ref: '#/components/schemas/SubCustomField'
- files:
description: |-
- Use `files[]` to indicate the uploaded file(s) to send for signature.
+ When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
- This endpoint requires either **files** or **file_urls[]**, but not both.
- type: array
- items:
- type: string
- format: binary
- file_urls:
- description: |-
- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
+ Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
- This endpoint requires either **files** or **file_urls[]**, but not both.
+ For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
type: array
items:
- type: string
+ $ref: '#/components/schemas/SubCustomField'
message:
description: 'The custom message in the email that will be sent to the signers.'
type: string
@@ -7354,13 +6544,9 @@ components:
type: object
maxItems: 10
additionalProperties: {}
- signers:
- description: 'Add Signers to your Templated-based Signature Request.'
- type: array
- items:
- $ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
- signing_options:
- $ref: '#/components/schemas/SubSigningOptions'
+ signing_redirect_url:
+ description: 'The URL you want signers redirected to after they successfully sign.'
+ type: string
subject:
description: 'The subject in the email that will be sent to the signers.'
type: string
@@ -7373,141 +6559,68 @@ components:
description: 'The title you want to assign to the SignatureRequest.'
type: string
maxLength: 255
- populate_auto_fill_fields:
- description: |-
- Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
-
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
- type: boolean
- default: false
type: object
- SignatureRequestEditRequest:
+ SignatureRequestBulkSendWithTemplateRequest:
+ required:
+ - template_ids
properties:
- files:
- description: |-
- Use `files[]` to indicate the uploaded file(s) to send for signature.
-
- This endpoint requires either **files** or **file_urls[]**, but not both.
+ template_ids:
+ description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.'
type: array
items:
type: string
- format: binary
- file_urls:
+ signer_file:
description: |-
- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
+ `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:
- This endpoint requires either **files** or **file_urls[]**, but not both.
- type: array
- items:
- type: string
- signers:
- description: |-
- Add Signers to your Signature Request.
+ - `name`: the name of the signer filling the role of RoleName
+ - `email_address`: email address of the signer filling the role of RoleName
+ - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional)
+ - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
- This endpoint requires either **signers** or **grouped_signers**, but not both.
- type: array
- items:
- $ref: '#/components/schemas/SubSignatureRequestSigner'
- grouped_signers:
- description: |-
- Add Grouped Signers to your Signature Request.
+ 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).
- This endpoint requires either **signers** or **grouped_signers**, but not both.
+ **NOTE:** Not available in test mode and requires a Standard plan or higher.
+ - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
+
+ You may only specify field values here, any other options should be set in the custom_fields request parameter.
+
+ Example CSV:
+
+ ```
+ name, email_address, pin, company_field
+ George, george@example.com, d79a3td, ABC Corp
+ Mary, mary@example.com, gd9as5b, 123 LLC
+ ```
+ type: string
+ format: binary
+ signer_list:
+ description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.'
type: array
items:
- $ref: '#/components/schemas/SubSignatureRequestGroupedSigners'
+ $ref: '#/components/schemas/SubBulkSignerList'
allow_decline:
description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.'
type: boolean
default: false
- allow_reassign:
- description: |-
- Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
-
- **Note**: Only available for Premium plan and higher.
- type: boolean
- default: false
- attachments:
- description: 'A list describing the attachments'
- type: array
- items:
- $ref: '#/components/schemas/SubAttachment'
- cc_email_addresses:
- description: 'The email addresses that should be CCed.'
+ ccs:
+ description: 'Add CC email recipients. Required when a CC role exists for the Template.'
type: array
items:
- type: string
- format: email
+ $ref: '#/components/schemas/SubCC'
client_id:
- description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.'
- type: string
- custom_fields:
- description: |-
- When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
-
- Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
-
- For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
- type: array
- items:
- $ref: '#/components/schemas/SubCustomField'
- field_options:
- $ref: '#/components/schemas/SubFieldOptions'
- form_field_groups:
- description: 'Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.'
- type: array
- items:
- $ref: '#/components/schemas/SubFormFieldGroup'
- form_field_rules:
- description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.'
- type: array
- items:
- $ref: '#/components/schemas/SubFormFieldRule'
- form_fields_per_document:
- description: |-
- The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
-
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
-
- * Text Field use `SubFormFieldsPerDocumentText`
- * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
- * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`
- * Checkbox Field use `SubFormFieldsPerDocumentCheckbox`
- * Radio Field use `SubFormFieldsPerDocumentRadio`
- * Signature Field use `SubFormFieldsPerDocumentSignature`
- * Date Signed Field use `SubFormFieldsPerDocumentDateSigned`
- * Initials Field use `SubFormFieldsPerDocumentInitials`
- * Text Merge Field use `SubFormFieldsPerDocumentTextMerge`
- * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
- type: array
- items:
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
- hide_text_tags:
- description: |-
- Enables automatic Text Tag removal when set to true.
-
- **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
- type: boolean
- default: false
- is_qualified_signature:
- description: |-
- Send with a value of `true` if you wish to enable
- [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
- which requires a face-to-face call to verify the signer's identity.
- **Note**: QES is only available on the Premium API plan as an add-on purchase.
- Cannot be used in `test_mode`. Only works on requests with one signer.
- type: boolean
- default: false
- deprecated: true
- x-hideOn: doc
- is_eid:
- description: |-
- Send with a value of `true` if you wish to enable
- [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
- which requires the signer to verify their identity with an eID provider to sign a document.
- **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
- type: boolean
- default: false
+ description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.'
+ type: string
+ custom_fields:
+ description: |-
+ When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
+
+ Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.
+
+ For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
+ type: array
+ items:
+ $ref: '#/components/schemas/SubCustomField'
message:
description: 'The custom message in the email that will be sent to the signers.'
type: string
@@ -7520,8 +6633,6 @@ components:
type: object
maxItems: 10
additionalProperties: {}
- signing_options:
- $ref: '#/components/schemas/SubSigningOptions'
signing_redirect_url:
description: 'The URL you want signers redirected to after they successfully sign.'
type: string
@@ -7537,16 +6648,8 @@ components:
description: 'The title you want to assign to the SignatureRequest.'
type: string
maxLength: 255
- use_text_tags:
- description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.'
- type: boolean
- default: false
- expires_at:
- description: 'When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.'
- type: integer
- nullable: true
type: object
- SignatureRequestEditEmbeddedRequest:
+ SignatureRequestCreateEmbeddedRequest:
required:
- client_id
properties:
@@ -7591,7 +6694,7 @@ components:
description: |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
- **Note**: Only available for Premium plan.
+ **NOTE:** Only available for Premium plan.
type: boolean
default: false
attachments:
@@ -7634,7 +6737,7 @@ components:
description: |-
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -7653,7 +6756,7 @@ components:
description: |-
Enables automatic Text Tag removal when set to true.
- **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
+ **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
type: boolean
default: false
message:
@@ -7690,7 +6793,7 @@ components:
description: |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
+ **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
expires_at:
@@ -7698,7 +6801,7 @@ components:
type: integer
nullable: true
type: object
- SignatureRequestEditEmbeddedWithTemplateRequest:
+ SignatureRequestCreateEmbeddedWithTemplateRequest:
required:
- client_id
- template_ids
@@ -7778,108 +6881,9 @@ components:
description: |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
- type: boolean
- default: false
- type: object
- SignatureRequestEditWithTemplateRequest:
- description: ''
- required:
- - signers
- - template_ids
- properties:
- template_ids:
- description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.'
- type: array
- items:
- type: string
- allow_decline:
- description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.'
- type: boolean
- default: false
- ccs:
- description: 'Add CC email recipients. Required when a CC role exists for the Template.'
- type: array
- items:
- $ref: '#/components/schemas/SubCC'
- client_id:
- description: 'Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.'
- type: string
- custom_fields:
- description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.'
- type: array
- items:
- $ref: '#/components/schemas/SubCustomField'
- files:
- description: |-
- Use `files[]` to indicate the uploaded file(s) to send for signature.
-
- This endpoint requires either **files** or **file_urls[]**, but not both.
- type: array
- items:
- type: string
- format: binary
- file_urls:
- description: |-
- Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.
-
- This endpoint requires either **files** or **file_urls[]**, but not both.
- type: array
- items:
- type: string
- is_qualified_signature:
- description: |-
- Send with a value of `true` if you wish to enable
- [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
- which requires a face-to-face call to verify the signer's identity.
- **Note**: QES is only available on the Premium API plan as an add-on purchase.
- Cannot be used in `test_mode`. Only works on requests with one signer.
- type: boolean
- default: false
- deprecated: true
- x-hideOn: doc
- is_eid:
- description: |-
- Send with a value of `true` if you wish to enable
- [electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
- which requires the signer to verify their identity with an eID provider to sign a document.
- **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
- type: boolean
- default: false
- message:
- description: 'The custom message in the email that will be sent to the signers.'
- type: string
- maxLength: 5000
- metadata:
- description: |-
- Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.
-
- Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
- type: object
- maxItems: 10
- additionalProperties: {}
- signers:
- description: 'Add Signers to your Templated-based Signature Request.'
- type: array
- items:
- $ref: '#/components/schemas/SubSignatureRequestTemplateSigner'
- signing_options:
- $ref: '#/components/schemas/SubSigningOptions'
- signing_redirect_url:
- description: 'The URL you want signers redirected to after they successfully sign.'
- type: string
- subject:
- description: 'The subject in the email that will be sent to the signers.'
- type: string
- maxLength: 255
- test_mode:
- description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.'
+ **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
- title:
- description: 'The title you want to assign to the SignatureRequest.'
- type: string
- maxLength: 255
type: object
SignatureRequestRemindRequest:
required:
@@ -7936,7 +6940,7 @@ components:
description: |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
- **Note**: Only available for Premium plan and higher.
+ **NOTE:** Only available for Premium plan and higher.
type: boolean
default: false
attachments:
@@ -7979,7 +6983,7 @@ components:
description: |-
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -7998,7 +7002,7 @@ components:
description: |-
Enables automatic Text Tag removal when set to true.
- **NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
+ **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.
type: boolean
default: false
is_qualified_signature:
@@ -8006,7 +7010,7 @@ components:
Send with a value of `true` if you wish to enable
[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
which requires a face-to-face call to verify the signer's identity.
- **Note**: QES is only available on the Premium API plan as an add-on purchase.
+ **NOTE:** QES is only available on the Premium API plan as an add-on purchase.
Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
@@ -8017,7 +7021,7 @@ components:
Send with a value of `true` if you wish to enable
[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
which requires the signer to verify their identity with an eID provider to sign a document.
- **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
message:
@@ -8108,7 +7112,7 @@ components:
Send with a value of `true` if you wish to enable
[Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES),
which requires a face-to-face call to verify the signer's identity.
- **Note**: QES is only available on the Premium API plan as an add-on purchase.
+ **NOTE:** QES is only available on the Premium API plan as an add-on purchase.
Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
@@ -8119,7 +7123,7 @@ components:
Send with a value of `true` if you wish to enable
[electronic identification (eID)](https://www.hellosign.com/features/electronic-id),
which requires the signer to verify their identity with an eID provider to sign a document.
- **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
type: boolean
default: false
message:
@@ -8167,14 +7171,14 @@ components:
This will generate a new `signature_id` value.
- **NOTE**: Optional if `name` is provided.
+ **NOTE:** Optional if `name` is provided.
type: string
format: email
name:
description: |-
The new name for the recipient.
- **NOTE**: Optional if `email_address` is provided.
+ **NOTE:** Optional if `email_address` is provided.
type: string
signature_id:
description: 'The signature ID for the recipient.'
@@ -8203,7 +7207,7 @@ components:
description: |-
The signer's index in the `signers` parameter (0-based indexing).
- **NOTE**: Only one signer can be assigned per attachment.
+ **NOTE:** Only one signer can be assigned per attachment.
type: integer
type: object
SubBulkSignerList:
@@ -8261,7 +7265,7 @@ components:
description: |-
Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.
- **Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
+ **NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
type: string
name:
description: 'The name of a custom field. When working with pre-filled data, the custom field''s name must have a matching merge field name or the field will remain empty on the document during signing.'
@@ -8295,7 +7299,7 @@ components:
description: |-
Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
- **Note**: Only available for Premium and higher.
+ **NOTE:** Only available for Premium and higher.
type: string
enum:
- 'MM / DD / YYYY'
@@ -8474,8 +7478,6 @@ components:
description: '`true` for checking the checkbox field by default, otherwise `false`.'
type: boolean
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentCheckboxMerge:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8490,8 +7492,6 @@ components:
type: string
default: checkbox-merge
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentDateSigned:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8529,12 +7529,10 @@ components:
description: |-
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
type: integer
default: 12
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentDropdown:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8582,12 +7580,10 @@ components:
description: |-
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
type: integer
default: 12
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentHyperlink:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8633,12 +7629,10 @@ components:
description: |-
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
type: integer
default: 12
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentInitials:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8653,8 +7647,6 @@ components:
type: string
default: initials
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentRadio:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8677,8 +7669,6 @@ components:
description: '`true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.'
type: boolean
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentSignature:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8693,8 +7683,6 @@ components:
type: string
default: signature
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentText:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8725,7 +7713,7 @@ components:
description: |-
Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.
- **NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
+ **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.
type: string
enum:
- numbers_only
@@ -8769,12 +7757,10 @@ components:
description: |-
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
type: integer
default: 12
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentTextMerge:
description: 'This class extends `SubFormFieldsPerDocumentBase`.'
allOf:
@@ -8812,12 +7798,10 @@ components:
description: |-
The initial px font size for the field contents. Can be any integer value between `7` and `49`.
- **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
+ **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
type: integer
default: 12
type: object
- -
- $ref: '#/components/schemas/SubFormFieldsPerDocumentBase'
SubFormFieldsPerDocumentTypeEnum:
type: string
enum:
@@ -8854,7 +7838,7 @@ components:
description: |-
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -8904,9 +7888,9 @@ components:
description: |-
Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.
- **NOTE**: To set the value of the field as the preparer you must set this to `me_now`
+ **NOTE:** To set the value of the field as the preparer you must set this to `me_now`
- **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
+ **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
type: string
x-int-or-string: true
type:
@@ -8952,7 +7936,7 @@ components:
description: |-
Signers belonging to this Group.
- **NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
+ **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
type: array
items:
$ref: '#/components/schemas/SubSignatureRequestSigner'
@@ -9031,7 +8015,7 @@ components:
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
- **Note**: Not available in test mode and requires a Standard plan or higher.
+ **NOTE:** Not available in test mode and requires a Standard plan or higher.
type: string
sms_phone_number_type:
description: |-
@@ -9072,7 +8056,7 @@ components:
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
- **Note**: Not available in test mode and requires a Standard plan or higher.
+ **NOTE:** Not available in test mode and requires a Standard plan or higher.
type: string
sms_phone_number_type:
description: |-
@@ -9134,7 +8118,7 @@ components:
description: |-
This allows the requester to specify the types allowed for creating a signature.
- **Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
+ **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
required:
- default_type
properties:
@@ -9237,7 +8221,7 @@ components:
description: |-
A role member will take in a new Team.
- **Note**: This parameter is used only if `team_id` is provided.
+ **NOTE:** This parameter is used only if `team_id` is provided.
type: string
enum:
- Member
@@ -9271,7 +8255,7 @@ components:
description: |-
The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.
- **Note**: Only available for Enterprise plans.
+ **NOTE:** Only available for Enterprise plans.
type: string
format: email
new_team_id:
@@ -9281,7 +8265,7 @@ components:
description: |-
A new role member will take in a new Team.
- **Note**: This parameter is used only if `new_team_id` is provided.
+ **NOTE:** This parameter is used only if `new_team_id` is provided.
type: string
enum:
- Member
@@ -9300,12 +8284,12 @@ components:
account_id:
description: |-
The id of the Account to give access to the Template.
- Note The account id prevails if email address is also provided.
+ **NOTE:** The account id prevails if email address is also provided.
type: string
email_address:
description: |-
The email address of the Account to give access to the Template.
- Note The account id prevails if it is also provided.
+ **NOTE:** The account id prevails if it is also provided.
type: string
format: email
skip_notification:
@@ -9339,7 +8323,7 @@ components:
description: |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
- **Note**: Only available for Premium plan and higher.
+ **NOTE:** Only available for Premium plan and higher.
type: boolean
default: false
attachments:
@@ -9371,7 +8355,7 @@ components:
description: |-
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -9455,7 +8439,7 @@ components:
description: |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
- **Note**: Only available for Premium plan and higher.
+ **NOTE:** Only available for Premium plan and higher.
type: boolean
default: false
attachments:
@@ -9497,7 +8481,7 @@ components:
description: |-
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -9679,7 +8663,7 @@ components:
description: |-
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -9750,7 +8734,7 @@ components:
description: |-
When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
- **Note**: This does not correspond to the **expires_at** returned in the response.
+ **NOTE:** This does not correspond to the **expires_at** returned in the response.
type: integer
nullable: true
type: object
@@ -9789,7 +8773,7 @@ components:
description: |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
- **Note**: Only available for Premium plan and higher.
+ **NOTE:** Only available for Premium plan and higher.
type: boolean
default: false
attachments:
@@ -9842,7 +8826,7 @@ components:
description: |-
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
- **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
+ **NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText`
* Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -9940,14 +8924,14 @@ components:
description: |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
+ **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
expires_at:
description: |-
When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.
- **Note**: This does not correspond to the **expires_at** returned in the response.
+ **NOTE:** This does not correspond to the **expires_at** returned in the response.
type: integer
nullable: true
type: object
@@ -9965,7 +8949,7 @@ components:
description: |-
Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.
- **Note**: Only available for Premium plan and higher.
+ **NOTE:** Only available for Premium plan and higher.
type: boolean
default: false
ccs:
@@ -10037,7 +9021,7 @@ components:
- `preview_only=true`: Allows requesters to enable the preview only experience.
- `preview_only=false`: Allows requesters to disable the preview only experience.
- **Note**: This parameter overwrites `show_preview=1` (if set).
+ **NOTE:** This parameter overwrites `show_preview=1` (if set).
type: boolean
default: false
requester_email_address:
@@ -10094,7 +9078,7 @@ components:
description: |-
Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing.
- ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
+ **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
type: boolean
default: false
allow_ccs:
@@ -10797,13 +9781,13 @@ components:
x-base-class: true
SignatureRequestResponseCustomFieldCheckbox:
description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
- required:
- - type
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
-
+ required:
+ - name
+ - type
properties:
type:
description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
@@ -10812,15 +9796,16 @@ components:
value:
description: 'A true/false for checkbox fields'
type: boolean
+ type: object
SignatureRequestResponseCustomFieldText:
description: 'This class extends `SignatureRequestResponseCustomFieldBase`.'
- required:
- - type
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseCustomFieldBase'
-
+ required:
+ - name
+ - type
properties:
type:
description: 'The type of this Custom Field. Only ''text'' and ''checkbox'' are currently supported.'
@@ -10829,6 +9814,7 @@ components:
value:
description: 'A text string for text fields'
type: string
+ type: object
SignatureRequestResponseCustomFieldTypeEnum:
type: string
enum:
@@ -10879,7 +9865,6 @@ components:
- text-merge
- checkbox-merge
SignatureRequestResponseDataValueCheckbox:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10892,8 +9877,8 @@ components:
value:
description: 'The value of the form field.'
type: boolean
+ type: object
SignatureRequestResponseDataValueCheckboxMerge:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10906,8 +9891,8 @@ components:
value:
description: 'The value of the form field.'
type: string
+ type: object
SignatureRequestResponseDataValueDateSigned:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10920,8 +9905,8 @@ components:
value:
description: 'The value of the form field.'
type: string
+ type: object
SignatureRequestResponseDataValueDropdown:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10934,8 +9919,8 @@ components:
value:
description: 'The value of the form field.'
type: string
+ type: object
SignatureRequestResponseDataValueInitials:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10948,8 +9933,8 @@ components:
value:
description: 'The value of the form field.'
type: string
+ type: object
SignatureRequestResponseDataValueRadio:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10962,8 +9947,8 @@ components:
value:
description: 'The value of the form field.'
type: boolean
+ type: object
SignatureRequestResponseDataValueSignature:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10976,8 +9961,8 @@ components:
value:
description: 'The value of the form field.'
type: string
+ type: object
SignatureRequestResponseDataValueText:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -10990,8 +9975,8 @@ components:
value:
description: 'The value of the form field.'
type: string
+ type: object
SignatureRequestResponseDataValueTextMerge:
- type: object
allOf:
-
$ref: '#/components/schemas/SignatureRequestResponseDataBase'
@@ -11004,6 +9989,7 @@ components:
value:
description: 'The value of the form field.'
type: string
+ type: object
SignatureRequestResponseSignatures:
description: 'An array of signature objects, 1 for each signer.'
properties:
@@ -11349,7 +10335,7 @@ components:
items:
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
static_fields:
- description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
+ description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
type: array
items:
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
@@ -11404,7 +10390,6 @@ components:
description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
@@ -11418,11 +10403,11 @@ components:
* Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox`
type: string
default: checkbox
+ type: object
TemplateResponseDocumentCustomFieldText:
description: 'This class extends `TemplateResponseDocumentCustomFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentCustomFieldBase'
@@ -11447,6 +10432,7 @@ components:
fontFamily:
description: 'Font family used in this form field''s text.'
type: string
+ type: object
TemplateResponseDocumentFieldGroup:
properties:
name:
@@ -11523,13 +10509,12 @@ components:
x-base-class: true
TemplateResponseDocumentFormFieldCheckbox:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
- required:
- - type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11545,15 +10530,17 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: checkbox
+ type: object
TemplateResponseDocumentFormFieldDateSigned:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11569,15 +10556,17 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: date_signed
+ type: object
TemplateResponseDocumentFormFieldDropdown:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11593,15 +10582,17 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: dropdown
+ type: object
TemplateResponseDocumentFormFieldHyperlink:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11628,15 +10619,17 @@ components:
fontFamily:
description: 'Font family used in this form field''s text.'
type: string
+ type: object
TemplateResponseDocumentFormFieldInitials:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11652,16 +10645,18 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: initials
+ type: object
TemplateResponseDocumentFormFieldRadio:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
required:
- type
- group
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11677,15 +10672,17 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: radio
+ type: object
TemplateResponseDocumentFormFieldSignature:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11701,15 +10698,17 @@ components:
* Initials Field uses `TemplateResponseDocumentFormFieldInitials`
type: string
default: signature
+ type: object
TemplateResponseDocumentFormFieldText:
description: 'This class extends `TemplateResponseDocumentFormFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentFormFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11751,8 +10750,9 @@ components:
- employer_identification_number
- custom_regex
nullable: true
+ type: object
TemplateResponseDocumentStaticFieldBase:
- description: 'An array describing static overlay fields. **Note** only available for certain subscriptions.'
+ description: 'An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.'
required:
- type
properties:
@@ -11805,11 +10805,12 @@ components:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11825,15 +10826,17 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: checkbox
+ type: object
TemplateResponseDocumentStaticFieldDateSigned:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11849,15 +10852,17 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: date_signed
+ type: object
TemplateResponseDocumentStaticFieldDropdown:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11873,15 +10878,17 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: dropdown
+ type: object
TemplateResponseDocumentStaticFieldHyperlink:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11897,15 +10904,17 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: hyperlink
+ type: object
TemplateResponseDocumentStaticFieldInitials:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11921,15 +10930,17 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: initials
+ type: object
TemplateResponseDocumentStaticFieldRadio:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11945,15 +10956,17 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: radio
+ type: object
TemplateResponseDocumentStaticFieldSignature:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11969,15 +10982,17 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: signature
+ type: object
TemplateResponseDocumentStaticFieldText:
description: 'This class extends `TemplateResponseDocumentStaticFieldBase`'
required:
- type
- type: object
allOf:
-
$ref: '#/components/schemas/TemplateResponseDocumentStaticFieldBase'
-
+ required:
+ - type
properties:
type:
description: |-
@@ -11993,6 +11008,7 @@ components:
* Initials Field uses `TemplateResponseDocumentStaticFieldInitials`
type: string
default: text
+ type: object
TemplateResponseFieldAvgTextLength:
description: 'Average text length in this field.'
properties:
@@ -12351,30 +11367,6 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json
- SignatureRequestEditRequestDefaultExample:
- summary: 'Default Example'
- value:
- $ref: examples/json/SignatureRequestEditRequestDefaultExample.json
- SignatureRequestEditRequestGroupedSignersExample:
- summary: 'Grouped Signers Example'
- value:
- $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json
- SignatureRequestEditEmbeddedRequestDefaultExample:
- summary: 'Default Example'
- value:
- $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json
- SignatureRequestEditEmbeddedRequestGroupedSignersExample:
- summary: 'Grouped Signers Example'
- value:
- $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json
- SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample:
- summary: 'Default Example'
- value:
- $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json
- SignatureRequestEditWithTemplateRequestDefaultExample:
- summary: 'Default Example'
- value:
- $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json
SignatureRequestRemindRequestDefaultExample:
summary: 'Default Example'
value:
@@ -12623,18 +11615,10 @@ components:
summary: 'Create Embedded Signature Request'
value:
$ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json
- SignatureRequestEditEmbeddedResponseExample:
- summary: 'Edit Embedded Signature Request'
- value:
- $ref: examples/json/SignatureRequestEditEmbeddedResponseExample.json
SignatureRequestCreateEmbeddedWithTemplateResponseExample:
summary: 'Create Embedded Signature Request With Template'
value:
$ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json
- SignatureRequestEditEmbeddedWithTemplateResponseExample:
- summary: 'Edit Embedded Signature Request With Template'
- value:
- $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json
SignatureRequestFilesResponseExample:
summary: 'Signature Requests Files'
value:
@@ -12651,18 +11635,10 @@ components:
summary: 'Send Signature Request'
value:
$ref: examples/json/SignatureRequestSendResponseExample.json
- SignatureRequestEditResponseExample:
- summary: 'Edit Signature Request'
- value:
- $ref: examples/json/SignatureRequestEditResponseExample.json
SignatureRequestSendWithTemplateResponseExample:
summary: 'Send Signature Request With Template'
value:
$ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json
- SignatureRequestEditWithTemplateResponseExample:
- summary: 'Edit Signature Request With Template'
- value:
- $ref: examples/json/SignatureRequestEditWithTemplateResponseExample.json
SignatureRequestUpdateResponseExample:
summary: 'Signature Request Update'
value:
diff --git a/src/Dropbox.Sign/Api/SignatureRequestApi.cs b/src/Dropbox.Sign/Api/SignatureRequestApi.cs
index 22fe492..1ccec7f 100644
--- a/src/Dropbox.Sign/Api/SignatureRequestApi.cs
+++ b/src/Dropbox.Sign/Api/SignatureRequestApi.cs
@@ -31,7 +31,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Embedded Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -43,7 +43,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Embedded Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -54,7 +54,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -66,7 +66,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -77,7 +77,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Cancel Incomplete Signature Request
///
///
- /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+ /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
///
/// Thrown when fails to make API call
/// The id of the incomplete SignatureRequest to cancel.
@@ -89,7 +89,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Cancel Incomplete Signature Request
///
///
- /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+ /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
///
/// Thrown when fails to make API call
/// The id of the incomplete SignatureRequest to cancel.
@@ -100,7 +100,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Create Embedded Signature Request
///
///
- /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -112,7 +112,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Create Embedded Signature Request
///
///
- /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -123,7 +123,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Create Embedded Signature Request with Template
///
///
- /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -135,7 +135,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Create Embedded Signature Request with Template
///
///
- /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -143,106 +143,6 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// ApiResponse of SignatureRequestGetResponse
ApiResponse SignatureRequestCreateEmbeddedWithTemplateWithHttpInfo(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest, int operationIndex = 0);
///
- /// Edit Signature Request
- ///
- ///
- /// 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. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// SignatureRequestGetResponse
- SignatureRequestGetResponse SignatureRequestEdit(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0);
-
- ///
- /// Edit Signature Request
- ///
- ///
- /// 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. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// ApiResponse of SignatureRequestGetResponse
- ApiResponse SignatureRequestEditWithHttpInfo(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0);
- ///
- /// Edit Embedded Signature Request
- ///
- ///
- /// 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. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// SignatureRequestGetResponse
- SignatureRequestGetResponse SignatureRequestEditEmbedded(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0);
-
- ///
- /// Edit Embedded Signature Request
- ///
- ///
- /// 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. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// ApiResponse of SignatureRequestGetResponse
- ApiResponse SignatureRequestEditEmbeddedWithHttpInfo(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0);
- ///
- /// Edit Embedded Signature Request with Template
- ///
- ///
- /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// SignatureRequestGetResponse
- SignatureRequestGetResponse SignatureRequestEditEmbeddedWithTemplate(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0);
-
- ///
- /// Edit Embedded Signature Request with Template
- ///
- ///
- /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// ApiResponse of SignatureRequestGetResponse
- ApiResponse SignatureRequestEditEmbeddedWithTemplateWithHttpInfo(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0);
- ///
- /// Edit Signature Request With Template
- ///
- ///
- /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// SignatureRequestGetResponse
- SignatureRequestGetResponse SignatureRequestEditWithTemplate(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0);
-
- ///
- /// Edit Signature Request With Template
- ///
- ///
- /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// ApiResponse of SignatureRequestGetResponse
- ApiResponse SignatureRequestEditWithTemplateWithHttpInfo(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0);
- ///
/// Download Files
///
///
@@ -394,7 +294,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Send Request Reminder
///
///
- /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
+ /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to send a reminder for.
@@ -407,7 +307,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Send Request Reminder
///
///
- /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
+ /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to send a reminder for.
@@ -488,7 +388,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Update Signature Request
///
///
- /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+ /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to update.
@@ -501,7 +401,7 @@ public interface ISignatureRequestApiSync : IApiAccessor
/// Update Signature Request
///
///
- /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+ /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to update.
@@ -522,7 +422,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Embedded Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -535,7 +435,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Embedded Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -547,7 +447,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -560,7 +460,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Bulk Send with Template
///
///
- /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -572,7 +472,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Cancel Incomplete Signature Request
///
///
- /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+ /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
///
/// Thrown when fails to make API call
/// The id of the incomplete SignatureRequest to cancel.
@@ -585,7 +485,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Cancel Incomplete Signature Request
///
///
- /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+ /// Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
///
/// Thrown when fails to make API call
/// The id of the incomplete SignatureRequest to cancel.
@@ -597,7 +497,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Create Embedded Signature Request
///
///
- /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -610,7 +510,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Create Embedded Signature Request
///
///
- /// Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -622,7 +522,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Create Embedded Signature Request with Template
///
///
- /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -635,7 +535,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Create Embedded Signature Request with Template
///
///
- /// Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
+ /// 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.
///
/// Thrown when fails to make API call
///
@@ -644,114 +544,6 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Task of ApiResponse (SignatureRequestGetResponse)
System.Threading.Tasks.Task> SignatureRequestCreateEmbeddedWithTemplateWithHttpInfoAsync(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
///
- /// Edit Signature Request
- ///
- ///
- /// 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. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of SignatureRequestGetResponse
- System.Threading.Tasks.Task SignatureRequestEditAsync(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
-
- ///
- /// Edit Signature Request
- ///
- ///
- /// 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. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of ApiResponse (SignatureRequestGetResponse)
- System.Threading.Tasks.Task> SignatureRequestEditWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
- ///
- /// Edit Embedded Signature Request
- ///
- ///
- /// 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. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of SignatureRequestGetResponse
- System.Threading.Tasks.Task SignatureRequestEditEmbeddedAsync(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
-
- ///
- /// Edit Embedded Signature Request
- ///
- ///
- /// 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. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of ApiResponse (SignatureRequestGetResponse)
- System.Threading.Tasks.Task> SignatureRequestEditEmbeddedWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
- ///
- /// Edit Embedded Signature Request with Template
- ///
- ///
- /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of SignatureRequestGetResponse
- System.Threading.Tasks.Task SignatureRequestEditEmbeddedWithTemplateAsync(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
-
- ///
- /// Edit Embedded Signature Request with Template
- ///
- ///
- /// Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. <u>Note</u> that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of ApiResponse (SignatureRequestGetResponse)
- System.Threading.Tasks.Task> SignatureRequestEditEmbeddedWithTemplateWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
- ///
- /// Edit Signature Request With Template
- ///
- ///
- /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of SignatureRequestGetResponse
- System.Threading.Tasks.Task SignatureRequestEditWithTemplateAsync(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
-
- ///
- /// Edit Signature Request With Template
- ///
- ///
- /// Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota.
- ///
- /// Thrown when fails to make API call
- /// The id of the SignatureRequest to edit.
- ///
- /// Index associated with the operation.
- /// Cancellation Token to cancel the request.
- /// Task of ApiResponse (SignatureRequestGetResponse)
- System.Threading.Tasks.Task> SignatureRequestEditWithTemplateWithHttpInfoAsync(string signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken));
- ///
/// Download Files
///
///
@@ -915,7 +707,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Send Request Reminder
///
///
- /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
+ /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to send a reminder for.
@@ -929,7 +721,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Send Request Reminder
///
///
- /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE**: This action can **not** be used with embedded signature requests.
+ /// Sends an email to the signer reminding them to sign the signature request. You cannot send a reminder within 1 hour of the last reminder that was sent. This includes manual AND automatic reminders. **NOTE:** This action can **not** be used with embedded signature requests.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to send a reminder for.
@@ -1017,7 +809,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Update Signature Request
///
///
- /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+ /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to update.
@@ -1031,7 +823,7 @@ public interface ISignatureRequestApiAsync : IApiAccessor
/// Update Signature Request
///
///
- /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+ /// Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method. Updating the email address of a signer will generate a new `signature_id` value. **NOTE:** This action cannot be performed on a signature request with an appended signature page.
///
/// Thrown when fails to make API call
/// The id of the SignatureRequest to update.
@@ -1161,7 +953,7 @@ public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
}
///
- /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1174,7 +966,7 @@ public BulkSendJobSendResponse SignatureRequestBulkCreateEmbeddedWithTemplate(Si
}
///
- /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1244,7 +1036,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest
}
///
- /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1258,7 +1050,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest
}
///
- /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE**: Only available for Standard plan and higher.
+ /// Embedded Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1331,7 +1123,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest
}
///
- /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1344,7 +1136,7 @@ public BulkSendJobSendResponse SignatureRequestBulkSendWithTemplate(SignatureReq
}
///
- /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1420,7 +1212,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest
}
///
- /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1434,7 +1226,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest
}
///
- /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE**: Only available for Standard plan and higher.
+ /// Bulk Send with Template Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
///
/// Thrown when fails to make API call
///
@@ -1513,7 +1305,7 @@ public Dropbox.Sign.Client.ApiResponse SignatureRequest
}
///
- /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+ /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
///
/// Thrown when fails to make API call
/// The id of the incomplete SignatureRequest to cancel.
@@ -1525,7 +1317,7 @@ public void SignatureRequestCancel(string signatureRequestId, int operationIndex
}
///
- /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE**: To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+ /// Cancel Incomplete Signature Request Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
///
/// Thrown when fails to make API call
/// The id of the incomplete SignatureRequest to cancel.
@@ -1593,7 +1385,7 @@ public Dropbox.Sign.Client.ApiResponse