Create a referral

post/v1/referrals

Creates a referral 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

referralSourceId

string | nullmax length 64

Who made the referral.

patientId

string | nullmax length 64

The patient record, once one exists.

patientName

stringrequiredmax length 200

Name of the person referred.

contactPhone

string | nullmax length 30

Phone number to reach the person or their family.

contactEmail

string · email | nullmax length 320

Email address to reach the person or their family.

referralDate

string · date-time | null

When the referral arrived.

status

string | null

Where the referral stands.

One ofNewContactedAssessmentScheduledAssessmentCompletedServiceAgreementSentAdmittedDeclinedLostnull

estimatedCareNeeds

string | nullmax length 20000

Care the person is expected to need.

estimatedWeeklyHours

number | nullmin 0

Expected hours of care per week.

urgencyLevel

string | nullmax length 50

How soon care is needed.

declineReason

string | nullmax length 20000

Why the referral was declined or lost.

notes

string | nullmax length 20000

Notes.

Response

201

The new referral.

object

stringread-only

String representing the object's type. Always referral.

stringread-only

Unique identifier of the referral.

referralSourceId

string | nullmax length 64

Who made the referral.

patientId

string | nullmax length 64

The patient record, once one exists.

patientName

string | nullmax length 200

Name of the person referred.

contactPhone

string | nullmax length 30

Phone number to reach the person or their family.

contactEmail

string · email | nullmax length 320

Email address to reach the person or their family.

referralDate

string · date-time | null

When the referral arrived.

status

string | null

Where the referral stands.

One ofNewContactedAssessmentScheduledAssessmentCompletedServiceAgreementSentAdmittedDeclinedLostnull

estimatedCareNeeds

string | nullmax length 20000

Care the person is expected to need.

estimatedWeeklyHours

number | nullmin 0

Expected hours of care per week.

urgencyLevel

string | nullmax length 50

How soon care is needed.

declineReason

string | nullmax length 20000

Why the referral was declined or lost.

notes

string | nullmax length 20000

Notes.

convertedDate

string · date-time | nullread-only

When the person was admitted as a client.

createdAt

string · date-time | nullread-only

When the referral was created.

updatedAt

string · date-time | nullread-only

When the referral 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.