API Reference

Create new organisation

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

Create a new organisation with the details provided

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

The search param used in search operations

Body Params

Request to Create an Organisation

Organisation information

string
required

The name of the Organisation

string
required

The Organisation type

boolean
required

Capability to allow for an image to be overlayed

boolean
required

Can the Organisation be viewed publicly

boolean
required

Does the Organisation allow recording of its Sessions

boolean

Are the Analytics and Insights enabled for this organisation

boolean

Is Analytics and Insights live streaming enabled for this organisation

boolean
required

Does the Organisation allow quick reschedule action of its Sessions

boolean
required

Does the Organisation allow starting the Session before it's scheduled time

boolean

Does the Organisation allow creating the Session from front-end side.

boolean
required

Is video sharing allowed in this Organisation

boolean
required

Are wearables enabled in this Organisation

string
required

The country where the Organisation lives in ISO 3166-1 alpha-3

string
required

An id that maps the organisation to an external system

number | null

The cases retention period in days. The minimum value is 30.

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?