Skip to main content
POST
Send a hosted intake link

Authorizations

Authorization
string
header
required

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

Path Parameters

patientId
string<uuid>
required

Body

application/json
category
enum<string>
required

hormone for hormone-therapy intakes, async for everything else.

Available options:
async,
hormone
send
boolean
default:true

true (default) also emails and texts the patient the link. false only returns the link for you to deliver yourself.

Response

Intake link created or reused.

data
object