Skip to main content
POST
Submit a completed intake (with answers, idempotent)

Authorizations

Authorization
string
header
required

API key issued by VitaRelay. Send as Authorization: Bearer vr_live_… (production) or Authorization: Bearer vr_test_… (sandbox).

Body

application/json

Exactly one of patient_id or external_patient_id is required.

category
string
required
responses
object
required

Free-form intake answers.

patient_id
string

Patient UUID, or a sandbox_pat_… id when using a test key.

external_patient_id
string
form_type
string
external_intake_id
string

Your identifier for this intake. Acts as an idempotency key.

Response

Idempotent replay of an existing external_intake_id.

data
object
Example: