Update a care plan
/v1/care-plans/{id}Changes the fields you send and returns the updated care plan. Send null to clear an optional field. Available to keys belonging to office staff. Requires a key with write scope.
Path parameters
ID of the care plan.
Request body
application/jsonPlan title.
Where the plan is in its lifecycle.
ActiveDraftArchivedUnderReviewCompletedDiscontinuednullType of service the plan covers.
How often visits happen under the plan.
Date the plan takes effect.
Date the plan ends; null if open-ended.
Date the plan is next due for review.
Days between reviews.
Response
200The updated care plan.
String representing the object's type. Always care_plan.
Unique identifier of the care plan.
The patient the plan is for.
Plan title.
Where the plan is in its lifecycle.
ActiveDraftArchivedUnderReviewCompletedDiscontinuednullType of service the plan covers.
How often visits happen under the plan.
Date the plan takes effect.
Date the plan ends; null if open-ended.
Date the plan is next due for review.
Days between reviews.
When the plan was last reviewed.
Who last reviewed the plan.
Who created the plan.
When the care plan was created.
When the care plan was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.