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. Actual prices/floors/currencies belong in Selling Terms; brand/operator discounts belong in Buyer Discounts and Buyer Instructions; storefront markets belong in Business Profile; advertiser/category/creative eligibility belongs in Acceptance Policy.

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.

Response

Create a new operating-instructions version

A single operating-instructions version for a storefront. Versions are immutable; updates produce a new row.

id
string
required

Surrogate id of the version row (BIGINT serialized as string).

Example:

"42"

storefrontId
string
required

Storefront the version belongs to (BIGINT serialized as string).

Example:

"1234"

version
integer
required

Per-storefront version number. Monotone, never reused. The first version a storefront authors is 1.

Required range: 1 <= x <= 9007199254740991
Example:

3

content
string
required

Markdown body consumed by the Merchandising Agent.

notes
string | null
required

Operator note about why this version was authored.

isActive
boolean
required

Whether this version is the Storefront's active operating instructions (the version the Merchandising Agent will use on the next composition).

createdAt
string<date-time>
required

Creation timestamp (ISO 8601). Rows are immutable so there is no updatedAt.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
createdBy
string | null
required

User id of the operator who authored the version (BIGINT serialized as string). Null when authored by a system or service-token caller.

ownershipIssues
object[]
required

Canonical-ownership conflicts detected in this immutable version. Empty for versions that keep pricing, discounts, markets, and acceptance facts in their owning storefront surfaces.