Archive signing workflow
Archives a published signing workflow, removing it from active use. Archived
workflows cannot be used in new contract requests.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Archive a contract flow, removing it from active use. The flow's status is set to archived. Archived flows cannot be used to create new contract requests; they can later be restored with the unarchive endpoint or permanently removed with the delete endpoint. 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. - The client must have contract signing enabled. If the feature is disabled the request returns
403.
Path parameters
| Parameter | In | Description |
|---|---|---|
workflow_id | path | ID of the contract flow to archive. Must belong to your client. |
Behavior
Archiving sets the flow's status to archived regardless of its current status. The flow definition is preserved, so it can be restored later via unarchive (which returns it to draft).
Response
200 — Returns the updated SigningWorkflowResponse with status set to archived.
Error responses
| Status | When |
|---|---|
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.