Edit a Session Event

Edits an event associated with the session.

Authorizations: Sessions - EDIT

Requests

PUT /apis/sessions/:sessionId/events/:eventId

{
  "startTime": 1592344800,
  "duration": 3600
  "type": "weekly-recurring",
  "typeData": {
    "days": ["TUE", "THU", "SUN"]
  },
  "command": "set-live",
  "parameters": {
    "record": true
  },
  "active": true
}

Response

Success

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

Error

Code

Payload

Description

{"code":"010000", "name":"BadRequest",
 "message":<Error message>,
 "httpStatusCode":400}

Supplied data was insufficient or incorrect.

{"code": "040006",
 "name":"SessionNotFound",
 "message":"Session not found",
 "httpStatusCode": 404}

Session id in API call was not found.

{ "code": "040031",
 "name": "ScheduledEventNotFound",
 "message": "Scheduled event not found",
 "httpStatusCode": 404 }

Event id in API call was not found.