Desk

Preview Account Plan

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.

post/desk/accounts/{account_id}/plan/preview

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/desk/accounts/{account_id}/plan/preview
  • Auth: HTTP bearer

Path parameters

account_idinteger required

The account's mashup company id (cb_account_plans.account_id).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

instructionstring nullable

Free-text note echoed back with the diff.

Response

Successful Response

dataAccountPlanPayload required

An open envelope for a plan, a context read or a committee result.

Changes

No recorded changes to this operation across all 2 revisions of this API.