Raffle System
  1. raffle
Raffle System
  • Raffles
    • authentication
      • admin login
      • user login
    • awarded-boxes
      • getAll
      • open awarded box
      • create
      • getAll by raffleId
      • delete
    • awarded-boxes-combo
      • create
      • getAll by raffleId
      • update
      • delete
    • tracking
      • get tracking info
    • pay2m-api
      • access token generation
      • generate billing qr code
      • consult qr code
      • list webhook
      • register/update webhook
      • delete webhook
    • provider-api
      • auth login
      • create pix static
      • get webhooks
      • create webhook
      • get balance
      • get extracts
      • edit webhook
      • delete webhook
      • get webhook details
      • restore webhook
    • winner
      • get quota prize winners
    • general
      • update settings
      • get settings
      • create notifications
      • get notifications
      • get notification by id
      • update notification
      • delete notification
      • create faq
      • get faqs
      • get faq by id
      • update faq
      • delete faq
    • metrics
      • get sales by day for raffle
      • get top buyers by raffle
      • get general metrics
      • get last orders
      • get raffle percentage of sales
      • get orders summary
      • get badges
      • get sell bar
      • get fake sold quotas percentage
      • create fake sold quotas percentage
      • update fake sold quotas percentage
    • payments
      • get payment providers
      • create/update payment provider
      • get payment provider by name
      • get pix payments
      • get my pix payments
      • get pix payment details
    • order
      • create order withou payment method
      • create order
      • get orders
      • get orders by raffle id
      • get my orders
      • get order details
      • pay order
      • cancel order
    • lucky-numbers
      • get lucky numbers by raffleId
      • get lucky numbers by orderId
    • raffle
      • toggle awarded boxes visualization
        PATCH
      • toggle awarded boxes winners visualization
        PATCH
      • toggle acumulative combo
        PATCH
      • update category
        PATCH
      • delete category
        DELETE
      • create raffle category
        POST
      • get categories
        GET
      • create raffle
        POST
      • get raffles
        GET
      • get raffle details
        GET
      • delete raffle
        DELETE
      • update raffle
        PATCH
      • get winners
        GET
      • get winner details
        GET
      • get winner info
        GET
      • create winner
        POST
      • upload file
        POST
    • user
      • create user
      • get users
      • update user
      • get user details
      • delete user
      • get user by phone
      • get profile
      • create customer
      • update customer
  1. raffle

create raffle

