The Husqy premium subscription is now live! Please head over to our Discord store page to get started!
We are verified! Husqy is a verified bot in Discord making us visible in the app discovery and enabling bigger trust to users!
Want to help us translate the Husqy responses? We can't do it without you! Please visit our translations repo!
Skip to main content
API docs by Redocly

Husqy.modules.giveaways (2.0.0)

Download OpenAPI specification:Download

Settings

Operations related to the settings of the giveaways module

Get The Settings Of The Giveaways Module In A Server

Get the settings for Husqy giveaways module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update The Settings Of The Giveaways Module In A Server

Change the settings for Husqy giveaways module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Save Duration Timeout (integer) or Save Duration Timeout (null) (Save Duration Timeout)
Delete Ended Giveaways (boolean) or Delete Ended Giveaways (null) (Delete Ended Giveaways)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "save_duration_timeout": 0,
  • "delete_ended_giveaways": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete The Settings Of The Giveaways Module In A Server

Delete the settings for Husqy giveaways module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Status

Operations related to the status of the giveaways module

Get The Status Of The Giveaways Module In A Server

Status endpoint for the Husqy.modules.giveaways microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enable The Giveaways Module In A Server

Enable the giveaways module for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Disable The Giveaways Module

Enable the giveaways module for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Entries

Operations related to giveaway entries

Get All Giveaways Entries In A Server

Get the entries for Husqy giveaways module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create A New Giveaway

Get the response for Husqy giveaways module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
channel_id
required
integer (Channel Id)
giveaway_owner_id
required
integer (Giveaway Owner Id)
End Time (string) or End Time (null) (End Time)
prize
required
string (Prize)
Description (string) or Description (null) (Description)
winner_count
required
integer (Winner Count)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "channel_id": 0,
  • "giveaway_owner_id": 0,
  • "end_time": "string",
  • "prize": "string",
  • "description": "string",
  • "winner_count": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get The Info About A Giveaway

Get the response for Husqy giveaways module for a guild.

path Parameters
entry_id
required
string (Entry Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete A Giveaway

Delete a giveaway in a guild.

path Parameters
required
Entry Id (string) or Entry Id (null) (Entry Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Send A Giveaways Content

Get the response for Husqy giveaways module for a guild.

path Parameters
required
Entry Id (string) or Entry Id (null) (Entry Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
New Prize (string) or New Prize (null) (New Prize)
New Description (string) or New Description (null) (New Description)
New Winner Count (integer) or New Winner Count (null) (New Winner Count)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "new_prize": "string",
  • "new_description": "string",
  • "new_winner_count": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Enter A Giveaway

Enter a giveaway in a guild.

path Parameters
required
Entry Id (string) or Entry Id (null) (Entry Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Leave A Giveaway

Leave a giveaway in a guild.

path Parameters
required
Entry Id (string) or Entry Id (null) (Entry Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Reroll A Giveaway

Reroll a giveaway in a guild.

path Parameters
required
Entry Id (string) or Entry Id (null) (Entry Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Application Id (integer) or Application Id (null) (Application Id)
Token (string) or Token (null) (Token)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Privacy

Operations for a users privacy data

Get The Privacy Data Of A User For The Husqy.Modules.Giveaways Microservice

Get user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete The Privacy Data Of A User For The Husqy.Modules.Polls Microservice

Delete user entries.

query Parameters
guild_id
required
integer (Guild Id)
privacy_member_id
required
integer (Privacy Member Id)

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Home Endpoint For The Husqy.Modules.Giveaways Microservice

Home endpoint for the Husqy.modules.giveaways microservice.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}