Unarchive contract flow
Restores an archived contract flow to DRAFT status so it can be edited and
published again.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Restore an archived contract flow back to draft status so it can be edited and published again. The flow's working definition is reset to its last published snapshot (falling back to the existing definition), and the stored published snapshot and publish timestamp are cleared. Returns the updated contract flow.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
contracts.workflows.archivepermission and have the OWNER or OPERATIONS role. - Contract signing must be enabled for the client. If it is disabled the request returns
403.
Path parameters
workflow_id(string, required) — ID of the contract flow to unarchive. It must belong to your client.
Preconditions
The contract flow must currently be in archived status. Unarchiving a flow in any other status is rejected with 400.
What unarchiving does
- Sets the flow's status back to
draft. - Resets the working
definitionto the last published snapshot (or, if there is none, keeps the current definition). - Clears the stored published snapshot and the
published_attimestamp, so the flow must be published again before it can send new contract requests.
Response
200 OK with the updated contract flow as a SigningWorkflowResponse, including id, name, description, template_version_id, status (now draft), variables, participants, stages, email_notifications, published_at (now null), created_at, and updated_at.
Error responses
| Status | When |
|---|---|
400 | The contract flow is not currently archived |
403 | Contract signing is disabled for the client |
404 | No contract flow with this workflow_id exists under your client |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.