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

get raffle details

GET
/v1/raffles/{raffleId}
raffle
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v1/raffles/{{raffleId}}'
Response Response Example
200 - Success
{
    "id": 4,
    "raffleCategoryId": 1,
    "userId": 1,
    "title": "Teste",
    "subtitle": "Subtítulo opcional",
    "description": "Descrição do sorteio",
    "slug": "molestias-perferendis-maiores",
    "statusText": "Status opcional",
    "privacy": "PUBLIC",
    "reservationType": "AUTO",
    "photoUrl": "https://pub-a2e2602eb4aa4afb9f5759999bc3d218.r2.dev/molestias-perferendis-maiores",
    "status": "SOON",
    "startsAt": "2025-01-28T10:04:01.000Z",
    "endsAt": "2025-09-08T02:56:53.405Z",
    "reservationFields": [
        "name",
        "phone"
    ],
    "isHighlighted": true,
    "certificateCode": "123456",
    "enableNotification": true,
    "showEndsAt": false,
    "quotaPrice": "0.05",
    "quotaQuantity": 10000,
    "freeCampaign": true,
    "affiliate": false,
    "minReservationQuantity": 1,
    "maxReservationQuantity": 100,
    "reservationTimeLimit": 30,
    "maxBuyerQuantity": 100,
    "fastSelectionCards": [
        5,
        10,
        25,
        50,
        100,
        1000
    ],
    "popularSelectionCard": 2,
    "showProgressBar": true,
    "showRank": true,
    "showPrices": true,
    "enableQuotaPrizes": true,
    "automaticQuotaPrizeDistribution": true,
    "enablePromotions": true,
    "cumulative": true,
    "promotionType": "BY_QUOTA_QUANTITY",
    "enableAntiSpam": true,
    "antiSpamMaxQuota": 10,
    "antiSpamTimeout": 30,
    "whatsapp": "32772728532",
    "whatsappGroup": "https://deafening-elver.biz",
    "telegram": "https://pessimistic-perp.name/",
    "email": "daniel.oliveira15@live.com",
    "createdAt": "2025-01-28T03:54:55.139Z",
    "updatedAt": "2025-01-28T03:54:55.139Z",
    "_count": {
        "promotionsByQuotaQuantity": 1,
        "quotaPrizes": 3
    },
    "quotaPrizes": [
        {
            "id": 4,
            "luckyNumber": 1,
            "prize": "Prêmio especial 1",
            "isLocked": false
        },
        {
            "id": 5,
            "luckyNumber": 2,
            "prize": "Prêmio especial 2",
            "isLocked": false
        },
        {
            "id": 6,
            "luckyNumber": 3,
            "prize": "Prêmio especial 3",
            "isLocked": true
        }
    ],
    "prizes": [
        {
            "id": 4,
            "prize": "Prêmio especial 1"
        }
    ],
    "promotionsByQuotaQuantity": [
        {
            "id": 4,
            "discount": "2",
            "quotaQuantity": 2
        }
    ],
    "user": {
        "id": 1,
        "name": "Admin User",
        "surname": null,
        "email": "admin@example.com",
        "phone": "11111111111",
        "cpf": null,
        "password": "$2a$08$3TMpXDJTFzExe7r6gIwB4.PmKybCUnxCN3nzTCxnFqF/wBMWiZJDu",
        "role": "ADMIN",
        "isBlocked": false,
        "createdAt": "2025-01-28T03:44:21.175Z",
        "updatedAt": "2025-01-28T03:44:21.175Z",
        "paymentProviders": [
            {
                "name": "pay2m",
                "isEnabled": true
            },
            {
                "name": "paggue",
                "isEnabled": true
            }
        ]
    }
}

Request

Path Params
raffleId
string 
required
Example:
{{raffleId}}

Responses

🟢200OK
application/json
Body
id
integer 
required
raffleCategoryId
integer 
required
userId
integer 
required
title
string 
required
subtitle
string 
required
description
string 
required
slug
string 
required
statusText
string 
required
privacy
enum<string> 
required
Allowed values:
PRIVATEPUBLIC
reservationType
enum<string> 
required
Allowed values:
AUTOMANUAL
photoUrl
string 
required
status
enum<string> 
required
Allowed values:
ACTIVEFINISHEDSOONFULLPAUSED
startsAt
string <date>
required
endsAt
string <date>
required
reservationFields
array[string]
required
isHighlighted
boolean 
required
certificateCode
string 
required
enableNotification
boolean 
required
showEndsAt
boolean 
required
quotaPrice
string 
required
quotaQuantity
integer 
required
freeCampaign
boolean 
required
affiliate
boolean 
required
minReservationQuantity
integer 
required
maxReservationQuantity
integer 
required
reservationTimeLimit
integer 
required
maxBuyerQuantity
integer 
required
fastSelectionCards
array[integer]
required
popularSelectionCard
integer 
required
showProgressBar
boolean 
required
showRank
boolean 
required
showPrices
boolean 
required
enableQuotaPrizes
boolean 
required
automaticQuotaPrizeDistribution
boolean 
required
enablePromotions
boolean 
required
cumulative
boolean 
required
promotionType
enum<string> 
required
Allowed value:
BY_QUOTA_QUANTITY
enableAntiSpam
boolean 
required
antiSpamMaxQuota
integer 
required
antiSpamTimeout
integer 
required
whatsapp
string 
required
whatsappGroup
string 
required
telegram
string 
required
email
string 
required
createdAt
string <date>
required
updatedAt
string <date>
required
_count
object 
required
promotionsByQuotaQuantity
integer 
required
quotaPrizes
integer 
required
quotaPrizes
array [object {4}] 
required
id
integer 
required
luckyNumber
integer 
required
prize
string 
required
isLocked
boolean 
required
prizes
array [object {2}] 
required
id
integer 
optional
prize
string 
optional
promotionsByQuotaQuantity
array [object {3}] 
required
id
integer 
optional
discount
string 
optional
quotaQuantity
integer 
optional
user
object 
required
id
integer 
required
name
string 
required
surname
null 
required
email
string 
required
phone
string 
required
cpf
null 
required
password
string 
required
role
string 
required
isBlocked
boolean 
required
createdAt
string 
required
updatedAt
string 
required
paymentProviders
array [object {2}] 
required
🟠400Bad Request
🟠404Record Not Found
Previous
get raffles
Next
delete raffle
Built with