revoke_document
Cancel in-progress document signing processes by revoking access, preventing signers from viewing or signing documents that are no longer needed.
Instructions
The 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 the in-progress status documents.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| documentId | Yes | Required. The unique identifier (ID) of the document to revoke. This can be obtained from the list documents tool. | |
| message | Yes | The exact reason for performing a revoke action. | |
| onBehalfOf | No | Optional. Email address of the sender when creating a document on their behalf. This email can be retrieved from the `behalfOf` property in the get document or list documents tool. |
Input Schema (JSON Schema)
{
"properties": {
"documentId": {
"description": "Required. The unique identifier (ID) of the document to revoke. This can be obtained from the list documents tool.",
"type": "string"
},
"message": {
"description": "The exact reason for performing a revoke action.",
"type": "string"
},
"onBehalfOf": {
"anyOf": [
{
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"type": "string"
},
{
"type": "null"
}
],
"description": "Optional. Email address of the sender when creating a document on their behalf. This email can be retrieved from the `behalfOf` property in the get document or list documents tool."
}
},
"required": [
"documentId",
"message"
],
"type": "object"
}