Envelopes

Cancelar envelope

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.

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

Path parameters

envelopeIdstring required

Identificador único do envelope.

Response

Envelope cancelado com sucesso.

envelopeIdstring required
status'CANCELLED' required
cancelledCountinteger required

Sessões pendentes que foram canceladas.

preservedSignedCountinteger required

Sessões já assinadas, preservadas intactas.

alreadyCancelledboolean

Presente e true quando o envelope já estava cancelado.

Changes

No recorded changes to this operation across all 1 revision of this API.