Get or Create a Client Session
Get a client session with specific characteristics or create it if it does not yet exist
Gets a client session with specific characteristics or create a new client session with these characteristics if it does not yet exist.
/client_sessions/get_or_create
OK
Request
Specify any combination of desired client session characteristics by including the corresponding parameters in the request body.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
| String Optional | Your own internal user ID for the user to associate with the client session (or that is already associated with the existing client session) |
| Array of strings Optional | Array of IDs of the Connect Webviews to associate with the client session (or that are already associated with the existing client session) |
| Array of strings Optional | Array of IDs of the connected accounts to associate with the client session (or that are already associated with the existing client session) |
| Array of strings Optional | Array of IDs of the user identities to associate with the client session (or that are already associated with the existing client session) |
| String Optional | Date and time at which the client session should expire (or at which the existing client session expires) |
Sample Request
Response
Returns a client_session
containing the following properties:
Property | Description |
---|---|
| Client session token associated with the client session |
| ID of the workspace that contains the client session |
| Your own internal user ID for the user |
| ID of the client session |
| Date and time at which the client session was created |
This response also includes a Boolean ok
status indicator.
Sample Response
Last updated