API Reference

Update Session

patch
https://my.proximie.net/api/v2/sessions/

Change the details regarding a Session

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

the Session identifier, as session_id

Body Params

Update Session properties

The request body for updating a session

string

Name of the Video Session

string

Date and time of the Video Session in ISO-8061 format

number
deprecated

duration in milliseconds. This parameter is deprecated, please use estimatedDuration instead.

number

duration in milliseconds

string | null

The uuid of the patient

string

Session Speciality as in Speciality Taxonomy

string

Surgical Type as in Surgical Type Taxonomy

string

Value of SessionAccess taxonomy

string

A comment as to what the Session is for

string | null

Session Facility the facility is uuid

string | null

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:
userGroupIds
array of uuids

The ids of the user groups associated with the session

userGroupIds
Headers
string

the timezone of the current user

Responses
204

Session updated successfully

Updated about 2 months ago

Did this page help you?
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 about 2 months ago

Did this page help you?