Cancel editing

The Cancel Editing API allows you to cancel the editing of a document that is currently in edit mode.

Cancel document editing

post/v1/document/cancelEditing

Cancelling the edit of a document that’s already in edit mode can be done using this API, but you must be the sender of that document. If the document was sent on behalf of someone else, you’ll need to have that sender’s identity verified in your account before you can cancel the edit.

Code snippet

curl -X POST 'https://api.boldsign.com/v1/document/cancelEditing?documentId=625cff3d...&[email protected]' \
  -H 'X-API-KEY: {your API key}'

var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var documentClient = new DocumentClient(apiClient);

var cancelEdit = new CancelDocumentEditingRequest()
{
    DocumentId = "625cff3d...",
    OnBehalfOf = "[email protected]"
};

var editCancelled = await documentClient.CancelEditingAsync(cancelEdit);

import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
    document_api = boldsign.DocumentApi(api_client)
    document_api.cancel_editing(
        document_id="YOUR_DOCUMENT_ID",
        on_behalf_of="[email protected]")

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;

// Configure API key authorization: X-API-KEY
$config = Configuration();
$config->setApiKey('YOUR_API_KEY');

$apiInstance = DocumentApi($config);
$apiInstance->cancelEditing(document_id: "YOUR_DOCUMENT_ID");

import boldsign.ApiClient;
import boldsign.ApiException;
import boldsign.Configuration;
import boldsign.api.DocumentApi;

ApiClient apiClient = Configuration.getDefaultApiClient();
apiClient.setApiKey("YOUR_API_KEY");
String documentId = "YOUR_DOCUMENT_ID";
String onBehalfOf = "[email protected]";
DocumentApi documentApi = new DocumentApi(apiClient);
documentApi.cancelEditing(documentId, onBehalfOf);

import { DocumentApi } from "boldsign";

const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");

await documentApi.cancelEditing("YOUR_DOCUMENT_ID");

Query parameters

documentIdstringRequired	The unique document id of the document.
onBehalfOfstring	The on behalf email address of the sender.

Example response

200 Success

Editing session canceled successfully.