/:channel/:contestId/start

Changed on Feb 22, 2021

Start a contest

put/contests/{channel}/{contestId}/start

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

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

contestIdstring required

guid - Contest id

Headers

Acceptstring required

Example:application/json; charset=utf-8

Request body

object required

Example request

{}

Response

botResponsesboolean required

totalAmountinteger required

totalUsersinteger required

_idstring required

titlestring required

minBetinteger required

maxBetinteger required

durationinteger required

channelstring required

statestring required

createdAtstring required

updatedAtstring required

Example response

{
  "botResponses": true,
  "totalAmount": 0,
  "totalUsers": 0,
  "_id": "5c0a53cede9a4c207fa14d90",
  "title": "Will I win the next game?",
  "minBet": 10,
  "maxBet": 10000,
  "duration": 5,
  "options": [
    {
      "totalAmount": 0,
      "totalUsers": 0,
      "_id": "5c0a53cede9a4cc345a14d92",
      "title": "Win",
      "command": "win"
    },
    {
      "totalAmount": 0,
      "totalUsers": 0,
      "_id": "5c0a53cede9a4c4b39a14d91",
      "title": "Lose",
      "command": "lose"
    }
  ],
  "channel": "5b2e2007760aeb7729487dab",
  "state": "created",
  "createdAt": "2018-12-07T11:04:46.528Z",
  "updatedAt": "2018-12-07T11:04:46.528Z"
}

Changes

Feb 22, 202151e3df32da57 Revision changes
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Feb 8, 20218421cd25897f Revision changes
- info
  api tag contests added

Operation history (3 revisions)