POST
/
workspace
/
sessions
/
{workspaceId}
curl --request POST \
  --url https://api.hyra.io/workspace/sessions/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "external_description": "<string>",
  "public_start_offset": 123,
  "public_slock_offset": 123,
  "series_start_date": "2023-11-07T05:31:56Z",
  "game_link": "<string>",
  "publish_to_discord": true,
  "disable_cohost": true,
  "roles": [
    "<string>"
  ],
  "reoccurring": true,
  "cron_expression": "<string>"
}'
{
  "_id": "<string>",
  "workspace": "<string>",
  "name": "<string>",
  "external_description": "<string>",
  "public_start_offset": 123,
  "public_slock_offset": 123,
  "series_start_date": "2023-11-07T05:31:56Z",
  "game_link": "<string>",
  "publish_to_discord": true,
  "roles": [
    "<string>"
  ],
  "disable_cohost": true,
  "game_thumbnail_url": "<string>",
  "reoccurring": true,
  "cron_expression": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Body

application/json
name
string
required
external_description
string
required
public_start_offset
number
required
public_slock_offset
number
required
series_start_date
string
required
roles
string[]
required
reoccurring
boolean
required
publish_to_discord
boolean
disable_cohost
boolean
cron_expression
string

Response

200 - application/json
Default Response
_id
string
required
workspace
string
required
name
string
required
external_description
string
required
public_start_offset
number
required
public_slock_offset
number
required
series_start_date
string
required
publish_to_discord
boolean
required
roles
string[]
required
disable_cohost
boolean
required
reoccurring
boolean
required
game_thumbnail_url
string
cron_expression
string