v1

latestOpenAPI 3.0.02026-07-14498851.7 MB
action plans

Create new factor score improvement plan

post/plans/factor-score-improvement

Request body

namestring

plan name

descriptionstring

plan description

due_datestring date-time required

the plan due date

scorecardstring required

the scorecard which the plan is for

guestsstring[] required

list of guests (user emails) that can access to the plan

editorsstring[]

list of editors (user emails) that can edit the plan

share_with_domainboolean

Whether the plan should be shared with the domain

Example request

{
  "name": "Example Plan",
  "description": "A plan description",
  "scorecard": "example.com",
  "guests": [],
  "editors": []
}

Response

new plan id