giveaways

/:channel

Changed on Feb 8, 2021

Create a new 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.

post/giveaways/{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/giveaways/:channel/post.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

Request body

object required

Example request

{}

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

Feb 8, 20218421cd25897f Revision changes
- breaking
  removed the required property from the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with 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