Revoke document
post/v1/document/revokeThe document signing process can be called off or revoked by the sender of the document. Once you revoke a document, signers can no longer view or sign it.
Revoke action can only be performed on documents that have not completed the signing process.
Code snippet
curl -X POST "https://api.boldsign.com/v1/document/revoke?documentId={documentId}" -H 'X-API-KEY: {your API key}' -H "Content-Type: application/json" -d "{\"message\": \"This is document revoke message\"}"
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}"); var documentclient = new DocumentClient(apiClient); await documentclient.RevokeDocumentAsync("{documentId}", "This is document revoke message").ConfigureAwait(false);
import requests import json url = "https://api.boldsign.com/v1/document/revoke?documentId={documentId}" payload = json.dumps({ "message": "This is document revoke message" }) headers = { 'X-API-KEY': '{apikey}', 'Content-Type': 'application/json' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text)
const axios = require('axios'); await axios.post( 'https://api.boldsign.com/v1/document/revoke', { message: 'This is document revoke message' }, { params: { documentId: '{documentId}' }, headers: { 'X-API-KEY': '{Your API key}', 'Content-Type': 'application/json' } } );
Query parameters
documentIdstringRequired | ID of the requested document to revoke. |
Request body
messagestringRequired | The exact reason for performing a revoke action. |
onBehalfOfstring | If the document is created on behalf of the sender, the sender's identity email address must be specified. |
Example response
204 No Content