Skip to content
Developers

Create a preset

POST/v2/control-rooms/{roomId}/presets

POST
/v2/control-rooms/{roomId}/presets
curl --request POST \
  --url https://api.ligr.live/rest/v2/control-rooms/1/presets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sectionId": "example", "graphicId": "example", "name": "example", "variableValues": { "additionalProperty": "example" }, "exposeVariables": [ "example" ] }'

Beta. This operation can change between minor versions. See Beta status.

Values use control-variable names from the active published code or Rive graphic manifest. Values support string, number, boolean, and enum variables. Use exposeVariables to show fact, stat, team, player and match variables that operators set live. The overlay controls the reserved hide variable.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
roomId
required

Entity identifier

integer format: int32
>= 1

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
sectionId
required

Identifier returned when creating or reading a section of this room.

string
graphicId
required

Stable graphic UUID from the theme’s code or Rive graphics.

string
name
required
string
>= 1 characters <= 80 characters
variableValues

Scalar and enum overrides keyed by names in the active published graphic manifest.

object
key
additional properties
Any of:
string
exposeVariables

Names of control variables to expose in the control room without a value. Use this for fact, stat, team, player and match variables; operators pick the value live.

Array<string>
Examplegenerated
{
  "sectionId": "example",
  "graphicId": "example",
  "name": "example",
  "variableValues": {
    "additionalProperty": "example"
  },
  "exposeVariables": [
    "example"
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json

Use the returned id as presetId with the overlay control-room graphics endpoint.

object
id
required

Entity identifier

integer format: int32
>= 1
controlRoomId
required

Entity identifier

integer format: int32
>= 1
sectionId
required
string
graphicId
required
string
name
required
string
orderIndex
required
integer format: int32
variableValues
required

Scalar and enum overrides keyed by names in the active published graphic manifest.

object
key
additional properties
Any of:
string
exposedVariables
required

Every control variable operators can see on this preset, with or without a stored value.

Array<string>
Examplegenerated
{
  "id": 1,
  "controlRoomId": 1,
  "sectionId": "example",
  "graphicId": "example",
  "name": "example",
  "orderIndex": 1,
  "variableValues": {
    "additionalProperty": "example"
  },
  "exposedVariables": [
    "example"
  ]
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Theme, control room, section, or graphic not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}