API Reference

Creates a new case

post
https://my.proximie.net/api/v2/cases

Returns a new Case with PROCESSING status.

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

Request for creating a new Case

uuid

Case id

uuid
required

Organisation id

uuid

sessionId of the proximie session it came from, if supplied title, description, scheduledDateTime, owner id and speciality id will be copied from the session

string

Name of the speciality of the edited clip as in the Speciality Taxonomy.

string
required

The title of the case - should not contain PII

string
required

A more detailed description of the case

string

Scheduled datetime of the Session in ISO-8061 format

string
deprecated

Scheduled Datetime of the Video Session in ISO-8061 format

string
required

The Proximie profile id of the owner of the case

number
deprecated

The id of the proximie speciality deprecated as we should use the speciality field

boolean

If true only Case owner can view

string

The ID from the migrated session

uuid

UUID of the case this case is being edited from if applicable

string
enum

Initial status of the case

string
enum

How the Case was created

Allowed:
string

The version of the case

string
enum

The visibility of the case

Allowed:
Responses

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?