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

Download OpenAPI specification:Download

Settings

Operations related to the settings of the reminders module

Delete The Settings Of The Reminders Module In A Server

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

Get The Status Of The Reminders Module In A Server

Status endpoint for the Husqy.modules.reminders microservice.

query Parameters
guild_id
required
integer (Guild Id)

Responses

Response samples

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

Enable The Reminders Module In A Server

Enable the reminders 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 Reminders Module

Enable the reminders 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 reminder entries

Get All Reminders Entries In A Server

Get the entries for Husqy reminders module for a guild.

query Parameters
guild_id
required
integer (Guild Id)
Reminder Type (string) or Reminder Type (null) (Reminder Type)
User Id (integer) or User Id (null) (User Id)

Responses

Response samples

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

Create A New Poll

Get the response for Husqy reminders module for a guild.

Request Body schema: application/json
required
guild_id
required
integer (Guild Id)
reminder_type
required
integer (Reminder Type)
required
object (Schedule Details)
Title (string) or Title (null) (Title)
Description (string) or Description (null) (Description)
Owner (integer) or Owner (null) (Owner)
Url (string) or Url (null) (Url)
Destination Id (integer) or Destination Id (null) (Destination Id)
Content (string) or Content (null) (Content)
content_is_embed
boolean (Content Is Embed)
Default: false
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,
  • "reminder_type": 0,
  • "schedule_details": {
    },
  • "title": "string",
  • "description": "string",
  • "owner": 0,
  • "url": "string",
  • "destination_id": 0,
  • "content": "string",
  • "content_is_embed": false,
  • "application_id": 0,
  • "token": "string"
}

Response samples

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

Get The Info About A Reminder

Get the response for Husqy reminders 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 Reminder

Delete a reminder 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)

Responses

Request samples

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

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)
action
required
string (Action)
required
New Delay (integer) or New Delay (null) (New Delay)
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,
  • "action": "string",
  • "new_delay": 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.Reminders 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.Reminders 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.Reminders Microservice

Home endpoint for the Husqy.modules.reminders microservice.

Responses

Response samples

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