This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
Envelope lifecycle
States
Draft — the usual starting state: the envelope exists and no signer can see it. Not always where you begin, though: creating an envelope with toBePublishedAtUtc set returns it already in PublishScheduled.PublishScheduled — publication is booked and has not happened yet. It can be published early, put on hold, or cancelled. It cannot expire from here; expiry applies only to published envelopes.Published — signers have been invited and can act. Signed and Rejected can only come from here.Hold — paused; signers cannot act. From hold the envelope can be published again, rescheduled, or cancelled. Hold is also the way back for envelopes that expired or that a signer's failed identity validation stopped.Expired — expiresAtUtc passed without every signer completing. All remaining signers are reset, so republishing starts them over.CancelledBySignerMfaError — a signer failed identity validation in a way that stopped the workflow.Cancelled — cancelled by the account. Terminal: it cannot be held or published again.Signed — every required signer completed. Terminal.Rejected — a signer declined. Terminal.Signed, Rejected and Cancelled are terminal. If you are modelling this on your side, do not treat an expiry, or a stop caused by a signer's failed identity validation, as the end of the envelope's life.Publishing
POST /{id}/publish is accepted from Draft, Hold and PublishScheduled only. Publishing an envelope that is already Published returns 400, which is what makes a retry after an ambiguous failure safe: either it publishes, or it tells you it already did.POST /{id}/unschedule puts the envelope on Hold, not back to Draft. A PUT that omits toBePublishedAtUtc on an envelope that had one does the same thing silently.Hold and the owner is emailed.Trash
Published envelope cannot be trashed — you get a 400. Cancel or hold it first.404 for it, and listings leave it out. To find it again, list envelopes with includeRemoved=true.POST /{id}/restore/to/{vaultId} — and the envelope moves there. It keeps the status it had when it was trashed.Modified at 2026-11-02 00:01:43