Skip to main content

Create a Session

This command creates a new session and returns a session ID. The session ID is required in later commands. 

Authorizations: All

Requests

createSession sessionTitle

Parameters

ParameterDescription/Values

sessionTitle

Enter a title for the session.

Note

The title must be enclosed in quotes if it contains one or more spaces.

Result

Success

sessionId

Error

ErrorDescription
ERROR|010003|Expected 1 parameter(s). Got Y parameter(s)
Calling createSession requires 1 parameter.
ERROR|010001|Session name must be at least 1 character
The session title cannot be empty string " ".
ERROR|070019|Failed to create a session
Creating a new session failed. Please see calypso.log for details.

Example

The following example creates a session entitled “Test Session1”. The system returns OK and the ID of the new session.

createSession "Test Session1"
OK|71edd346-2cf0-4c62-b3d3-9d457b287394

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.