Skip to main content
POST
/
draws
cURL
curl --request POST \
  --url https://admin.fanfare.io/api/draws \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "drawAt": "<string>",
  "name": "<string>",
  "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "winnerCount": 123
}
'
{
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "drawAt": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sequenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timeZone": "<string>",
  "winnerCount": 123,
  "admissionExpirationSeconds": 123,
  "capacity": 123,
  "closeAt": "2023-11-07T05:31:56Z",
  "continueSelectingUntilCompleted": true,
  "loyaltyBiasEnabled": true,
  "openAt": "2023-11-07T05:31:56Z",
  "statusOverride": "ended",
  "statusOverrideAt": "2023-11-07T05:31:56Z",
  "statusOverrideBy": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>"
}

Authorizations

Authorization
string
header
required

Fanfare secret key. Keep secret credentials on your server.

Body

application/json
drawAt
string
required
name
string
required
sequenceId
string<uuid>
required
winnerCount
number
required
admissionExpirationSeconds
number | null
capacity
number | null
closeAt
string | null
continueSelectingUntilCompleted
boolean | null
loyaltyBiasEnabled
boolean
openAt
string | null
timeZone
string | null

Response

Draw created successfully

archived
boolean
required
createdAt
string<date-time>
required
createdBy
string
required
drawAt
string<date-time>
required
id
string<uuid>
required
name
string
required
Minimum string length: 1
organizationId
string<uuid>
required
sequenceId
string<uuid>
required
timeZone
string
required
Minimum string length: 1
winnerCount
number
required
admissionExpirationSeconds
number | null
capacity
number | null
cleanupStatus
enum<string> | null
Available options:
pending,
completed
closeAt
string<date-time> | null
continueSelectingUntilCompleted
boolean | null
loyaltyBiasEnabled
boolean
openAt
string<date-time> | null
statusOverride
enum<string> | null
Available options:
ended
statusOverrideAt
string<date-time> | null
statusOverrideBy
string | null
updatedAt
string<date-time> | null
updatedBy
string | null