Skip to content
Developers

Update a preset

PUT/v2/control-rooms/{roomId}/presets/{presetId}

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

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

Renames or moves a preset, or replaces its variable set from the active published manifest. Send variableValues and exposeVariables together; the stored set becomes exactly what you send. Position, scale and other dashboard settings on the preset are kept. A variable that stays in the set keeps its dashboard display type, exit mode and hidden state; naming it in exposeVariables shows it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
roomId
required

Entity identifier

integer format: int32
>= 1
presetId
required

Entity identifier

integer format: int32
>= 1

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Omitted fields keep their stored value. When variableValues or exposeVariables is present, the preset’s variable set is replaced from the active published graphic manifest. Variables that stay in the set keep their dashboard display type, exit mode and hidden state.

object
name
string
>= 1 characters <= 80 characters
sectionId

Moves the preset to the end of another section of the same room.

string
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
{
  "name": "example",
  "sectionId": "example",
  "variableValues": {
    "additionalProperty": "example"
  },
  "exposeVariables": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Ok

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"
}