Documents
Void
POST
Stop an envelope that is out, with a reason; everyone still to act is told. Send an Idempotency-Key: the same key returns the same answer for 24 hours.
bearerheader
AuthorizationBearer <token>An access token from /v1/auth/token, or a personal token: opaque, beginning s2a_.
workspace_id*stringwsp_…, from GET /v1/me
Length
length <= 40envelope_id*stringenv_…
Length
length <= 40idempotency-key*stringA UUID of your own (ADR 0071 §5)
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidapplication/json- body
reason*stringLength
1 <= length <= 500Done
application/json- response
Done
id*stringstatus*stringcurl -X POST 'https://api.sign2approve.com/v1/workspaces/string/envelopes/string/void' \ -H 'idempotency-key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{ "reason": "string"}'{ "id": "env_01a16d3fd3507be78e41c4540aa20a3c", "status": "sent"}