STstreamelements

overlays

/:channel/action/:action

Changed on Feb 7, 2021

Overlay/Alerts control

put/overlays/{channel}/action/{action}

Request

Base URL
https://api.streamelements.com/kappa/v2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://api.streamelements.com/oauth2/authorize
  Token URLhttps://api.streamelements.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/streamelements/apis/se-api-docs/docs/overlays/:channel/action/:action/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

actionstring required

string - one of reload, mute, unmute, pause, play

Changes

Feb 7, 20218c745ed2e9e4 Revision changes
- warning
  the optional response header Access-Control-Allow-Credentials removed for the status 201
- warning
  the optional response header Access-Control-Expose-Headers removed for the status 201
- warning
  the optional response header ETag removed for the status 201
- warning
  the optional response header Server removed for the status 201
- warning
  the optional response header Strict-Transport-Security removed for the status 201
- warning
  the optional response header X-Content-Type-Options removed for the status 201
- warning
  the optional response header X-DNS-Prefetch-Control removed for the status 201
- warning
  the optional response header X-Download-Options removed for the status 201
- warning
  the optional response header X-Frame-Options removed for the status 201
- warning
  the optional response header X-Requested-From removed for the status 201
- warning
  the optional response header X-XSS-Protection removed for the status 201

Operation history