loyalties

/:channel

Changed on Feb 7, 2021

Get loyalty settings

get/loyalty/{channel}

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

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

Headers

Acceptstring required

Example:application/json; charset=utf-8

Response

_idstring required

channelstring required

createdAtstring required

updatedAtstring required

Example response

{
  "loyalty": {
    "bonuses": {
      "follow": 0,
      "tip": 0,
      "subscriber": 0,
      "cheer": 0,
      "host": 0
    },
    "name": "points",
    "enabled": false,
    "amount": 5,
    "subscriberMultiplier": 3,
    "ignored": [
      "streamelements"
    ]
  },
  "_id": "5b2e2007760aeb7230487dc1",
  "channel": "5b2e2007760aeb7729487dab",
  "createdAt": "2018-06-23T10:25:11.768Z",
  "updatedAt": "2018-06-23T10:25:11.768Z"
}

Changes

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
- warning
  deleted the header request parameter Content-Type

Operation history