Skip to main content

Create a Session Event

Creates an event associated with a session.

Authorizations: Sessions - EDIT

Requests

POST /apis/sessions/:sessionId/events
{
  "module": "session",
  "startTime": 1592344800,
  "duration": 7200,
  "type": "weekly-recurring",
  "typeData": {
    "days": ["MON", "WED", "SAT"]
  },
  "command": "set-live",
  "parameters": {
    "record": true
  },
  "active": true
}

Response

Success

{
"data": {
    "moduleId": "ccf00271-adda-42b4-895f-bb54338fb932",
  "module": "session",
    "startTime": 1592344800,
    "duration": 7200,
    "type": "weekly-recurring",
    "typeData": {
      "days": [ "MON", "WED", "SAT" ]
    },
    "command": "set-live",
    "parameters": { "record": true },
    "active": true,
    "id": "e808eb59-00c4-4a2e-a0e1-b06a693c7736"
  }
}

Error

HTTP Status Code

Payload

 Description

400
{"code":"010000", "name":"BadRequest",
"message":<Error message>,
"httpStatusCode":400}
Supplied data was insufficient or incorrect.
404
{"code":"040006", "name":"SessionNotFound",
"message":"Session not found",
"httpStatusCode":404}

Session id in API call was not found.

 

JavaScript errors detected

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

If this problem persists, please contact our support.