Create a care plan

post/v1/care-plans

Creates a care plan and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff. Requires a key with write scope.

Authorization

Authorization: Bearer ak_...requiredscope: read + write

An AveeCare API key created in Settings → API Keys. This endpoint changes data, so the key needs read + write scope. About authentication

Headers

Idempotency-Key

stringmax length 255

A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.

Request body

application/json

patientId

stringrequiredmax length 64

The patient the plan is for.

title

stringrequiredmax length 200

Plan title.

status

string | null

Where the plan is in its lifecycle.

One ofActiveDraftArchivedUnderReviewCompletedDiscontinuednull

serviceType

string | nullmax length 100

Type of service the plan covers.

frequency

string | nullmax length 200

How often visits happen under the plan.

startDate

string · date | null

Date the plan takes effect.

endDate

string · date | null

Date the plan ends; null if open-ended.

reviewDate

string · date | null

Date the plan is next due for review.

reviewIntervalDays

integer | nullmin 1

Days between reviews.

Response

201

The new care plan.

object

stringread-only

String representing the object's type. Always care_plan.

stringread-only

Unique identifier of the care plan.

patientId

string | nullmax length 64

The patient the plan is for.

title

string | nullmax length 200

Plan title.

status

string | null

Where the plan is in its lifecycle.

One ofActiveDraftArchivedUnderReviewCompletedDiscontinuednull

serviceType

string | nullmax length 100

Type of service the plan covers.

frequency

string | nullmax length 200

How often visits happen under the plan.

startDate

string · date | null

Date the plan takes effect.

endDate

string · date | null

Date the plan ends; null if open-ended.

reviewDate

string · date | null

Date the plan is next due for review.

reviewIntervalDays

integer | nullmin 1

Days between reviews.

lastReviewedAt

string · date-time | nullread-only

When the plan was last reviewed.

lastReviewedByName

string | nullread-onlymax length 2000

Who last reviewed the plan.

createdByName

string | nullread-onlymax length 2000

Who created the plan.

createdAt

string · date-time | nullread-only

When the care plan was created.

updatedAt

string · date-time | nullread-only

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.

Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.

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`).
409	n/a	The `Idempotency-Key` was already used with a different request, or that request is still running (`idempotency_conflict`).
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.