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.polls (2.0.0)

Download OpenAPI specification:Download

Settings

Operations related to the settings of the polls module

Get The Settings Of The Polls Module In A Server

Get the settings for Husqy polls module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete The Settings Of The Polls Module In A Server

Delete the settings for Husqy polls 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": {
    }
}

Update The Settings Of The Polls Module In A Server

Change the settings for Husqy polls 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 Discord Polls (boolean) or Delete Ended Discord Polls (null) (Delete Ended Discord Polls)
Delete Ended Husqy Polls (boolean) or Delete Ended Husqy Polls (null) (Delete Ended Husqy Polls)

Responses

Request samples

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

Response samples

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

Status

Operations related to the status of the polls module

Get The Status Of The Polls Module In A Server

Status endpoint for the Husqy.modules.polls microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Disable The Polls Module

Enable the polls 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": {
    }
}

Enable The Polls Module In A Server

Enable the polls 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 poll entries

Get All Polls Entries In A Server

Get the entries for Husqy polls module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Create A New Poll

Get the response for Husqy polls module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
channel_id
required
integer (Channel Id)
poll_type
required
integer (Poll Type)
Message Id (integer) or Message Id (null) (Message Id)
Poll Duration (string) or Poll Duration (null) (Poll Duration)
poll_answer_type
required
integer (Poll Answer Type)
question
required
string (Question)
Description (string) or Description (null) (Description)
required
Array of objects (Answers)
is_multi_select
required
boolean (Is Multi Select)
is_anonymous
required
boolean (Is Anonymous)
max_votes_per_answer
required
integer (Max Votes Per Answer)
poll_owner_id
required
integer (Poll Owner 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,
  • "channel_id": 0,
  • "poll_type": 0,
  • "message_id": 0,
  • "poll_duration": "string",
  • "poll_answer_type": 0,
  • "question": "string",
  • "description": "string",
  • "answers": [
    ],
  • "is_multi_select": true,
  • "is_anonymous": true,
  • "max_votes_per_answer": 0,
  • "poll_owner_id": 0,
  • "application_id": 0,
  • "token": "string"
}

Response samples

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

Get The Info About A Poll

Get the response for Husqy polls 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": {
    }
}

Send A Polls Content

Get the response for Husqy polls 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)
Question (string) or Question (null) (Question)
Description (string) or Description (null) (Description)
Max Votes Per Answer (integer) or Max Votes Per Answer (null) (Max Votes Per Answer)
Is Multi Select (boolean) or Is Multi Select (null) (Is Multi Select)
Is Anonymous (boolean) or Is Anonymous (null) (Is Anonymous)
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,
  • "question": "string",
  • "description": "string",
  • "max_votes_per_answer": 0,
  • "is_multi_select": true,
  • "is_anonymous": true,
  • "application_id": 0,
  • "token": "string"
}

Response samples

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

Delete A Poll

Delete a poll 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": {
    }
}

Close A Poll

Close a poll 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": {
    }
}

Close A Poll

Close a poll in a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
channel_id
required
integer (Channel Id)
interacted_message_id
required
integer (Interacted Message Id)

Responses

Request samples

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

Response samples

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

Vote For A Poll Answer

Close a poll in a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Poll Id (string) or Poll Id (null) (Poll Id)
channel_id
required
integer (Channel Id)
Message Id (integer) or Message Id (null) (Message Id)
interacted_message_id
required
integer (Interacted Message Id)
action
required
string (Action)
Answer Id (integer) or Answer Id (null) (Answer Id)
Emoji Id (integer) or Emoji Id (null) (Emoji Id)
Emoji Name (string) or Emoji Name (null) (Emoji Name)
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,
  • "poll_id": "string",
  • "channel_id": 0,
  • "message_id": 0,
  • "interacted_message_id": 0,
  • "action": "string",
  • "answer_id": 0,
  • "emoji_id": 0,
  • "emoji_name": "string",
  • "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.Polls 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.Polls Microservice

Home endpoint for the Husqy.modules.polls microservice.

Responses

Response samples

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