ATatlaswork
envelopes

Void an envelope

Changed on

Appends envelope.voided (with the optional reason in the event payload). Valid from draft, review, detecting, and in_progress; terminal envelopes (completed, declined, voided, expired) reject with 409. Supports the Idempotency-Key header: a replayed completed key returns the envelope's current graph with the original status code and Idempotency-Replayed: true (never re-executing); an in-flight duplicate is rejected 409; reusing a key with a different request is rejected 422.

post/api/v1/envelopes/{id}/void

Request

  • Base URL
    https://api.atlaswork.ai
  • URL
    https://api.atlaswork.ai/api/v1/envelopes/{id}/void
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

idstring required

Envelope id

Request body

expectedVersioninteger
reasonstring

Response

The voided envelope graph

Changes

  • d3b4f91b9bb2Revision changes
    • warning

      added the new skipped enum value to the / response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status