QUquark-bot-discord
Logging settings

Update logging options

Changed on

Changes server-wide logging options. Include only the fields you want to change.

format_type needs Quark Pro or Pro Lite and is rejected without it. ignore_bot_targets and ignore_bot_executors are saved on any plan but only take effect on Quark Pro or Pro Lite. On the free plan, actions by or to bots are not logged. log_name, log_avatar and log_profile_overrides need Quark Pro or Pro Lite and are rejected with 403 without it. Any of the three can be sent alone: the others keep what is stored. A name Discord would refuse is rejected with 400 and the reason, naming the channel for an entry in log_profile_overrides. Nothing is changed when a request is rejected.

patch/servers/{guild_id}/config/logging/settings

Request

Path parameters

guild_idstring required
Example:301655085954367490

The server's ID. Must be the server the token was created for.

Query parameters

bot'pro'

Set to pro to act on the Quark Pro bot's configuration. Leave out for the main Quark bot.

Request body

spoilersboolean

Mark re-posted files as spoilers.

pluralkit_integrationboolean

Turn PluralKit compatibility on or off.

pro_promotionsboolean

Allow a note in logs when part of a log needs Quark Pro.

ignore_bot_targetsboolean

Do not log actions done to bots.

ignore_bot_executorsboolean

Do not log actions done by bots.

format_type0 | 1 | 2 | 3

0 is Standard, 1 is Compact, 2 is Standard (no embed), 3 is Compact (no embed). Needs Quark Pro or Pro Lite.

buttonsinteger[]

The standard buttons to show on logs. Replaces the current set. 0 is User ID, 1 is Support Server, 2 is Customise.

active_ignoreboolean

Turn Active Ignore on or off for every log type. While it is on, each log is held for about three seconds before it is sent. See the Active Ignore endpoints.

modlog_lock_afterinteger nullable

How long a modlog's reason can be edited, in whole seconds after the modlog was posted. null for always editable, 0 for never editable. The dashboard offers 3600, 86400, 604800 and 2592000. The largest value accepted is 31536000 (one year).

log_namestring nullable

The name logs are posted under. null or empty for Quark's name. Up to 80 characters, without "discord" or "clyde", not "everyone" or "here", and without @, #, :, ``` or invisible characters. Needs Quark Pro or Pro Lite.

log_profile_overridesobject nullable

Each log channel's own name and avatar, keyed by channel ID, over log_name and log_avatar. Replaces every log channel's current setting. A field that is null follows the server's setting. Up to 150 channels. Needs Quark Pro or Pro Lite.

Response

Accepted.

object required

An empty object.

Example response

{}

Changes

  • 53696c705ecbRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 97e4cf82e0f9Revision changes
    • info

      added the new 1.00 enum value to the request property

    • info

      added the new 3.00 enum value to the request property