Skip to main content
PATCH
Update the cohesion guide

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

Path Parameters

project_id
string<uuid>
required

UUID of the project

Body

application/json
cohesion_guide_mode
enum<string>
required
Available options:
default,
custom
cohesion_guide_text
string

Snapshot-specific guide text; only meaningful with mode=custom.

Response

Updated

cohesion_guide_mode
enum<string>
Available options:
default,
custom
cohesion_guide_text
string

Snapshot-specific text; empty when mode is default.

default_cohesion_guide
string
read-only

The platform default guide text that mode=default resolves to.