---
title: "Cancelar envelope"
method: POST
path: "/v1/envelopes/{envelopeId}/cancel"
tags: ["Envelopes"]
---

# Cancelar envelope

`POST /v1/envelopes/{envelopeId}/cancel`

## Request

- Base URL: `https://api.signdocs.com.br`
- URL: `https://api.signdocs.com.br/v1/envelopes/{envelopeId}/cancel`
- Auth: HTTP bearer

Cancela um envelope e todas as suas sessões de assinatura ainda pendentes.

Sessões **já concluídas são preservadas** — a resposta devolve
`preservedSignedCount` para que assinaturas legítimas nunca sejam descartadas
junto com o cancelamento. Chamar novamente um envelope já cancelado devolve
`200` com `alreadyCancelled: true` (idempotente).

Requer scope `transactions:write`.

## Path parameters

- `envelopeId` string, required

## Response `200`

Envelope cancelado com sucesso.

- CancelEnvelopeResponse: Resposta do cancelamento de envelope.
  - `envelopeId` string, required
  - `status` 'CANCELLED', required
  - `cancelledCount` integer, required: Sessões pendentes que foram canceladas.
  - `preservedSignedCount` integer, required: Sessões já assinadas, preservadas intactas.
  - `cancelledSessions` object[], required
    - `sessionId` string
    - `transactionId` string
  - `alreadyCancelled` boolean: Presente e `true` quando o envelope já estava cancelado.

## Other responses

- `401`: Autenticação ausente ou inválida.
- `404`: Recurso não encontrado.
- `500`: Erro interno do servidor.

---

[API](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api.md) · [All operations](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signdocs/apis/signdocs-brasil-external-api/revisions/2d3805aed161?raw)