API Reference

Update a plan

put
https://example.com/api/plans/

Updates a plan with given start date, end date and status. Note that this API does not support changing the goals in the plan, as we have separate APIs for that.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Plan ID

Query Params
string

Supervisor ID

Body Params

Specification of plan to be updated

int32
int64

start date-time of the plan in ms past epoch (which is in UTC)

int64

end date-time of the plan in ms past epoch (which is in UTC)

int64

actual end date-time of the plan in ms past epoch (which is in UTC)

string
enum

status of the plan

Allowed:
int32

DO ID of the supervisor that owns the plan

userGoals
array of objects
userGoals
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Updated 11 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 11 months ago