revoke_document

Cancel ongoing document signing processes by revoking access, preventing signers from viewing or signing. Requires document ID, reason, and optional sender email.

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
`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`	Yes	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)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "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": {
      "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.",
      "format": "email",
      "type": "string"
    }
  },
  "required": [
    "documentId",
    "message",
    "onBehalfOf"
  ],
  "type": "object"
}

boldsign

revoke_document

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from boldsign

Related Tools