Kayfarik Docs
Invite the BotSupport Server
  • Introduction
  • Common Problems
  • Permissions
  • Role Menus
    • Categories
    • Roles
  • Guides
    • How to Mention or Paste Server Emojis in Modals
    • Parsing Role Options
  • API
    • Parsing Role Options on Request
  • Links
    • Crowdin Translation Project
    • For Suggestions
    • Terms of Service
    • Privacy Policy
Powered by GitBook
On this page
  • Using GET request and query string
  • Category Synchronization
  • Using POST request and headers
  • Category Synchronization
  1. API

Parsing Role Options on Request

PreviousParsing Role Options

Last updated 3 months ago

This feature is currently private. Create a to submit a request.

To use it, you need to use option parsing at least once to save category parsing settings:

Parsing Role Options

To get IDs, enable the Developer Mode in User Settings and right-click or hold message/server. There will be a "Copy ID" button.

Using GET request and query string

Category Synchronization

GET /api/sync?guildId=ID&categoryMessageId=ID

Query Parameters

Name
Type
Description

guildId*

Snowflake

Server ID.

categoryMessageId*

Snowflake

Message ID of the category.

{
    "message": "The category has been synchronized."
}
{
    "message": "One of the required parameters is missing or invalid."
}
{
    "message": "Server / Category were not found."
}
{
    "message": "An error occurred in the synchronization method."
}

Using POST request and headers

Category Synchronization

POST /api/sync

Headers

Name
Type
Description

guildId*

Snowflake

Server ID.

categoryMessageId*

Snowflake

Message ID of the category.

{
    "message": "The category has been synchronized."
}
{
    "message": "One of the required parameters is missing or invalid."
}
{
    "message": "Server / Category were not found."
}
{
    "message": "An error occurred in the synchronization method."
}

Ratelimit - 25 requests per 30 minutes

ticket