API Reference

Update a existing raffle

patch
https://forge.gg/forge-direct/v1/raffles/

Access

This endpoint requires API key (header X-API-KEY).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Raffle ID to update

Body Params
string
length ≤ 255

Title of the raffle

date-time

When the raffle begins accepting entries

date-time | null

When the raffle stops accepting entries (null for no end time)

date-time | null

The announcement time of the raffle

integer
≥ 1

Maximum number of winners to be selected

integer
≥ 0

Maximum number of tickets each person can purchase/earn (0 = unlimited)

raffle_ticket_data
object

Configuration for raffle tickets and interactive elements

purchase_methods
array of strings
length ≥ 1

Available methods to obtain raffle tickets

purchase_methods
Allowed:
cost
object

Cost structure for different ticket acquisition methods

boolean

Whether the raffle is hidden from public view

uri

Image URL for the raffle display

string

Message displayed to raffle winners

string

Description of the raffle reward/prize

string

Message displayed to raffle participants

string
enum

What kind of raffle rewards are distributed to winners

Allowed:
Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?