AveeCare

Create a contact

post/v1/contacts

Creates a contact 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 this contact belongs to.

name
stringrequiredmax length 200

Full name.

relationship
string | nullmax length 100

Relationship to the patient.

phoneNumber
string | nullmax length 30

Phone number.

email
string · email | nullmax length 320

Email address.

preferEmail
boolean | null

Whether the contact prefers email over phone.

emergencyContact
boolean | null

Whether this person is an emergency contact.

notificationPolicy
string | null

Which updates the contact is notified about.

One ofAllEmergenciesnull

Response

201

The new contact.

object
stringread-only

String representing the object's type. Always contact.

id
stringread-only

Unique identifier of the contact.

patientId
string | nullmax length 64

The patient this contact belongs to.

name
string | nullmax length 200

Full name.

relationship
string | nullmax length 100

Relationship to the patient.

phoneNumber
string | nullmax length 30

Phone number.

email
string · email | nullmax length 320

Email address.

preferEmail
boolean | null

Whether the contact prefers email over phone.

emergencyContact
boolean | null

Whether this person is an emergency contact.

notificationPolicy
string | null

Which updates the contact is notified about.

One ofAllEmergenciesnull
createdAt
string · date-time | nullread-only

When the contact was created.

updatedAt
string · date-time | nullread-only

When the contact 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

StatusCodeMeaning
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.