Delete document
delete/v1/document/deleteDelete the specific document, and it will be moved to the trash. After 30 days, the document will be permanently deleted from the BoldSign Application.
Code snippet
curl -X 'DELETE' \ 'https://api.boldsign.com/v1/document/delete?documentId=documentId&deletePermanently=false' \ -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}"); var documentClient = new DocumentClient(apiClient); documentClient.DeleteDocument("8b637de3-xxxx-xxxx-xxxx-6a4fdd0xxxx", false);
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.delete_document(document_id="YOUR_DOCUMENT_ID")
<?php require_once "vendor/autoload.php"; $config = new BoldSign\Configuration(); $config->setApiKey('YOUR_API_KEY'); $document_api = new BoldSign\Api\DocumentApi($config); $document_api->deleteDocument($document_id = 'YOUR_DOCUMENT_ID');
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); DocumentApi documentApi = new DocumentApi(client); documentApi.deleteDocument("YOUR_DOCUMENT_ID", null);
import { DocumentApi } from "@boldsign/node-sdk"; const documentApi = new DocumentApi(); documentApi.setApiKey("YOUR_API_KEY"); documentApi.deleteDocument("YOUR_DOCUMENT_ID");
Query parameters
documentIdstringRequired | The ID of an existing document. |
deletePermanentlyboolean | To permanently delete the document, you need to set this parameter to true. By default, the document is moved to the Trash, and the default value for this parameter is false. |
Example responses
204 No Content