POST
/v1/raffles
raffle
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/raffles' \
--form 'file=@"C:\\Users\\Win10Pro\\Pictures\\2020-Porsche-911-Turbo-S-014-2160-scaled.jpg"' \
--form 'raffleCategoryId="4f9b1d1a-8bfa-47a6-b918-ef648df1b114"' \
--form 'title="Teste Vini Cotas"' \
--form 'subtitle="Subtítulo opcional"' \
--form 'description="Descrição do sorteio"' \
--form 'slug="{{$lorem.slug}}"' \
--form 'statusText="Status opcional"' \
--form 'privacy="PUBLIC"' \
--form 'reservationType="AUTO"' \
--form 'startsAt="{{$date.soon}}"' \
--form 'endsAt="2025-09-08T02:56:53.405Z"' \
--form 'quotaPrice="0.05"' \
--form 'quotaQuantity="10000"' \
--form 'freeCampaign="false"' \
--form 'affiliate="false"' \
--form 'fastSelectionCards="[5,10,25,50,100,1000]"' \
--form 'prizes="[{\"prize\":\"Prêmio especial 1\"}]"' \
--form 'enableQuotaPrizes="true"' \
--form 'minReservationQuantity="1"' \
--form 'maxReservationQuantity="2000"' \
--form 'reservationTimeLimit="30"' \
--form 'maxBuyerQuantity="2000"' \
--form 'showProgressBar="false"' \
--form 'showRank="false"' \
--form 'enablePromotions="true"' \
--form 'cumulative="false"' \
--form 'enableAntiSpam="false"' \
--form 'antiSpamMaxQuota="10"' \
--form 'antiSpamTimeout="30"' \
--form 'whatsapp="32772728532"' \
--form 'whatsappGroup="https://deafening-elver.biz"' \
--form 'telegram="https://pessimistic-perp.name/"' \
--form 'email="daniel.oliveira15@live.com"' \
--form 'promotionsByQuotaQuantity="[{\"quotaQuantity\":2,\"discount\":2,\"isActive\":true}]"' \
--form 'quotaPrizes="[{\"luckyNumber\":\"1\",\"prize\":\"Prêmio especial 1\",\"isLocked\":false},{\"luckyNumber\":\"2\",\"prize\":\"Prêmio especial 2\",\"isLocked\":false},{\"luckyNumber\":\"3\",\"prize\":\"Prêmio especial 3\",\"isLocked\":true}]"' \
--form 'certificateCode="123456"' \
--form 'reservationFields="[\"name\",\"phone\"]"' \
--form 'enableNotification="false"' \
--form 'automaticQuotaPrizeDistribution="true"' \
--form 'popularSelectionCard="2"' \
--form 'promotionType="BY_QUOTA_QUANTITY"' \
--form 'isHighlighted="false"' \
--form 'userId="3a64f532-ca73-4420-9dcf-527edee7a79d"'
Response Response Example
201 - Success
{
    "id": 11,
    "message": "Rifa \"#11\" criada com sucesso."
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params multipart/form-data
file
file 
required
Example:
file://C:\Users\Win10Pro\Pictures\2020-Porsche-911-Turbo-S-014-2160-scaled.jpg
raffleCategoryId
string 
required
Example:
4f9b1d1a-8bfa-47a6-b918-ef648df1b114
title
string 
required
Example:
Teste Vini Cotas
subtitle
string 
required
Example:
Subtítulo opcional
description
string 
required
Example:
Descrição do sorteio
slug
string 
required
Example:
{{$lorem.slug}}
statusText
string 
optional
Example:
Status opcional
privacy
enum<string> 
required
Allowed values:
PRIVATEPUBLIC
Example:
PUBLIC
reservationType
enum<string> 
required
Allowed values:
AUTOMANUAL
Example:
AUTO
startsAt
string <date>
required
Example:
{{$date.soon}}
endsAt
string <date>
required
Example:
2025-09-08T02:56:53.405Z
quotaPrice
number 
required
Example:
0.05
quotaQuantity
integer 
required
>= 1
Example:
10000
freeCampaign
boolean 
required
Example:
false
affiliate
boolean 
required
Example:
false
fastSelectionCards
string 
required
Example:
[5,10,25,50,100,1000]
prizes
string 
required
Example:
[{"prize":"Prêmio especial 1"}]
enableQuotaPrizes
boolean 
required
Example:
true
minReservationQuantity
integer 
required
>= 1
Example:
1
maxReservationQuantity
integer 
required
Example:
2000
reservationTimeLimit
integer 
required
Example:
30
maxBuyerQuantity
integer 
required
Example:
2000
showProgressBar
boolean 
required
Example:
false
showRank
boolean 
required
Example:
false
enablePromotions
boolean 
required
Example:
true
cumulative
boolean 
required
Example:
false
enableAntiSpam
boolean 
required
Example:
false
antiSpamMaxQuota
integer 
optional
Example:
10
antiSpamTimeout
integer 
optional
Example:
30
whatsapp
string 
optional
Example:
32772728532
whatsappGroup
string 
optional
Example:
https://deafening-elver.biz
telegram
string 
optional
Example:
https://pessimistic-perp.name/
email
string 
optional
Example:
daniel.oliveira15@live.com
promotionsByQuotaQuantity
string 
optional
Example:
[{"quotaQuantity":2,"discount":2,"isActive":true}]
quotaPrizes
string 
optional
Example:
[{"luckyNumber":"1","prize":"Prêmio especial 1","isLocked":false},{"luckyNumber":"2","prize":"Prêmio especial 2","isLocked":false},{"luckyNumber":"3","prize":"Prêmio especial 3","isLocked":true}]
certificateCode
string 
optional
Example:
123456
reservationFields
string 
required
Example:
["name","phone"]
enableNotification
boolean 
required
Example:
false
automaticQuotaPrizeDistribution
boolean 
required
Example:
true
popularSelectionCard
integer 
required
Example:
2
promotionType
enum<string> 
required
Allowed value:
BY_QUOTA_QUANTITY
Example:
BY_QUOTA_QUANTITY
isHighlighted
boolean 
required
Example:
false
userId
string 
required
Example:
3a64f532-ca73-4420-9dcf-527edee7a79d

Responses

🟢201Created
application/json
Body
id
integer 
required
message
string 
required
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🟠409409
Previous
get categories
Next
get raffles
Built with