Skip to Content
APIEndpointsNarrative edit

Brand Alignment: edit the narrative

PATCH /v1/brands/:brand_id/alignment/narrative/:position_id

Access is limited to the brands permitted by your credential. Requires write:alignment. Workspace API keys and signed-in MCP sessions are supported.

Writes require an active workspace entitlement and an Idempotency-Key header. Support memberships cannot write.

Request body

Only the fields below are accepted. Identifiers in the URL cannot be overridden in the body.

FieldRequiredDescription
statementNoThe new wording. Only until a scan has read it.
directionNoknown for Should Say, avoid for Should Not Say.

Response

The standard API envelope places the result in data, with request_id beside it at the top level.

Give at least one field. position_id is an id from the narrative endpoint. Once a scan has read an entry its wording is fixed, so results stay comparable: the request returns invalid_input, and you remove it and add a new one. Its direction can always change. A new wording gets a new id. Returns position, slots, applies_from and url, and warning as for adding.

Last updated on