STstreamelements
single giveaway
giveaways

/:channel/:giveawayId/start

Changed on

Start a Giveaway This endpoint is available only in the API version 3. Make sure to use the v3 base URL: https://api.streamelements.com/kappa/v3.

put/giveaways/{channel}/{giveawayId}/start

Request

Path parameters

channelstring required
Example:5b2e2007760aeb7729487dab

guid - Channel id

giveawayIdstring required

guid - Giveaway id

Headers

Acceptstring required
Example:application/json; charset=utf-8

Response

subscriberLuckinteger required
subscriberOnlyboolean required
totalAmountinteger required
totalUsersinteger required
botResponsesboolean required
_idstring required
winnersstring[] required
channelstring required
createdAtstring required
updatedAtstring required
startedAtstring
statestring
endedAtstring

Example response

{
  "subscriberLuck": 1,
  "subscriberOnly": false,
  "totalAmount": 0,
  "totalUsers": 0,
  "botResponses": false,
  "_id": "5c0a6c00de9a4c3a70a14da6",
  "winners": [],
  "channel": "5b2e2007760aeb7729487dab",
  "createdAt": "2018-12-07T12:48:00.133Z",
  "updatedAt": "2018-12-07T12:48:00.133Z"
}

Changes

  • fb6ec574b6a7Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

  • 8421cd25897fRevision changes
    • info

      api tag giveaways added