Archive a contract flow you no longer want to use. An archived flow disappears from the default list and no new contract can be sent from it. Contracts already sent from it are not affected.

Use this for a flow that has been used to send contracts and therefore cannot be deleted. It is reversible with Unarchive Workflow.

This endpoint is for contract flows (/contracts/workflows). Automation workflows (/workflows) have their own archive endpoint.

Authentication & access

• Requires a client API token: Authorization: Bearer <token>.
• API credentials need the contracts.workflows.archive permission. Dashboard users need the OWNER or OPERATIONS role, or a custom role that includes this permission.
• Contract signing must be enabled for the client. If it is disabled the request returns 403.

Path parameters

Behavior

• The flow status becomes archived. Archiving an already archived flow succeeds and changes nothing.
• GET /api/v1/contracts/workflows only returns it with include_archived=true or status=archived.
• POST /api/v1/contracts/requests with this workflow_id returns 400 until it is unarchived.
• Updating the flow with PUT /api/v1/contracts/workflows/{workflow_id} also restores it to published.

Response

200 - The updated contract flow, with status set to archived.

Error responses

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.