store

/:channel/items/:itemId

Changed on Feb 22, 2021

Update item

put/store/{channel}/items/{itemId}

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

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

itemIdstring required

guid - Item id

Headers

Acceptstring required

Example:application/json; charset=utf-8

Request body

object required

Example request

{}

Response

subscriberOnlyboolean required

userInputstring[] required

_idstring required

enabledboolean required

featuredboolean required

namestring required

descriptionstring required

typestring required

costinteger required

publicboolean required

channelstring required

createdAtstring required

updatedAtstring required

Example response

{
  "bot": {
    "enabled": true,
    "identifier": "testitem"
  },
  "cooldown": {
    "user": 5,
    "global": 0
  },
  "quantity": {
    "total": -1
  },
  "accessCodes": {
    "keys": [],
    "mode": "multi",
    "random": false
  },
  "alert": {
    "graphics": {
      "duration": 8
    },
    "audio": {
      "volume": 0.5,
      "src": null
    },
    "enabled": true
  },
  "subscriberOnly": false,
  "userInput": [],
  "_id": "5c0bb2aede9a4c4402a15056",
  "enabled": true,
  "featured": false,
  "name": "Test item",
  "description": "Test description",
  "type": "perk",
  "cost": 0,
  "public": false,
  "channel": "5b2e2007760aeb7729487dab",
  "createdAt": "2018-12-08T12:01:50.208Z",
  "updatedAt": "2018-12-08T12:12:45.883Z"
}

Changes

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

Operation history