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}
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

Responses

🟢200OK
application/json
Body

🟠400Bad Request
🟠404Record Not Found
Modified at 2025-03-20 15:02:16
Previous
get raffles
Next
delete raffle
Built with