Skip to main content
POST
Create a new operating-instructions version

Authorizations

Authorization
string
header
required

API key or access token

Body

application/json

Request body for creating a new operating-instructions version and optionally activating it atomically.

content
string
required

Markdown body the merchandising agent will use for product packaging, naming, selection, and explanation. Structured prices/floors/currencies belong in Playbook pricing; brand/operator discounts belong in Buyer Discounts and Buyer Instructions; buyer-visible channels and accepted countries belong in the listing; Product Marketing Media Kits are source material only; advertiser/category/creative eligibility belongs in AI Business Rules.

Required string length: 1 - 50000
notes
string

Operator note describing why this version was created (e.g. "tighten brand-safety rules"). Not surfaced to buyers; visible in the version history UI.

Maximum string length: 2000
activate
boolean
default:false

When true, create and activate this immutable version atomically. Defaults to false.

doctrine
object

The selling doctrine this version carries (AI-5870): the qualification strategy the merchandising agent applies BEFORE it composes anything — when to pitch in full, when to counter-pitch with a reframe, and when to pass with a branded decline. Supply exactly one of variant or thresholds; supplying both is rejected. Omit the whole object to carry no doctrine, which composes under the platform default (every brief the catalogue can serve gets a full pitch). Doctrine is versioned and activated exactly like the prose above, because it IS these instructions grown: reverting is activating the prior version.

Response

A storefront converted the deprecated Playbook prose into proposed Lessons; its active operating instructions are unchanged.

Temporary response for a deprecated Playbook write converted to proposed Lessons.

activeUnchanged
enum<boolean>
required

The active operating-instructions revision was not changed by this deprecated Playbook write.

Available options:
true
lessonsProposed
object[]
required

Proposed seller Lessons created from the submitted Playbook prose.

Maximum array length: 50
deprecated
enum<boolean>
required

This accepted legacy Playbook write is deprecated.

Available options:
true
partial
enum<string>

Present when the conversion reached its 50-Lesson cap and the remaining Playbook prose needs manual review.

Available options:
review_remaining_playbook_manually