post `/intakes`

Create intake data object

Base URL https://api.vseepreview.com/api_v3 · operationId createIntake

Authentication: User Token — Requires a user access token from login or SSO.

Create a new intake object. Supports custom JSON field-value pairs.

Parameters

Name	In	Type	Required	Description
`X-ApiToken`	header	string	yes	API token (e.g. your_api_token)
`X-AccountCode`	header	string	yes	Account code (e.g. vclinic)
`provider_id`	query	integer	no	The ID of the provider who is being visited (optional) (e.g. 541)
`reason_for_visit`	query	string	no	Reason for visit (optional) (e.g. Test intake functionalities)
`type`	query	integer	no	Visit type: 1=walkin, 2=schedule (optional) (e.g. 1)
`member_id`	query	string	no	Patient's code ID (optional) (e.g. 508)
`room_code`	query	string	yes	Room's code (e.g. ceproom1)
`location`	query	string	no	State location code like CA, AL (optional) (e.g. CA)
`phone`	query	string	no	Patient phone number (optional) (e.g. 7123465789)

Request body

Content type: application/x-www-form-urlencoded

Example:

null

Responses

`200` — Intake created successfully

Basic intake — Create basic intake

{
  "data": {
    "id": "56e8c536-566c-44b6-bbca-66f0ac1f0144"
  }
}

Intake with custom fields — Create intake with custom parameters

{
  "data": {
    "id": "56e8c536-566c-44b6-bbca-66f0ac1f0144",
    "custom_is_allergic": "Yes",
    "custom_symptoms": "Rash, Red Eyes",
    "custom_symptoms_duration": "2 weeks"
  }
}

`400` — Bad request - missing required parameters

{
  "error": "Unauthorized",
  "message": "Invalid or missing API token"
}

`401` — Unauthorized - invalid or missing API token

{
  "error": "Unauthorized",
  "message": "Invalid or missing API token"
}

Machine-readable: OpenAPI JSON (operationId: createIntake)

post /intakes