Update a theme profile
PATCH/v2/competitions/{competitionId}/theme-profiles/{profileId}
const url = 'https://api.ligr.live/rest/v2/competitions/1/theme-profiles/1';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","defaultControlRoomId":1,"themeVariableValues":[{"variableId":"example","value":"example"}],"automationGamePlanId":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Entity identifier
Entity identifier
Request Bodyrequired
Section titled “Request Bodyrequired”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
Examplegenerated
{ "name": "example", "defaultControlRoomId": 1, "themeVariableValues": [ { "variableId": "example", "value": "example" } ], "automationGamePlanId": 1}Responses
Section titled “Responses”Ok
object
Entity identifier
Entity identifier
Entity identifier
The game plan that overlay automation runs for matches that use this profile.
Examplegenerated
{ "id": 1, "competitionId": 1, "themeId": 1, "name": "example", "defaultControlRoomId": 1, "automationGamePlanId": 1, "isDefault": true, "themeVariableValues": [ { "variableId": "example", "value": "example" } ]}Request is invalid
object
object
Examplegenerated
{ "message": "example", "details": { "additionalProperty": "example" }}Missing or invalid api key
object
Examplegenerated
{ "message": "example"}Api key provides insufficient access for the request
object
Examplegenerated
{ "message": "example"}Competition, theme, control room, game plan, or profile not found
object
Examplegenerated
{ "message": "example"}Organization has made too many requests
object
Examplegenerated
{ "message": "example"}An unexpected error has occured. If problems persist please contact support
object
Examplegenerated
{ "message": "example"}