Change the stream overlay

POST

/v1/streams/{streamSettingsId}/overlay/change

curl --request POST \
  --url https://api.ligr.live/rest/v1/streams/1/overlay/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "overlayId": 1 }'

• LIGR REST API

Change which overlay is linked to a stream, or unlink the current overlay.

Authorizations

• bearer
  streams:write
• api_key
  streams:write

Parameters

Path Parameters

streamSettingsId

required

Entity identifier

integer format: int32

>= 1

The stream settings identifier

Request Body^required

Media typeapplication/json

object

overlayId

required

integer format: int32

nullable

Example^generated

{
  "overlayId": 1
}

Responses

200

Ok

Media typeapplication/json

object

success

required

boolean

Example^generated

{
  "success": true
}

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

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