Create a new appointment

Body Params
string
required

The title of the appointment.

string
required

The type of appointment. Accepted values are ("online", "inperson", "phone", "message").

participants
array of objects
required

A list of participants to invite to the appointment. Maximum 25 participants per appointment.

participants*
int32
required

The length of the appointment in minutes.

string
required

The URL to the division in which to create this appointment. This will be https://api.oncallhealth.ca/divisions/{division_id}/.

string

The URL of the provider. This will be in the form of https://api.oncallhealth.ca/providers/{provider_id}/ and can be obtained using the Providers API. Defaults to the requesting user, so it is optional for providers, but not for coordinators.

date

ISO8601 representation of the datetime when the appointment should be scheduled for. This field is required if "type" is one of ("online", "inperson", "phone").

json

A freeform metadata object. Use this to attach your unique identifiers to an appointment.

Response

Language
Credentials
OAuth2
Request
Response
Choose an example:
application/json