Preview Account Plan
POST /desk/accounts/{account_id}/plan/preview
Diff a proposed plan against the current version. WRITES NOTHING.
POST only because the proposed plan is a body. It persists nothing, spends nothing and does not consume the signal-replanner cooldown, so it is tiered a READ - a read-only key must be able to see what an apply would change before anyone applies it.
Authorizations
Parameters
Path Parameters
The account’s mashup company id (cb_account_plans.account_id).
The account’s mashup company id (cb_account_plans.account_id).
Header Parameters
Request Body required
Diff a proposed plan against the current version. Persists NOTHING.
It also does not consume the signal-replanner cooldown, so a caller can
preview as often as it likes before committing with /plan/apply.
object
One step in a plan: who to reach, on what channel, when, and why now.
extra="allow" mirrors the app’s own model, which is also open - the step
shape carries per-channel extras the desk adds as it learns new channels,
and a closed mirror would DROP them on the way in rather than pass them
through.
approval_status is closed because it reaches a real Literal inside the
handler: a free value would raise there and escape as a 500 instead of a
422 naming the four states.
object
Caller-assigned id, stable across versions.
Responses
200
Successful Response
object
An open envelope for a plan, a context read or a committee result.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error