---
title: "Cancel an open envelope; its link stops working at once (staff)"
method: POST
path: "/api/admin/signing/envelopes/{id}/void"
tags: ["admin"]
---

# Cancel an open envelope; its link stops working at once (staff)

`POST /api/admin/signing/envelopes/{id}/void`

## Request

- Base URL: `https://api.wizbi.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.wizbi.ai/api/admin/signing/envelopes/{id}/void`
- Auth: none declared

## Path parameters

- `id` string, required

## Request body

- object
  - `reason` string, required

## Response `200`

OK.

- object
  - `envelope` SigningEnvelope, required
    - `id` string, required
    - `quoteNumber` string, required
    - `title` string, required
    - `customer` object, required
      - `legalName` string, required
      - `companyId` string, nullable, required
    - `orgId` string, nullable, required
    - `signer` object, required
      - `email` string, required
      - `name` string, nullable, required
    - `locale` 'he' | 'en', required
    - `status` 'open' | 'signed' | 'void', required
    - `expiresAt` string, required
    - `rendered` object, required
      - `sha256` string, required
      - `bytes` number, required
      - `pages` number, required
    - `original` object, required
      - `sha256` string, required
      - `bytes` number, required
      - `pages` number, required
    - `signed` object, nullable, required
      - `sha256` string, required
      - `bytes` number, required
      - `pages` number, required
      - `at` string, required
    - `fields` object[], required
      - `party` 'wizbi' | 'customer', required
      - `field` 'name' | 'signature' | 'date', required
      - `page` number, required
      - `rect` number[], required
    - `legal` object, required
      - `documents` object[], required
        - `key` string, required
        - `version` string, required
        - `url` string, required
        - `pdfs` object[], required
          - `lang` string, required
          - `url` string, required
          - `sha256` string, required
    - `wizbiSignature` object, nullable, required
      - `principalId` string, required
      - `name` string, required
      - `title` string, required
      - `at` string, required
    - `firstOpenedAt` string, nullable, required
    - `codeSentAt` string, nullable, required
    - `createdBy` string, required
    - `createdAt` string, required
    - `voidedAt` string, nullable, required

## Other responses

- `400`: Invalid request or reason missing.
- `403`: Not a super_admin.

---

[API](https://skmtc.dev/wizbi/apis/wizbi-core-api.md) · [All operations](https://skmtc.dev/wizbi/apis/wizbi-core-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wizbi/apis/wizbi-core-api/revisions/5a47416c82ec?raw)