Skip to main content

FreeToolPickGiveawayWinnersRequest

entrants object[]required

The comments, one item each. The request body is capped at 128 KB.

Possible values: <= 50000

  • Array [
  • usernamestringrequired

    The commenter, with or without the leading @.

    Possible values: <= 200 characters

    commentstring

    The comment text the filters read.

    Possible values: <= 5000 characters

    Default value:
  • ]
  • seedstring

    The secret seed, 64 hex characters (32 bytes), whose fingerprint you published before the entries closed. Without it, a seed is generated and pre_committed is false. The steps of the draw (pb-draw-v1) and a test vector are on the web tool page.

    Possible values: Value must match regular expression ^[0-9a-fA-F]{64}$

    one_per_personboolean

    Count each username once. Off: every comment is an entry, so one person can win more than once.

    Default value: true
    keywordsstring[]

    Keep only comments that contain at least one of these, case-insensitive.

    Possible values: <= 20

    Default value: []
    min_mentionsinteger

    Keep only comments that tag at least this many other @handles.

    Possible values: >= 0 and <= 10

    Default value: 0
    excludestring[]

    Usernames to leave out of the draw, such as the host account.

    Possible values: <= 100

    Default value: []
    winnersinteger

    Possible values: >= 1 and <= 100

    Default value: 1
    alternatesinteger

    Runners-up drawn after the winners, in order.

    Possible values: >= 0 and <= 20

    Default value: 0
    FreeToolPickGiveawayWinnersRequest
    {
    "entrants": [
    {
    "username": "string",
    "comment": ""
    }
    ],
    "seed": "string",
    "one_per_person": true,
    "keywords": [
    "string"
    ],
    "min_mentions": 0,
    "exclude": [
    "string"
    ],
    "winners": 1,
    "alternates": 0
    }