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-beta/document/cancelEditingCancelling 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-beta/document/cancelEditing?documentId=625cff3d...&onBehalfOf=sender@yourdomain.com' \
-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 = "sender@yourdomain.com"
};
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)
request = boldsign.CancelDocumentEditingRequest(
documentId="625cff3d...",
onBehalfOf="sender@yourdomain.com"
)
edit_cancelled = document_api.cancel_editing_async(cancel_document_editing_request=request)
<?php require_once "vendor/autoload.php";
use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\CancelDocumentEditingRequest;
$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');
$document_api = new DocumentApi($config);
$request = new CancelDocumentEditingRequest();
$request->setDocumentId('625cff3d...');
$request->setOnBehalfOf('sender@yourdomain.com');
$editCancelled = $document_api->cancelEditingAsync($request);
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
DocumentApi documentApi = new DocumentApi(client);
CancelDocumentEditingRequest request = new CancelDocumentEditingRequest();
request.setDocumentId("625cff3d...");
request.setOnBehalfOf("sender@yourdomain.com");
documentApi.cancelEditingAsync(request);
import { DocumentApi, CancelDocumentEditingRequest } from "boldsign";
const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");
const request = new CancelDocumentEditingRequest();
request.documentId = "625cff3d...";
request.onBehalfOf = "sender@yourdomain.com";
const editCancelled = await documentApi.cancelEditingAsync(request);
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.