Skip to content
SNOW Docs

Create a single-submit intake session (Flow 1)

POST
/v1/intake-sessions

Mints a token + hosted URL for a single-submit pre-visit form. Patient lands on previsit.summary.to/intake/<token>, fills the form, submits once. Form schema is resolved server-side from the catalog by specialty.

Use this for low-friction WhatsApp/SMS pre-visit forms with no uploads or voice. For uploads/voice, use POST /v1/sessions (Flow 2) instead.

Authorizations

Parameters

Header Parameters

Idempotency-Key

Optional UUID to deduplicate retries. 24h TTL.

string format: uuid

Request Body required

object
specialty
required
string
obstetrics
patient_id
string format: uuid
nullable
appointment_id
string format: uuid
nullable
expires_in_minutes
integer
default: 60
surface
string
default: previsit
Allowed values: previsit intake discharge referral emergency 
{
  "specialty": "obstetrics",
  "patient_id": "c2c5...",
  "appointment_id": "7f4a..."
}

Responses

201

Intake session created

object
session_id
string format: uuid
token
string
intake_url
string format: uri 
https://previsit.summary.to/intake/9jiGQhmCV9VEDNR0bK4UT6gI
specialty
string
obstetrics
expires_at
string format: date-time
created_at
string format: date-time

400

Validation error

object
error
required
string
Invalid link
code
integer
1003

401

Invalid API key

object
error
required
string
Invalid link
code
integer
1003

404

Patient not found in this tenant

object
error
required
string
Invalid link
code
integer
1003

429

Daily quota exceeded

object
error
required
string
Invalid link
code
integer
1003