Validate Slot

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Query Params

organisation_id

integer

required

Organisation to book with

Body Params

The unique ID of the activity

activity_type_id

integer

required

The ID of the activity type

start

date-time

required

The start time (UTC) of the activity e.g 2023-07-27 06:30:00+00

end

date-time

required

The end time (UTC) of the activity e.g 2023-07-27 06:30:00+00

notes

Notes for the activity

recurrence_id

The recurrence ID for the activity

shift_ids

array | null

List of shift IDs to which the activity is joined

patient_ids

array | null

List of patient IDs linked to the activity

archived

Whether activity has been archived

recurrence_details

RecurrenceNew | null

The recurrence details for the activity

external_id

ID linking activity to external integrations, i.e. Healthie, etc

pattern_override_uuid

Slot uuid from the recurrence's pattern_overrides that produced this activity

provider_ids

array | null

Candidate providers to book; one is chosen by availability. Empty means any available provider

first_name

First name of the patient to create when no patient_ids is given

last_name

Last name of the patient to create when no patient_ids is given

Email of the patient to create when no patient_ids is given

state

State of the patient to create when no patient_ids is given

insurance

Insurance of the patient to create when no patient_ids is given

language

Language of the patient to create when no patient_ids is given

birth_date

Date of birth of the patient to create when no patient_ids is given

payor_name

Name of the payor to enroll the patient with when no patient_ids is given; created if it doesn't already exist

200Successful Response

422Validation Error