Docs
API ReferenceapiliveDELETE /v1/admin/sessions/{id}

DELETE /v1/admin/sessions/\{id\}

Service: live · operationId: (none)

Cancel/delete a live session (admin)

Required scopes

(no scope declared — review service config)

Path parameters

  • id (string) required —

Responses

200 Session cancelled

{
  "type": "object",
  "properties": {
    "deleted": {
      "type": "boolean",
      "enum": [
        true
      ]
    }
  },
  "required": [
    "deleted"
  ]
}

404 Not found

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

412 Cannot delete session in current status

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X DELETE https://live.platform.loop.health/v1/admin/sessions/{id} \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Related

OverviewDELETE /v1/questions/{id}