API Reference

Create Sessions

post
https://my.proximie.net/api/v2/organisations//sessions

Used to create Sessions within an Organisation

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

the Organisation identifier, as organisation_id

Body Params

Request used to create a Session

string
required

Name of the Video Session

string
deprecated

Date and time of the Video Session in ISO-8061 format. This parameter is deprecated, please use scheduledAt instead.

string

Date and time of the Video Session in ISO-8061 format. Note this parameter is required.

number
required

duration in milliseconds

string
required

Session Speciality as in Speciality Taxonomy

string

Surgical Type as in Surgical Type Taxonomy

string

The uuid of the patient

string
required

Value of SessionAccess taxonomy

string

A comment as to what the Session is for

string
deprecated

Session Facility the facility is uuid

string
deprecated

the uuid of the session's room, should belong to the facility

uuid

The Id of the user to be assigned as a session owner.

participants
array of objects
participants
string
enum

The status of the session

Allowed:
Headers
string

the timezone of the current user

string
required

The User's JWT passed as Bearer token

Responses

Updated 7 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago