Internal

Diff (and optionally apply) a plan document against the live board

Parses a plan document, diffs it against the live board (programs, milestones, plan-managed tickets) for the target project, and either reports the diff (mode: dry_run, the default) or applies it (mode: apply). dry_run never touches the DB. apply is refused whole when the diff has conflicts (PLAN_CONFLICT) or when any op fails partway through (PLAN_PARTIAL) — both return the receipt so far for inspection. Board edits are protected (plan rule 11): a field changed on the board since the last sync is reported as a conflict board edit on <kind> <key>: <field> and never overwritten, unless that program, milestone or ticket carries force: true in the plan document (optional boolean per item), which overwrites it with a receipt warning.

post/board/sync-plan

Request

  • Base URL: https://api.apphandoff.com/api
  • URL: https://api.apphandoff.com/api/board/sync-plan
  • Auth: API key in cookie sb-access-token

Request body

project_idstring uuid required
mode'dry_run' | 'apply'
planobject required

The plan document (programs, milestones, tickets) to diff against the board.

Response

Diff report (dry_run) or write receipt (apply)

receiptobject required
diff_summaryobject required
opsobject[]

Full op list — dry_run responses only.

Changes

No recorded changes to this operation across all 1 revision of this API.