Update an overlay

POST

/v1/overlays/{overlayId}

curl --request POST \
  --url https://api.ligr.live/rest/v1/overlays/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "encodingDelay": 1, "adType": "free", "competitionThemeSettingId": 1, "controlRoomId": 1, "autoMode": true }'

• LIGR REST API

Update an existing overlay.

Authorizations

• bearer
  overlays:write
• api_key
  overlays:write

Parameters

Path Parameters

overlayId

required

Entity identifier

integer format: int32

>= 1

The overlay id

Request Body^required

Media typeapplication/json

object

name

Match name

string

>= 5 characters <= 42 characters

encodingDelay

Graphics delay in seconds. The overlay holds every graphic back by this much, so the graphics land on the delayed picture of the stream.

integer format: int32

<= 60

adType

string

Allowed values: free brands noBrands

competitionThemeSettingId

Entity identifier

integer format: int32

>= 1

controlRoomId

integer format: int32

nullable >= 1

autoMode

Auto Graphics. When true, the automation of the match fires the graphics on this overlay.

boolean

Responses

204

No content

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Overlay not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

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

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}