timers

/:channel/:timerId

Changed on Feb 7, 2021

Update timer details

put/bot/timers/{channel}/{timerId}

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/bot/timers/:channel/:timerId/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

timerIdstring required

guid - Timer id

Headers

Acceptstring required

Example:application/json

Request body

object required

Example request

{}

Response

enabledboolean required

chatLinesinteger required

_idstring required

channelstring required

namestring required

messagestring required

createdAtstring required

updatedAtstring required

Example response

{
  "online": {
    "enabled": true,
    "interval": 5
  },
  "offline": {
    "enabled": true,
    "interval": 30
  },
  "enabled": true,
  "chatLines": 5,
  "_id": "5c0aa9d3de9a4c4622a14e07",
  "channel": "5b2e2007760aeb7729487dab",
  "name": "test timer",
  "message": "This is a test",
  "createdAt": "2018-12-07T17:11:47.909Z",
  "updatedAt": "2018-12-07T17:11:47.909Z"
}

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