Skip to main content
POST
Submit intake answers (you collect them)

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
enum<string>
required

hormone for hormone-therapy intakes, async for everything else. Any other value returns 422 validation_failed before anything is created.

Available options:
async,
hormone
responses
object
required

The questionnaire answers. The six required fields must be present or the request is rejected 422. Send the rest of the questionnaire too, using the keys in the Intake answers reference.

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: