Objects

Whether a reply pings the author of the message it replies to, as on Discord (the web client sends true unless the person turns the mention off). The author is then in mentions, counts toward their mention badge and is notified, under the usual rules: they must be able to view the channel, a block stops the notification, and nobody is pinged by replying to their own message or to a webhook. The choice is kept when the reply is edited.

default false

The name to show, without any path. A name starting with SPOILER_ is a spoiler, as on Discord. Re-encoded WebP images get a .jpg or .png name.

Alt text, up to 1024 characters.

The type the file is served with, decided from its content. Active content (HTML, SVG, XML, scripts) is application/octet-stream.

at least 1

Null when quarantined. On a separate media host or the storage bucket, never the app's origin.

A still preview of at most 512 by 512 pixels, for images larger than that and for animated GIFs.

Images only.

Images only.

A BlurHash (4 by 3 components) to show while the image loads. Images only.

What the instance's image classifier found in an image: explicit (nudity or sexual content, drawn or photographed), suggestive (revealing but not explicit) or none. An animated image is judged by its first, middle and last frames and takes the highest level. Null when the file was never classified: anything that is not a still or animated image, files sent before classification existed or while the sensitive_media flag was inactive, files that could not be read for it, and quarantined files. A file whose classification did not answer in time is sent as pending and classified in the background; the message then arrives again as message_update with the level set. Clients treat pending like explicit until then (reports never carry it). Clients blur only explicit and pending images, never block them, and only where the sensitive_media flag is on (a server's features; in direct messages, the viewer's own flags). Inside an age-restricted channel nothing is blurred for a viewer who passed its age gate. Otherwise the viewer's privacy settings decide: sensitive_media_servers in servers, sensitive_media_friend_dms for direct messages from friends and sensitive_media_other_dms for other direct messages. The viewer's own uploads are never blurred for them. With sensitive_media_locked every explicit and pending image blurs. Public web pages never show explicit, suggestive or pending images.

One of none, suggestive, explicit, pending

Hidden by moderators or the trust and safety team; nothing about the file can be shown.

A finalized attachment upload of the caller's for this channel, not used before.

A display name to use instead of the uploaded one; the extension stays.

Alt text, up to 1024 characters without control characters other than newlines.

Same as a filename starting with SPOILER_.

One of block_message, send_alert_message, timeout

block_message: shown to the sender under the notice.

at most 150 characters

send_alert_message: a text channel of the community, where the member saving the rule can view and send messages.

timeout: how long; only on keyword and mention_spam rules.

at least 1; at most 2419200

Where the member sent or edited the message.

The message, when it was posted (an alert-only rule) or for an edit; null when a new message was blocked.

True when the content was an edit of an existing message.

The keyword, pattern or preset entry that matched.

The matched text, folded. Null for a bot without the message content permission, and when content_hidden or content_removed is true.

What the member sent or edited. Null for a bot without the message content permission, when content_hidden is true, and when content_removed is true. Alerts from before this field carried the text in the message content.

True when the alert never held the text, file names or matched text: the source channel is not visible to every member, and it is not the alert channel or a public thread in it, so some readers of the alert channel might not be allowed to read it. Moderators who can see the source channel find the text in the moderation log and the execution event.

True when the text, file names and matched text were removed, 90 days after the alert or when the member deleted their content.

File names that were checked with the message. Empty for a bot without the message content permission, and when content_hidden or content_removed is true.

The timeout this rule applied, if any.

The community's own words to show the sender under the notice.

at least 1 characters; at most 100 characters

Who last saved the rule. Its timeouts apply only to members ranked below this member, while they hold Moderate Members.

One of message_send

at least 1 items; at most 3 items

Members with any of these roles are not checked (the @everyone role exempts everyone).

at most 20 items

Text channels or categories not checked; a category covers its channels and a channel its threads.

at most 50 items

keyword rules: up to 1000 keywords of 1-60 characters; * only at the start or end. Each entry may fold to at most 240 bytes, a rule's keywords and allow list together to 80 KiB, and a community's keyword and preset rules together to 192 KiB; past that the save is refused.

at most 1000 items

keyword rules: up to 10 Go (RE2) regular expressions of 1-260 characters, matched case-insensitively against the folded text. A pattern that matches empty text, or that is too complex (300 program instructions, 400 per rule, 400 per community), is refused.

at most 10 items

keyword_preset rules: the built-in lists to use, at least one.

Entries that never trigger the rule, with the keyword syntax: up to 100 for keyword rules and 1000 for keyword_preset rules. A match inside an allowed match is ignored.

at most 1000 items

mention_spam rules: the most distinct user and role mentions a message may have. Default 20.

at least 1; at most 50

mention_spam rules: also refuse mention-heavy messages while several members send them at once.

The name with the tier, such as "Bug hunter, Gold".

One of automatic, granted, paid

The identity domain of the instance that issued it.

at least 1

False for a frozen badge (a supporter whose plan ended); show it as inactive.

Only ever true in the holder's own and admin lists.

A verified organization, for its badge.

For verified_domain, the shown domains.

One of automatic, granted, paid

One of keep, freeze, drop

Only the instance owner grants and revokes it.

Display order; profiles list badges in this order.

at least 1

The user who last set the ban. Null once that account is deleted.

Pass as after to get the next page. Null on the last page.

Shown to members with Ban Members. Trimmed; empty or null means none. No control or invisible formatting characters.

at most 512 characters

Sort key within the channel's group: the categories, or the channels sharing a parent_id. See the channels tag for the full display order.

The category this channel is in, or null. Always null for a category. For a thread, the text channel it belongs to.

Empty when the channel has none. Only text channels have one. Visible to everyone who can view the channel, in lists, ready and channel_update.

Permission overwrites, role overwrites first, each group ordered by ID. Clients drop a member's overwrites when the member leaves and a role's when the role is deleted; the server removes them too. Always empty for a thread, which uses its parent's.

Threads only. Who started the thread; absent if that account no longer exists.

Threads only. Messages sent in the thread, not counting system messages or deleted ones.

at least 0

Threads only. How many members the thread has.

at least 0

Voice channels only. How many people can be in it at once; 0 means no limit.

at least 0; at most 99

Voice channels only. The audio bitrate clients send, in bits per second.

at least 8000; at most 96000

Text and voice channels only (absent on categories and threads; a thread follows its parent). An age-restricted channel, Discord's NSFW channel: clients show an age gate ("Are you 18 or older?") the first time a viewer opens it on a device and hide its messages until they continue, never let an account with sensitive_media_locked past it, and do not blur sensitive images inside it for viewers who passed it. It cannot be published as a public web page; turning it on unpublishes the channel.

When the newest remaining pin was made; null when nothing is pinned.

at least 0

at least 0

A ULID. Sorts lexically in creation order.

A ULID. Sorts lexically in creation order.

at least 0

Null for a global command.

pattern ^[a-z0-9_-]{1,32}$

at most 25 items

pattern ^[a-z0-9_-]{1,32}$

1-100 characters.

Required options must come before optional ones.

Strings only.

at least 1; at most 4000

Strings only.

at least 1; at most 4000

Integers only.

Integers only.

The optional dark mode icon (same icons kind as icon). Clients show it instead of icon when the viewer uses a dark theme; null means use icon. Push notifications and other places that cannot follow the theme use icon.

1 when "Require 2FA for moderator actions" is on: members without MFA (for a bot, its owner) lose Administrator, Kick, Ban, Moderate Members, Manage Messages, Manage Channels, Manage Roles, Manage Community, Manage Webhooks, Manage Threads, Mute, Deafen and Move Members, and actions that need them answer 403 moderation_mfa_required.

One of 0, 1

Whether bots with the presence intent receive this community's presence (true for new communities, like Discord's unverified bots). Changed with Manage Community; when false, bots get no presence_update or presence_list for this community.

The feature flags on for this server, like Discord's guild features. Changes arrive as community_update. The server enforces them; clients hide what is off.

The vanity invite code, shown to every member; the link is /invite/<code>.

The verified organization this community belongs to, for the "official" badge.

Only in community_update gateway events, only for connections with Manage Community, and only when the community has a directory listing. REST responses never carry it.

Joins are refused with community_full at this many members.

Roles other than @everyone.

The largest file a member can attach in this community.

Custom emoji slots, enforced once custom emoji exist.

Server sticker slots, enforced when adding a sticker.

at least 1 items; at most 10 items

One of message_send

default true

IDs that are not roles of the community are dropped.

IDs that are not text channels or categories of the community are dropped.

Trimmed, then 1 to 100 characters with no control or invisible formatting characters. Text channel names are lowercased and each run of whitespace becomes a single -. Emoji are allowed, and the character rules of CreateRoleRequest apply to every kind. While emoji_names_enabled on GET /instance is true names are also normalized as role names are, and text channel names drop ASCII punctuation other than - and _ before the whitespace runs become -, as Discord does (Rules & Info! is stored as rules-info). Voice channel and category names keep their case and spaces. Lengths count code points.

One of text, voice, category, public_thread, private_thread

A category in the same community to create the channel in. Not allowed for a category.

Text channels only. Omitted, null or empty means no topic.

Voice channels only (voice_setting_not_allowed otherwise). 0, the default, means no limit; invalid_user_limit outside 0 to 99.

at least 0; at most 99

Voice channels only (voice_setting_not_allowed otherwise). Defaults to 64000; invalid_bitrate outside 8000 to 96000.

at least 8000; at most 96000

Text and voice channels only (age_restriction_not_allowed otherwise). Needs the sensitive_media flag on for the community (sensitive_media_disabled otherwise). Recorded in the moderation log with changes.age_restricted on an update.

Omit or null for unlimited uses.

at least 1; at most 1000

Defaults to 7 days. 0 means never. At most 30 days.

at least 0; at most 2592000; default 604800

Trailing whitespace is removed and line breaks are normalized to \n; then 1 to 4000 characters, or empty when the message has attachments. Newlines, tabs and bidirectional formatting characters are allowed (right-to-left scripts need them); other control characters are not.

Optional, up to 64 printable ASCII characters (no spaces), echoed back in the response and in the message_create event. Every member of the community sees it in the event. An empty string is the same as leaving it out.

at most 64 characters

Finalized uploads to attach. Needs Attach Files as well as Send Messages.

at most 10 items

At most one sticker, as on Discord, with optional content: a built-in sticker (such as pip_hello) anywhere, or a sticker of this channel's own server. Another server's sticker is refused with 403 sticker_not_usable, and every sticker while the stickers flag is off with 403 stickers_disabled.

at most 1 items

Set by the GIF picker only: the media URL of the chosen GIF, which content must also contain. It must be an https URL on the provider's media hosts ending in .gif, .webp or .mp4, and the gifs flag must be on for the sender; otherwise 400 invalid_gif. The message then carries gif_url and clients embed it; a provider URL pasted without this stays a plain link.

at most 2048 characters

Trimmed, then 1 to 100 characters with no control or invisible formatting characters. Emoji are allowed. At most 4 combining marks may sit on one character, a zero-width joiner is only accepted inside an emoji sequence or between letters of a script that uses joiners, a variation selector only where it changes how its character is drawn, tag characters only in the England, Scotland and Wales flags, and line and paragraph separators, private use and unassigned characters are refused; the name needs one visible character. Names that fold to everyone or here, with or without a leading @ (any case, look-alike letters), are reserved. While emoji_names_enabled on GET /instance is true the name is also stored in NFC with each run of whitespace (line and paragraph separators included) collapsed to one space. Lengths count code points either way.

at least 0; at most 16777215

A 64-bit permission set as a decimal string. See the roles tag for the bits.

default false

default false

1-100 characters after trimming, with no control characters and no bidirectional overrides, isolates or other invisible formatting characters, as for channel names. Unlike text channel names it keeps its case and spaces. While emoji_names_enabled on GET /instance is true the stricter name rules of CreateRoleRequest apply.

at least 1 characters; at most 100 characters

Defaults to public_thread. A thread started from a message is always public; private_thread is refused there.

One of public_thread, private_thread

Defaults to 1440 (24 hours).

One of 60, 1440, 4320, 10080

Private threads only; defaults to true.

The _dark purposes are the optional dark mode variants of the avatar, the server avatar and the server icon. Each upload is used once, for the field of its purpose. They are refused with 403 dark_images_disabled while dark_images_enabled is false on GET /instance, and so is setting a _dark field to an upload or finalizing a _dark upload whose slot was created before the switch was turned off.

One of avatar, avatar_dark, banner, community_icon, community_icon_dark, community_banner, member_avatar, member_avatar_dark, member_banner, sticker

Required for the community purposes community_icon, community_icon_dark and community_banner (Manage Server), sticker (Manage Expressions, the stickers flag, a PNG, APNG, GIF or WebP of at most 512 KB, 413 file_too_large above; then POST /communities/{id}/stickers) and the server profile purposes member_avatar, member_avatar_dark and member_banner (membership plus Change Nickname or Manage Nicknames), refused otherwise.

at least 1

The optional dark mode avatar (same avatars kind as avatar). Clients show it instead of avatar when the viewer uses a dark theme; null means use avatar.

at most 190 characters

at most 40 characters

The account's email address, or null. Always null for bots.

Whether the address was confirmed through the link sent to it. Only a verified address receives password reset links and security notices.

username@identity domain, the account's stable address.

The handle shown to others; the address unless an alias domain handle is in use.

The terms of service version this account last accepted, or null.

When that version was accepted, or null.

True when the instance has a terms version (terms_version in GET /instance) and this account has not accepted it. Show the terms in a dialog that blocks use until POST /users/@me/terms succeeds. Always false for bots.

The user and community_and_user feature flags on for this account, for its own settings and profile. Changes arrive as features_update on the gateway.

Whether the account has a second factor. Always false for bots.

at least 1 characters; at most 128 characters

Hidden because the rules channel is gone or not public; see DirectoryState.

A hash of what review covers: the description, categories, keywords, language and rules channel, and the community's name, icon and banner. Send it with approve.

The community's optional dark mode icon; null means use icon.

at most 300 characters

at most 3 items

at most 10 items

Refreshed every 5 minutes.

Members with a visible presence, refreshed every 5 minutes.

The community's tier has the featured perk.

A verified organization, for its badge.

When the community was created.

at most 3 items

at most 10 items

1 to 300 characters, one line, no control or invisible formatting characters.

at most 3 items

2 to 32 letters, digits, spaces or hyphens each; lowercased and deduplicated.

at most 10 items

A text channel of the community; @everyone must be able to read it to meet rules_channel.

members and age (days) carry required and actual. rules_channel: the rules channel is readable by @everyone. owner_standing: verified email, not suspended. safety: no instance moderation in the community in the last 30 days.

One of members, age, icon, rules_channel, owner_standing, safety

A listing with its review state, for its managers and instance admins.

Whether the instance has a directory.

Whether listings that meet every requirement skip review.

The admins' reason for a rejection or delisting.

Whether the listing shows in the directory now.

The rules channel is gone or no longer readable by @everyone, so the listing is hidden. It stays approved and shows again once the rules channel is fixed.

One of dm

Every participant, the caller included, ordered by ID.

The newest message; null if there is none.

The newest message the caller has read; null if none.

Messages from the other participants since the caller last acked. Every DM message counts.

at least 0

When the newest pin in this DM was made; null when nothing is pinned.

One of account_moved, account_moves_disabled, account_pending_deletion, account_suspended, admin_required, already_friends, already_member, attachment_not_found, auto_moderation_blocked, auto_moderation_disabled, auto_moderation_rule_limit, auto_moderation_rule_not_found, badge_not_found, badge_not_grantable, badge_not_held, badge_not_hideable, ban_not_found, banned, blocking_user, blocklist_not_published, body_too_large, bot_creation_disabled, bot_limit_reached, bot_not_found, bot_private, bot_required, bots_not_allowed, cannot_act_on_instance_staff, cannot_act_on_own_report, cannot_ban_owner, cannot_ban_self, cannot_change_owner, cannot_kick_owner, cannot_kick_self, cannot_remove_domain_owner, cannot_remove_organization_owner, cannot_report_self, cannot_set_member_profile, cannot_target_self, cannot_timeout_owner, cannot_timeout_self, cannot_transfer_to_bot, cannot_transfer_to_self, captcha_failed, captcha_required, captcha_unavailable, channel_limit_reached, channel_not_found, channel_not_text, channel_not_voice, command_limit_reached, command_not_found, community_full, community_limit_reached, community_linked, community_not_found, confirmation_mismatch, content_deletion_disabled, content_hold_reason_required, content_type_mismatch, delegation_not_configured, deletion_not_pending, directory_disabled, directory_requirements_unmet, discord_rate_limited, discord_templates_disabled, discord_unavailable, dm_not_allowed, domain_already_claimed, domain_limit_reached, domain_claim_limit_reached, domain_member_exists, domain_member_limit_reached, domain_member_not_found, domain_not_active, domain_not_found, domain_not_shared, domain_not_verified, domain_owner_required, domain_request_limit_reached, domain_reserved, domain_taken, email_already_verified, email_not_set, email_required, email_taken, entitlement_not_found, entitlement_required, everyone_role, export_not_found, export_not_ready, file_too_large, file_too_large_to_scan, gateway_unavailable, handle_taken, hub_token_expired, hub_token_untrusted, hub_token_wrong_instance, image_too_large, ineligible_user, interaction_already_acknowledged, interaction_expired, interaction_not_acknowledged, interaction_not_deferred, interaction_not_found, internal, invalid_action, invalid_attachment, invalid_auto_moderation_rule, invalid_badge_grant, invalid_banner_color, invalid_bio, invalid_bitrate, invalid_body, invalid_category, invalid_channel_kind, invalid_color, invalid_command, invalid_content, invalid_credentials, invalid_decision, invalid_description, invalid_display_name, invalid_domain, invalid_domain_kind, invalid_email, invalid_entitlement, invalid_expiry, invalid_handle, invalid_hub_token, invalid_image, invalid_interaction_response, invalid_join, invalid_keywords, invalid_language, invalid_max_uses, invalid_move_target, invalid_name, invalid_nickname, invalid_nonce, invalid_note, invalid_options, invalid_organization, invalid_parent, invalid_password, invalid_permissions, invalid_policy_level, invalid_positions, invalid_profile_reset, invalid_pronouns, invalid_push_subscription, invalid_query, invalid_search, invalid_search_scope, invalid_reason, invalid_report, invalid_rules_channel, invalid_setting, invalid_setup_token, invalid_signature, invalid_status, invalid_template_code, invalid_timeout, invalid_token, invalid_topic, invalid_transition, invalid_upload, invalid_user_limit, invalid_username, invalid_vanity_code, invite_limit_reached, invite_not_for_signup, invite_not_found, invite_required, last_text_channel, listing_delisted, listing_not_found, listing_state_conflict, managed_role, member_not_found, message_not_found, missing_permission, name_reserved, no_content_hold, no_terms, not_community_owner, not_found, not_in_voice, not_suspended, organization_closed, organization_exists, organization_limit_reached, organization_member_limit_reached, organization_community_limit_reached, organization_not_approved, organization_invite_not_allowed, applicant_suspended, invalid_takedown, organization_member_exists, organization_not_found, organization_owner_required, overwrite_limit_reached, owner_cannot_delete, owner_cannot_leave, owner_cannot_move, owner_required, owns_communities, pin_limit_reached, invalid_emoji, reaction_limit_reached, reactions_disabled, invalid_thread_parent, invalid_thread_kind, invalid_auto_archive_duration, invalid_thread_change, template_changed, template_channel_limit, template_not_found, template_overwrite_limit, template_overwrite_total_limit, template_role_limit, template_unreadable, thread_exists, thread_archived, thread_locked, thread_limit_reached, thread_member_limit_reached, thread_user_limit_reached, threads_disabled, not_thread, thread_member_not_found, cannot_view_thread, invalid_reference, reference_not_found, replies_disabled, thread_overwrites, policy_exists, policy_not_found, push_disabled, push_endpoint_not_allowed, push_subscription_not_found, rate_limited, rate_limiter_unavailable, registration_closed, relationship_limit_reached, relationship_not_found, report_duplicate_open, report_limit_reached, report_not_found, request_not_allowed, role_hierarchy, role_limit_reached, role_not_found, scan_unavailable, search_disabled, search_unavailable, session_not_found, signing_keys_unavailable, storage_unavailable, subject_not_found, system_message, terms_acceptance_required, terms_outdated, terms_required, tier_required, timed_out, timeout_not_found, too_many_attachments, too_many_files, too_many_syncs, topic_not_allowed, transfer_target_ineligible, unauthenticated, unsupported_type, upgrade_required, upload_already_received, upload_changed, upload_expired, upload_incomplete, upload_limit_reached, upload_malware, upload_not_found, upload_processing, upload_quota_exceeded, upload_rejected, upload_size_mismatch, uploads_paused, uploads_restricted, user_not_found, username_taken, vanity_not_found, vanity_reserved, vanity_taken, voice_channel_full, voice_disabled, voice_setting_not_allowed, webhook_disabled, webhook_limit_reached, webhook_not_found, wrong_password, feature_not_found, invalid_feature_mode, invalid_feature_percentage, invalid_feature_tier, feature_not_tier_unlockable, feature_tier_required, invalid_feature_beta, feature_beta_scope, feature_beta_not_found, reason_required, feature_unchanged, oidc_disabled, oauth_invalid_client, oauth_invalid_redirect_uri, oauth_invalid_request, reauthentication_required, oauth_grant_not_found, invalid_oauth_client, oauth_client_not_found, oauth_client_has_no_secret, public_channels_disabled, invalid_public_channel, public_channel_not_everyone, public_channel_age_restricted, age_restriction_not_allowed, sensitive_media_disabled, sensitive_media_locked, invalid_public_web, invalid_thread, invalid_answer, public_web_busy, public_web_needs_scanner, community_backup_disabled, community_backup_unavailable, backup_not_found, backup_not_ready, backup_limit_reached, restore_in_progress, not_permitted, invalid_archive, unsupported_archive, checksum_mismatch, unknown_issuer, foreign_archive, over_limits, backup_too_large, restore_not_found, invalid_download_link, community_restoring, invalid_backup_signature, restore_uploads_busy, backup_not_revocable, backup_revoked, invalid_mfa, mfa_required, mfa_sudo_required, mfa_disabled, invalid_mfa_code, mfa_not_enabled, totp_already_enabled, totp_not_enabled, mfa_setup_not_found, too_many_keys, key_already_registered, key_not_found, invalid_key_name, invalid_credential, mfa_method_unavailable, owner_mfa_required, staff_mfa_required, moderation_mfa_required, gifs_disabled, gif_direct, gif_proxy, gif_busy, gif_unavailable, invalid_share, gif_favorite_limit, invalid_gif, gif_favorite_not_found, stickers_disabled, sticker_not_found, invalid_sticker_name, invalid_sticker_description, invalid_sticker_tags, sticker_name_taken, sticker_not_usable, invalid_sticker, too_many_stickers, invalid_sticker_upload, sticker_slots_full, sticker_too_large, sticker_explicit, sticker_too_slow

With missing_permission from a message send (or a reply) or an attachment slot, the permission bits the caller lacks in that channel. Left out where the server does not name them.

With timed_out from a message send or an attachment slot, when the caller's timeout ends. Left out where the server does not name it.

Required unless files are attached.

A name for this message only, 1-80 characters, the same rules as other names.

Posts the message as a reply to a message in the webhook's channel, as for sendMessage (a webhook needs no Read Message History). Refused with replies_disabled (403) while the replies flag is off for the server, and with invalid_reference, reference_not_found or system_message (400) as for sendMessage.

Only with multipart. Describes the files by their files[n] number.

at least 0; at most 9

A display name to use instead of the part's; the stored extension stays, as for AttachmentRef.

default false

Whether the flag can be on for anyone here (its ceiling is on, it is not killed and its mode is not off). Use the community's or the account's features to decide what to show.

Whether it is on for every server and account.

The lowest tier that unlocks it while the flag is in tier mode, for "unlocked at Level N"; otherwise null.

One of standard, level_1, level_2, level_3, partner

Every registered feature flag, in registry order.

The GIF provider behind the GIF picker, or null when no provider and key are configured or the gifs flag is unavailable; clients then hide the GIF tab. Clients show the provider's attribution ("Powered by GIPHY", "Search KLIPY") and only render GIF previews for URLs on that provider's media hosts.

One of giphy, klipy,

How the GIF picker reaches the provider, or null when gif_provider is null. proxy: the client uses /gifs/*. direct (PALLOO_GIF_MODE=direct, Klipy only): the client fetches GET /gifs/direct when the picker opens and calls Klipy itself, so Klipy sees the user's IP address and searches. The Klipy key is never part of this public document.

One of proxy, direct,

Whether signup needs an email address.

Whether the instance actually sends email. When false, verification and reset links never arrive, so the client can hide "forgot password".

One of none, turnstile

The site key to render the widget with. Null when the provider is none. Render the widget with the action of the form it guards (signup, login, password_reset or deletion_cancel); the server refuses a token solved for another action or another host name than the public URL's.

How long a deleted account can still be restored.

The minimum time between two data exports.

How long a finished export can be downloaded.

The domain after the @ in addresses on this instance.

Whether people may mark their own account as moved (POST /users/@me/move), so the client can hide the option when the instance owner has it off.

Whether the server directory exists, so clients can hide Discover.

Whether AutoMod is available here (PALLOO_AUTOMOD_ENABLED and the automod flag). Where it is off for a server (the server's features), no message is checked and the rule routes answer auto_moderation_disabled.

Whether message search is available here (PALLOO_SEARCH_ENABLED and the search flag). Where it is off for a server or an account, search answers 403 search_disabled.

Whether the Discord-style name normalization is available here (PALLOO_EMOJI_NAMES_ENABLED and the emoji_names flag; see CreateChannelRequest and CreateRoleRequest). Whether it applies to a server is emoji_names in the server's features, so clients normalize names the same way before sending them. Stored names are never rewritten.

Whether Log in with Palloo is on: the OpenID Connect endpoints, Settings, Authorized Apps and the admin OAuth Apps page. Clients hide those pages while it is false; every OpenID Connect route then answers 404 oidc_disabled.

Whether Discord-style markdown is available here (PALLOO_MARKDOWN_ENABLED and the markdown flag). Whether it applies to a server's channels is markdown in the server's features; in direct messages it applies only while the flag is on for everyone (everyone in features). Where it applies, clients render message content as markdown and offer the formatting composer, only mentions that clients draw as mentions ping (not inside code, link URLs or masked link text, or after a \ escape), and push notification bodies have the markup stripped (spoilers become [spoiler]). Elsewhere content is plain text as before. Stored content is the same either way: the raw text the author typed.

Whether voice channels are available here (PALLOO_VOICE_ENABLED and the voice flag). Whether a server's voice channels connect is voice in the server's features: joining elsewhere answers 403 voice_disabled. While it is false (or the flag's kill switch is on) every voice operation answers 403 voice_disabled.

Whether threads are available here (PALLOO_THREADS_ENABLED and the threads flag). Where the server's features lacks threads, starting one answers threads_disabled. Existing threads keep working either way.

Whether new dark mode avatars, server avatars and server icons can be set (PALLOO_DARK_IMAGES_ENABLED). When false, the _dark upload purposes and setting a _dark field to an upload return 403 dark_images_disabled, and clients hide the controls. Stored dark images are still returned and shown, and can still be removed.

Whether banners keep their animation (PALLOO_ANIMATED_BANNERS_ENABLED). When false, an animated GIF banner is stored as its first frame and clients show every banner still; animated banners stored earlier keep their a_ hash, but setting a banner field to an animated upload (an a_ hash finalized while it was on) returns 403 animated_banners_disabled.

The terms of service (PALLOO_TERMS_URL), or null when none is configured.

The privacy policy (PALLOO_PRIVACY_URL), or null.

The current terms version (PALLOO_TERMS_VERSION), or null when accepting terms is not required. Signup must send it as terms_version, and a signed-in user whose terms_acceptance_required is true must accept it before using the app.

Uploads and images. Images of users and communities are public at {base_url}/avatars/{user_id}/{hash}/{size}.png (sizes 128 and 512, square), {base_url}/banners/{user_id}/{hash}/{width}.png (600 by 240 and 1200 by 480), {base_url}/icons/{community_id}/{hash}/{size}.png (128 and 512) and {base_url}/community-banners/{community_id}/{hash}/{width}.png (480 by 270 and 960 by 540). Server profile images are {base_url}/member-avatars/{user_id}/{hash}/{size}.png (like avatars) and {base_url}/member-banners/{user_id}/{hash}/{width}.png (like banners). A hash starting with a_ also has an animated original.gif (avatars, icons and every kind of banner can be animated; the PNG renditions are the first frame). The base is never the app's own origin; allow it in img-src and media-src.

Always an absolute URL on a host separate from the app: the CDN or bucket address with S3 storage, or {PALLOO_MEDIA_URL}/media/public with disk storage. The server refuses to start without such a host.

0 for no daily quota.

How long signed attachment URLs work, at least.

Every community tier with its limits and perks, lowest first.

Whether creating a server from a Discord template is available (PALLOO_DISCORD_TEMPLATES_ENABLED), so clients can hide the option.

Whether delete_content may be set when deleting an account (PALLOO_ACCOUNT_CONTENT_DELETION_ENABLED), so clients can hide the option.

One of message, deferred

Required with message, not allowed with deferred.

default false

pattern ^palloo_int_

The checked value; IDs are uppercase.

timeout: no answer within 3 seconds; expired: deferred and never completed within 15 minutes.

One of timeout, expired

Case-sensitive.

pattern ^[0-9A-Za-z]{8}$

at least 0

Null means unlimited.

at least 1; at most 1000

Null means the invite never expires.

The community banner (community-banners kind); an a_ hash is animated.

at least 0

Whether the code is the community's vanity code.

default false

default false

Shown instead of the display name in this community, when set.

The server avatar, shown instead of the user's avatar in this community. Its files live under the member-avatars kind, owned by the user.

The optional dark mode server avatar (member-avatars kind). In a dark theme clients show it first, then avatar, then the user's avatar_dark, then the user's avatar.

The server banner (member-banners kind), shown instead of the user's banner here.

The server About Me, shown instead of the user's About Me here when not empty.

at most 190 characters

The server pronouns, shown instead of the user's pronouns here when not empty.

at most 40 characters

IDs of the member's roles, ordered by ID. @everyone is implied and never listed.

When the member's timeout ends, or null when they are not timed out (an ended timeout reads as null). Clients can schedule their own update for that moment; no event is sent when it ends.

Present only for bot members: whether the bot's owner turned on the presence intent, so the bot receives members' status when the community allows it (bot_presence_allowed). Not updated live when the owner changes it.

Pass as after to get the next page. Null on the last page.

pattern ^[0-9A-HJKMNP-TV-Z]{26}$

The channel's community. Absent for messages in direct messages.

Set when a webhook posted the message; author is then the webhook's display (kind: "webhook", its ID, and the name it posted with). Webhook messages cannot be edited. The webhook may have been deleted since.

Empty for a bot without the message content permission, unless the bot wrote the message or is in mentions (DMs are exempt). May be empty when the message has attachments.

In upload order. Empty for a bot without the message content permission, as with content.

at most 10 items

The sticker the message was sent with; left out when it has none.

at most 1 items

The GIF the message was sent with through the picker; left out otherwise, and dropped when an edit removes the URL from content. Clients embed only this URL.

When the content was last edited; null if never.

Users mentioned with <@USER_ID> who are members and can view the channel (in a DM: who are participants), in the order they first appear. Mentions of anyone else are plain text. A user who no longer exists is left out. A reply sent with allowed_mentions.replied_user also lists the author of the message it replies to, last, as on Discord.

Roles mentioned with <@&ROLE_ID> that ping: the role is mentionable, or the author had Mention Everyone in the channel. Other role mentions are plain text. Can name a role that was deleted later. Always empty in DMs.

True when the content has @everyone or @here and the author had Mention Everyone in the channel. Always false in DMs. See mention_here for who @here pinged.

True when mention_everyone comes from @here alone (the content has no pinging @everyone). Such a message pinged only the members who could view the channel and whose visible status was online, idle or dnd when it was sent (not offline, not invisible), as on Discord. A connected client counts the ping for its own user unless the user's chosen status is invisible. Always false in DMs and when mention_everyone is false.

Set on a bot's answer to a slash command; who used which command.

True on an ephemeral answer to a slash command: it only reaches the person who used the command, over the gateway, and is never stored (history never returns it, and it is gone after a reload).

Only on the response to the send that carried it, and on the matching message_create gateway event, so a client can match its pending message. Never stored or returned later.

default for everything people, bots and webhooks post. channel_pinned_message is the system message the server posts when someone pins a message ("X pinned a message to this channel"): author is who pinned, content is always empty, there are no attachments or mentions, and message_reference names the pinned message. thread_created is posted in a text channel when someone starts a public thread from the channel header ("X started a thread"): message_reference.channel_id is the thread, and thread describes it while it exists. thread_starter_message is the first message of a thread started from a message: message_reference names that message in the parent and referenced_message carries it while it exists. auto_moderation_action is an AutoMod alert in the rule's alert channel: author is the member who triggered the rule, content is empty (what they sent, blocked or not, is auto_moderation.content, as on Discord, so a bot reading content in a staff channel never sees member text), there are no mentions or attachments, and auto_moderation says what happened. Only the server creates system messages; they cannot be edited or pinned, and clients render them from kind, author and the references. Only alerts can be reported, and deleting one needs Manage Messages even for its author.

One of default, channel_pinned_message, thread_created, thread_starter_message, auto_moderation_action

Whether the message is pinned in its channel. See GET /channels/{id}/pins.

The message's reactions, oldest emoji first, with me for the caller. Present on history and pins while the reactions flag is on for the channel (an empty list when there are none), and absent everywhere else, including every gateway message event: a client keeps the reactions it has when a message event has no reactions and follows the message_reaction_* events instead.

at most 20 items

On system messages: the pinned message, the thread (channel_id alone) or the message a thread was started from. On a default message it makes the message a reply: message_id is the message replied to, always in the same channel. It may have been changed or deleted since.

The public thread started from this message, or announced by a thread_created message, while it exists. Private threads never appear here.

On a thread_starter_message, and on a reply, while the message it names exists and the viewer may read it. It never carries its own referenced_message. Absent on a reply means the original was deleted or is not available to this viewer (a viewer without Read Message History only gets it for messages sent after they connected); clients show "Original message was deleted". Search results, report snapshots and the server directory preview leave it out and keep only message_reference. Edits to the original arrive as its own message_update, not as one per reply.

Only on an auto_moderation_action message.

One of user, bot, webhook

Always null for a webhook.

The dark mode avatar. Always null for a webhook.

at most 500 items

A ULID. Sorts lexically in creation order.

The command's name.

Move the member to this voice channel, or disconnect them with null.

instance_admin for actions an instance admin took from the admin report queue; auto_moderation for AutoMod's blocks, alerts and timeouts, whose actor_id is the rule's ID.

One of member, instance_admin, auto_moderation

The actor as they are now; null once the account is gone.

One of community, channel, role, user, message, report, attachment, auto_moderation_rule, sticker

For a user target, the user as they are now; null otherwise or once the account is gone.

The report the action was taken from. Always null for callers without Moderate Members.

Action-specific. Updates record each change as {from, to} under changes; channel creation and deletion record name and kind; role creation records name and permissions; member role changes record role_id and role_name; overwrite changes record the overwrite's type, id, allow and deny; reorders record the moved roles; timeouts record until; bans record was_member; message deletions, pins and unpins record channel_id, author_id and webhook, or only channel_hidden: true for a caller who cannot view that channel now (channel creations and updates that carry a topic are hidden the same way); report updates record status, assignee_id and note_changed; bot additions record permissions and role_id; attachment quarantines record the attachment's channel_id, message_id and filename; vanity code changes record changes.vanity_code as {from, to}. AutoMod rule changes record name, trigger_type and, for updates, changes (keyword lists as {added, removed}). AutoMod blocks, alerts and timeouts record rule_id, rule_name, trigger_type, channel_id, message_id, edit, content, attachments, matched_keyword and matched_content (alerts add alert_channel_id and alert_message_id, timeouts duration_seconds and until); like message deletions they carry only channel_hidden: true for a caller who cannot view that channel now, and after 90 days the content fields are removed and content_expired is set.

Pass as before to get the next page. Null on the last page.

pattern ^[0-9A-HJKMNP-TV-Z]{26}$

One of authorization_code, refresh_token

One of urn:ietf:params:oauth:client-assertion-type:jwt-bearer

Opaque; only opens the userinfo endpoint. Valid 10 minutes.

One of Bearer, DPoP

Single use; valid 30 days.

A JWT valid 5 minutes, signed with the app's id_token_signed_response_alg (RS256 unless registered otherwise), with only iss, aud, sub, iat, exp, auth_time, amr, sid, at_hash and (from a code) nonce. The scope claims (profile, email, palloo_instance_role) are only at userinfo.

The user ID; it never changes.

With profile.

With profile: the display name.

With profile, when the user has an avatar: its 512 px PNG.

With email, when the user set one.

With email.

With palloo:staff: the user's instance role, or null. Also null while the mfa feature is on and the sign-in's amr lacks mfa.

One of owner, admin,

The member's highest role (by position) with hoist set, which is the group the member list shows them under; null for the plain "Online" group.

at least 0

at least 0

at most 100 items

The domain claim it was verified with; null once the claim is removed.

One of pending, approved, rejected, revoked

Approved and its domain claim is active now; only then do members and communities show the badge.

Active members; the owner and instance admins also see invitations.

One of invited, active,

One of invited, active

The organization's verified domain, in its ASCII (punycode) form.

One of role, member

The role ID (the community ID for @everyone) or the member's user ID.

A 64-bit permission set as a decimal string. See the roles tag for the bits.

A 64-bit permission set as a decimal string. See the roles tag for the bits.

Community-wide permissions (everything for the owner and for Administrator).

Effective permissions in each channel the caller can view, in channel order. Channels the caller cannot view are left out.

When the caller's timeout ends, or null. While timed out, permissions and every channel's permissions are already cut to View Channel and Read Message History.

Newest pin first.

at most 50 items

A custom status (for bots, their activity). Hide it once expires_at has passed; no event is sent when it expires.

Only on a presence_update that arrived because the connection follows that community (with subscribe_presence, or a bot with the presence intent). Absent on updates about friends and DM partners, on the offline the server sends when a block starts or someone stops being visible, and in lists. Presence is per user, not per community: the same status applies everywhere the user appears.

The optional dark mode avatar (same avatars kind as avatar). Clients show it instead of avatar when the viewer uses a dark theme; null means use avatar.

at most 190 characters

at most 40 characters

When the account was created.

Set when the account moved; clients should look the new address up instead.

Active domain claims the account shows, in ASCII (punycode) form; show mixed-script names as punycode. Empty when the account hides the verified_domain badge.

Visible badges in display order.

The optional dark mode avatar (same avatars kind as avatar). Clients show it instead of avatar when the viewer uses a dark theme; null means use avatar.

The channel (or a thread's parent) is published.

The page is served right now.

A thread hidden from the web.

A ULID. Sorts lexically in creation order.

The master switch.

How authors are named on public pages; member shows everyone as "Member".

One of member, display_name

The invite the join button uses when there is no vanity invite. Only for Manage Community.

The community's public page.

Whether the community's pages are served right now.

What must hold before pages are served, only for members with Manage Community (empty for everyone else). upload_scanner: the instance scans uploads (the master switch cannot be turned on without it). staff_approval: the community has a visible directory listing or instance staff approved its public pages.

One of upload_scanner, staff_approval, directory_enabled, community_age, owner_standing, safety

Served right now: the community is live and @everyone can read the channel.

Up to 512 characters, for the moderation log.

How many people reacted with it.

at least 1

Whether the caller is one of them.

Always null for now; reserved for custom emoji.

The Unicode emoji.

at least 1 characters; at most 64 characters

In the order they reacted.

at most 100 items

Absent for direct messages.

The newest message the caller has read; null if none.

Messages that pinged the caller since the channel was last acked. In a DM every message from another participant counts.

at least 0