Skip to content

Draft Account Plan

POST
/desk/accounts/{account_id}/plan/draft

SPENDS CREDITS. Let the desk draft the committee and the first steps.

This runs the same producer the desk runs automatically, and it counts against the org’s max_auto_account_plans_per_day cap - which is what makes it a spend rather than a write.

409 when a plan already exists: this only creates a FIRST version. Replan an existing one with POST .../plan (caller-authored, free) or from a review card with POST /desk/decisions/{id}/replan (charged). 422 when the company has no contacts to plan around yet.

Authorizations

Parameters

Path Parameters

account_id
required

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

integer
>= 1

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

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

201

Successful Response

object
data
required

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

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string