cancel_envelope
Cancel a sent digital signature envelope and notify signers. Use this tool to stop the signing process for a specific envelope.
Instructions
Cancel a sent envelope. Signers will be notified.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| envelopeId | Yes | Envelope UUID |
Implementation Reference
- src/api.js:104-106 (handler)The actual API call implementation for canceling an envelope.
export function cancelEnvelope(creds, envelopeId) { return apiCall('POST', `/api/envelopes/${envelopeId}/cancel`, creds); } - src/index.js:263-275 (registration)Registration of the cancel_envelope tool and its handler logic which calls the API helper.
server.tool( 'cancel_envelope', 'Cancel a sent envelope. Signers will be notified.', { envelopeId: z.string().describe('Envelope UUID'), }, async ({ envelopeId }) => { try { const data = await api.cancelEnvelope(creds, envelopeId); return result(data); } catch (err) { return errorResult(err); }