Skip to content

Update a theme profile

PATCH/v2/competitions/{competitionId}/theme-profiles/{profileId}

PATCH
/v2/competitions/{competitionId}/theme-profiles/{profileId}
curl --request PATCH \
--url https://api.ligr.live/rest/v2/competitions/1/theme-profiles/1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "defaultControlRoomId": 1, "themeVariableValues": [ { "variableId": "example", "value": "example" } ], "automationGamePlanId": 1 }'

Changes a nonarchived theme profile. Omitted fields keep their stored value. themeVariableValues replaces the stored list and must match the variables of the active theme version. automationGamePlanId assigns a game plan of your organization that uses the profile theme and the competition sport. Send null to remove the game plan or the default control room.

LIGR does not push the change to an open overlay. Reload the overlay page to show the new values.

competitionId
required

Entity identifier

integer format: int32
>= 1
profileId
required

Entity identifier

integer format: int32
>= 1
Media typeapplication/json

Changes a theme profile. Omitted fields keep their stored value. themeVariableValues replaces the stored list. A variable that the list leaves out uses the theme default. defaultControlRoomId: null removes the default control room. automationGamePlanId: null removes the game plan. The game plan must use the theme of the profile and the sport of the competition.

object
name

Default Entity name

string
>= 6 characters <= 39 characters
defaultControlRoomId
integer format: int32
>= 1
themeVariableValues
Array<object>
object
variableId
required

Variable id from the theme schema.

string
value
required
Any of:
string
automationGamePlanId
integer format: int32
>= 1
Examplegenerated
{
"name": "example",
"defaultControlRoomId": 1,
"themeVariableValues": [
{
"variableId": "example",
"value": "example"
}
],
"automationGamePlanId": 1
}

Ok

Media typeapplication/json
object
id
required

Entity identifier

integer format: int32
>= 1
competitionId
required

Entity identifier

integer format: int32
>= 1
themeId
required

Entity identifier

integer format: int32
>= 1
name
required
string
defaultControlRoomId
required
integer format: int32
>= 1
automationGamePlanId
required

The game plan that overlay automation runs for matches that use this profile.

integer format: int32
>= 1
isDefault
required
boolean
themeVariableValues
required
Array<object>
object
variableId
required

Variable id from the theme schema.

string
value
required
Any of:
string
Examplegenerated
{
"id": 1,
"competitionId": 1,
"themeId": 1,
"name": "example",
"defaultControlRoomId": 1,
"automationGamePlanId": 1,
"isDefault": true,
"themeVariableValues": [
{
"variableId": "example",
"value": "example"
}
]
}

Request is invalid

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

Missing or invalid api key

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

Api key provides insufficient access for the request

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

Competition, theme, control room, game plan, or profile not found

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

Organization has made too many requests

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

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

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