---
title: "Apply Account Plan"
method: POST
path: "/desk/accounts/{account_id}/plan/apply"
tags: ["Desk"]
---

# Apply Account Plan

`POST /desk/accounts/{account_id}/plan/apply`

## Request

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

Persist the approved steps as a NEW plan version, and return the diff.

`proposed_plan` must be non-empty. Apply REPLACES the account's steps, so
an empty proposal would blank an active plan; the app answers 400 rather
than doing it. Prior versions stay immutable and readable.

## Path parameters

- `account_id` integer, required: The account's mashup company id (`cb_account_plans.account_id`).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- AccountPlanApplyRequest: Persist the approved steps as a NEW plan version. `proposed_plan` must be non-empty: apply REPLACES the account's steps, so an empty proposal would blank the plan. The app answers 400 rather than doing it, and this surface forwards that rather than second-guessing it.
  - `proposed_plan` AccountPlanStep[]
    - `step_id` string, required: Caller-assigned id, stable across versions.
    - `contact_id` unknown
    - `channel` string, nullable
    - `scheduled_at` string, nullable
    - `why_now` string, nullable
    - `draft_content` string, nullable
    - `approval_status` 'pending' | 'approved' | 'rejected' | 'edited'
    - `status` string, nullable
  - `trigger` string: What caused this (re)plan.
  - `status` string, nullable: draft | active | paused | archived.
  - `rationale` string, nullable
  - `instruction` string, nullable

## Response `200`

Successful Response

- ApiResponseAccountPlanPayload
  - `data` AccountPlanPayload, required: An open envelope for a plan, a context read or a committee result.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)