Skip to main content
POST
Create plan

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Body

application/json
name
string
required

Plan name

status
enum<string>
required

Plan Status

Available options:
draft,
active
schedule
Schedule · object
required

Duration of the plan

description
string | null

Product Description

phases
CreatePlanPhaseRequestSchema · object[] | null

Plan Phases

Response

Successful Response

id
string<uuid>
required

Plan ID

name
string
required

Plan name

status
enum<string>
required

Plan Status

Available options:
draft,
active
schedule
Schedule · object
required

Schedule of the plan

created_at
string<date-time>
required

Plan created at

updated_at
string<date-time>
required

Plan updated at

description
string | null

Product Description

phases
PlanPhaseResponseSchema · object[] | null

Plan Phases

plan_version
PlanVersionResponseSchema · object | null

Plan Version