Skip to main content
POST
Archive Flow instruction

Authorizations

Authorization
string
header
required

OAuth Bearer access tokens or Flow API keys with the required Flow scope families for the route.

Path Parameters

ruleId
string
required

Identifier segment for ruleId.

Query Parameters

team_id
string<uuid>
required

Team authoring scope for the guidance rule.

Body

application/json
expected_active_version_id
string<uuid> | null
required

Published instruction version the client last read. Send null when no version is published. A mismatched publication returns a conflict and leaves the rule unchanged.

expected_draft_version_id
string<uuid> | null
required

Draft version the client last read. Send null when no unpublished draft exists. A mismatched draft returns a conflict and leaves the rule unchanged.

Response

Archived Flow instruction rule.

data
object
required
meta
object
required