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

Download OpenAPI specification:Download

Settings

Operations related to the settings of the reactionroles module

Delete The Settings Of The Reactionroles Module In A Server

Delete the settings for Husqy reactionroles 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 reactionroles module

Get The Status Of The Reactionroles Module

Status endpoint for the Husqy.modules.reactionroles microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Enable The Reactionroles Module

Enable the reactionroles 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 Reactionroles Module

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

Panels

Operations related to reactionrole panels

Get The Reactionrole Panels In The Server

Get the panels for Husqy reactionroles module for a guild.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Create A New Reactionroles Panel

Create a new panel for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
panel_type
required
string (Panel Type)
channel_id
required
integer (Channel Id)
limit_roles_to_one
required
boolean (Limit Roles To One)
supports_remove
required
boolean (Supports Remove)
remove_roles_from_users_on_entry_delete
required
boolean (Remove Roles From Users On Entry Delete)
is_register
required
boolean (Is Register)
Keep Counter At One (boolean) or Keep Counter At One (null) (Keep Counter At One)
Delete Unrelated Emoji Reactions (boolean) or Delete Unrelated Emoji Reactions (null) (Delete Unrelated Emoji Reactions)
Message Id (integer) or Message Id (null) (Message Id)
Is Embed (boolean) or Is Embed (null) (Is Embed)
Content (string) or Content (null) (Content)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "panel_type": "string",
  • "channel_id": 0,
  • "limit_roles_to_one": true,
  • "supports_remove": true,
  • "remove_roles_from_users_on_entry_delete": true,
  • "is_register": true,
  • "keep_counter_at_one": true,
  • "delete_unrelated_emoji_reactions": true,
  • "message_id": 0,
  • "is_embed": true,
  • "content": "string"
}

Response samples

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

Get The Configuration Of A Reactionrole Panel

Get the response for Husqy reactionroles module for a guild.

path Parameters
panel_id
required
string (Panel Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete The Configuration Of A Reactionrole Panel

Delete the reactionrole for Husqy reactionroles module for a guild.

path Parameters
panel_id
required
string (Panel Id)
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": {
    }
}

Edit The Configuration Of A Reactionrole Panel

Update the reactionrole panel for Husqy reactionroles module for a guild.

path Parameters
panel_id
required
string (Panel Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Panel Type (string) or Panel Type (null) (Panel Type)
Limit Roles To One (boolean) or Limit Roles To One (null) (Limit Roles To One)
Supports Remove (boolean) or Supports Remove (null) (Supports Remove)
Keep Counter At One (boolean) or Keep Counter At One (null) (Keep Counter At One)
Delete Unrelated Emoji Reactions (boolean) or Delete Unrelated Emoji Reactions (null) (Delete Unrelated Emoji Reactions)
Remove Roles From Users On Entry Delete (boolean) or Remove Roles From Users On Entry Delete (null) (Remove Roles From Users On Entry Delete)
Message Content (string) or Message Content (null) (Message Content)
Message Is Embed (boolean) or Message Is Embed (null) (Message Is Embed)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "panel_type": "string",
  • "limit_roles_to_one": true,
  • "supports_remove": true,
  • "keep_counter_at_one": true,
  • "delete_unrelated_emoji_reactions": true,
  • "remove_roles_from_users_on_entry_delete": true,
  • "message_content": "string",
  • "message_is_embed": true
}

Response samples

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

Check If A Deleted Message Or Channel Is Or Has A Reactionrole Panel

Enable the reactionroles module for a server.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Channel Id (integer) or Channel Id (null) (Channel Id)
Message Id (integer) or Message Id (null) (Message Id)

Responses

Request samples

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

Response samples

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

Reactionroles

Operations related to a reactionrole panels reactionroles

Check An Interaction

Create a new panel for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
message_id
required
integer (Message Id)
channel_id
required
integer (Channel Id)
interaction_type
required
string (Interaction Type)
Interaction Custom Id (string) or Interaction Custom Id (null) (Interaction Custom Id)
Interaction Id Token (string) or Interaction Id Token (null) (Interaction Id Token)
Application Id (integer) or Application Id (null) (Application Id)
Interaction Value (string) or Interaction Value (null) (Interaction Value)
Emoji Id (integer) or Emoji Id (null) (Emoji Id)
Emoji Name (string) or Emoji Name (null) (Emoji Name)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "message_id": 0,
  • "channel_id": 0,
  • "interaction_type": "string",
  • "interaction_custom_id": "string",
  • "interaction_id_token": "string",
  • "application_id": 0,
  • "interaction_value": "string",
  • "emoji_id": 0,
  • "emoji_name": "string"
}

Response samples

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

Get All Reactionroles For A Panel

Get the response for Husqy reactionroles module for a guild.

path Parameters
panel_id
required
string (Panel Id)
query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Delete The Configuration Of A Reactionrole

Delete the reactionrole for Husqy reactionroles module for a guild.

path Parameters
panel_id
required
string (Panel Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
role_ids
required
Array of integers (Role Ids)
Text (string) or Text (null) (Text)
Description (string) or Description (null) (Description)
emoji_name
required
string (Emoji Name)
Emoji Id (string) or Emoji Id (null) (Emoji Id)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "role_ids": [
    ],
  • "text": "string",
  • "description": "string",
  • "emoji_name": "string",
  • "emoji_id": "string"
}

Response samples

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

Get The Configuration Of A Reactionrole

Get the response for Husqy reactionroles module for a guild.

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

Responses

Response samples

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

Edit The Configuration Of A Reactionrole

Delete the reactionrole for Husqy reactionroles module for a guild.

path Parameters
panel_id
required
string (Panel Id)
entry_id
required
string (Entry Id)
Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
Array of Role Ids (integers) or Role Ids (null) (Role Ids)
Text (string) or Text (null) (Text)
Description (string) or Description (null) (Description)

Responses

Request samples

Content type
application/json
{
  • "guild_id": 0,
  • "role_ids": [
    ],
  • "text": "string",
  • "description": "string"
}

Response samples

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

Delete The Configuration Of A Reactionrole

Delete the reactionrole for Husqy reactionroles module for a guild.

path Parameters
panel_id
required
string (Panel Id)
entry_id
required
string (Entry Id)
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": {
    }
}

Privacy

Operations for a users privacy data

Get The Privacy Data Of A User For The Husqy.Modules.Reactionroles 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.Reactionroles 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.Reactionroles Microservice

Home endpoint for the Husqy.general microservice.

Responses

Response samples

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