Skip to main content
PATCH
Save Flow instruction draft

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Opaque resource identifier.

Query Parameters

team_id
string<uuid>
required

Team authoring scope for the guidance rule.

Body

application/json
content
string
required

Team instruction body. Must be non-empty after trimming and at most 7,968 characters. That limit keeps the customer-prompt budget (2,000 of the shared 4,000 guidance tokens via ceil((length + 32) / 4)) from consuming room needed for organization instructions.

Maximum string length: 7968
expected_active_version_id
string<uuid> | null
required

Published instruction version the client last read. Send null when no version is published. A stale publication returns a conflict before a draft is created.

title
string
change_summary
string
rationale
string
expected_draft_version_id
string<uuid> | null

Draft version the client last read. Omit to skip the draft-specific concurrency check; the active-version check still applies. Send null when asserting no unpublished draft exists yet.

Response

Saved Flow instruction draft version.

data
object
required
meta
object
required