Documentation Index
Fetch the complete documentation index at: https://docs.fluxer.app/llms.txt
Use this file to discover all available pages before exploring further.
AddSnowflakeReservationRequest
Related endpoints
| Field | Type | Description |
|---|
| email | EmailType | |
| snowflake | SnowflakeType | |
AdminArchiveResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| archive_id | SnowflakeType | |
| completed_at | ?string | |
| download_url_expires_at | ?string | |
| error_message | ?string | |
| expires_at | ?string | |
| failed_at | ?string | |
| file_size | ?string | |
| progress_percent | number | |
| progress_step | ?string | |
| requested_at | string | |
| requested_by | SnowflakeType | |
| started_at | ?string | |
| subject_id | SnowflakeType | |
| subject_type | AdminArchiveResponseSchemaSubjectType | Type of subject being archived |
AdminAuditLogResponseSchema
| Field | Type | Description |
|---|
| action | string | |
| admin_user_id | SnowflakeType | |
| audit_log_reason | ?string | |
| created_at | string | |
| log_id | SnowflakeType | |
| metadata | map<string, string> | |
| target_id | string | The ID of the affected entity (user, channel, role, invite code, etc.) |
| target_type | string | |
AdminUserDmChannelSchema
| Field | Type | Description |
|---|
| channel_id | SnowflakeType | |
| channel_type | ?Int32Type | |
| is_open | boolean | |
| last_message_id | ?SnowflakeType | |
| recipient_ids | SnowflakeType[] | |
AdminUsersMeResponse
Related endpoints
| Field | Type | Description |
|---|
| user | UserAdminResponseSchema | |
AuditLogsListResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| logs | AdminAuditLogResponseSchema[] | |
| total | number | |
BanCheckResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| banned | boolean | |
BanEmailRequest
Related endpoints
| Field | Type | Description |
|---|
| email | EmailType | |
BanGuildMemberRequest
Related endpoints
| Field | Type | Description |
|---|
| ban_duration_seconds? | integer (int53) | Duration of the ban in seconds (0 for permanent, or a valid temporary duration) |
| delete_message_days? | integer (int32) | Number of days of messages to delete from the banned user (0-7) |
| guild_id | SnowflakeType | |
| reason? | ?string | The reason for the ban (max 512 characters) |
| user_id | SnowflakeType | |
BanIpRequest
Related endpoints
| Field | Type | Description |
|---|
| ip | string | IPv4/IPv6 address or CIDR range to ban |
BanPhoneRequest
Related endpoints
| Field | Type | Description |
|---|
| phone | PhoneNumberType | |
BulkAddGuildMembersRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| user_ids | SnowflakeType[] | List of user IDs to add as members |
BulkOperationFailedResponse
| Field | Type | Description |
|---|
| error | string | |
| id | SnowflakeType | |
BulkOperationResponse
Related endpoints
| Field | Type | Description |
|---|
| failed | BulkOperationFailedResponse[] | |
| successful | SnowflakeType[] | |
BulkScheduleUserDeletionRequest
Related endpoints
| Field | Type | Description |
|---|
| days_until_deletion? | integer (int32) | Number of days until the accounts are deleted |
| public_reason? | string | Public-facing reason for the deletion |
| reason_code | integer (int32) | Code indicating the reason for deletion |
| user_ids | SnowflakeType[] | List of user IDs to schedule deletion for |
BulkUpdateGuildFeaturesRequest
Related endpoints
| Field | Type | Description |
|---|
| add_features? | GuildFeatureSchema[] | Guild features to add to all specified guilds |
| guild_ids | SnowflakeType[] | List of guild IDs to update |
| remove_features? | GuildFeatureSchema[] | Guild features to remove from all specified guilds |
BulkUpdateUserFlagsRequest
Related endpoints
| Field | Type | Description |
|---|
| add_flags? | UserFlags[] | User flags to add to all specified users |
| remove_flags? | UserFlags[] | User flags to remove from all specified users |
| user_ids | SnowflakeType[] | List of user IDs to update |
CancelBulkMessageDeletionRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
ChangeDobRequest
Related endpoints
| Field | Type | Description |
|---|
| date_of_birth | string | New date of birth in YYYY-MM-DD format |
| user_id | SnowflakeType | |
ChangeEmailRequest
Related endpoints
| Field | Type | Description |
|---|
| email | EmailType | |
| user_id | SnowflakeType | |
ChangeUsernameRequest
Related endpoints
| Field | Type | Description |
|---|
| discriminator? | Int32Type | |
| user_id | SnowflakeType | |
| username | UsernameType | |
ClearGuildFieldsRequest
Related endpoints
| Field | Type | Description |
|---|
| fields | ClearGuildFieldsRequestFields[] | List of guild image fields to clear |
| guild_id | SnowflakeType | |
ClearUserFieldsRequest
Related endpoints
| Field | Type | Description |
|---|
| fields | ClearUserFieldsRequestFields[] | List of profile fields to clear |
| user_id | SnowflakeType | |
CodesResponse
Related endpoints
| Field | Type | Description |
|---|
| codes | string[] | |
CreateAdminApiKeyRequest
Related endpoints
| Field | Type | Description |
|---|
| acls | string[] | List of access control permissions for the key |
| expires_in_days? | integer (int32) | Number of days until the key expires |
| name | string | Display name for the API key |
CreateAdminApiKeyResponse
Related endpoints
| Field | Type | Description |
|---|
| acls | string[] | List of access control permissions for the key |
| created_at | string | ISO 8601 timestamp when the key was created |
| expires_at | ?string | ISO 8601 timestamp when the key expires, or null if no expiration |
| key | string | The generated API key secret (only shown once) |
| key_id | SnowflakeType | Unique identifier for the API key |
| name | string | Display name for the API key |
CreateSystemDmJobRequest
Related endpoints
| Field | Type | Description |
|---|
| content | string | Message content to send to users |
| excluded_guild_ids? | SnowflakeType[] | Guild IDs whose members should be excluded |
| registration_end? | ?string | Only target users registered before this date |
| registration_start? | ?string | Only target users registered after this date |
CreateVoiceRegionRequest
Related endpoints
| Field | Type | Description |
|---|
| allowed_guild_ids? | SnowflakeType[] | Guild IDs explicitly allowed to use this region |
| allowed_user_ids? | SnowflakeType[] | User IDs explicitly allowed to use this region |
| emoji | string | Emoji representing the region |
| id | SnowflakeType | Unique identifier for the voice region |
| is_default? | boolean | Whether this is the default region |
| latitude | number | Geographic latitude coordinate |
| longitude | number | Geographic longitude coordinate |
| name | string | Display name of the voice region |
| required_guild_features? | string[] | Guild features required to use this region |
| vip_only? | boolean | Whether this region is restricted to VIP users |
CreateVoiceRegionResponse
Related endpoints
| Field | Type | Description |
|---|
| region | VoiceRegionAdminResponse | Created voice region |
CreateVoiceServerRequest
Related endpoints
| Field | Type | Description |
|---|
| allowed_guild_ids? | SnowflakeType[] | Guild IDs explicitly allowed to use this server |
| allowed_user_ids? | SnowflakeType[] | User IDs explicitly allowed to use this server |
| api_key | string | API key for authenticating with the voice server |
| api_secret | string | API secret for authenticating with the voice server |
| endpoint | string (uri) | Client signal WebSocket endpoint URL for the voice server |
| is_active? | boolean | Whether the server is currently active |
| region_id | SnowflakeType | ID of the region this server belongs to |
| required_guild_features? | string[] | Guild features required to use this server |
| server_id | SnowflakeType | Unique identifier for the voice server |
| vip_only? | boolean | Whether this server is restricted to VIP users |
CreateVoiceServerResponse
Related endpoints
| Field | Type | Description |
|---|
| server | VoiceServerAdminResponse | Created voice server |
DeleteAllUserMessagesRequest
Related endpoints
| Field | Type | Description |
|---|
| dry_run? | boolean | |
| user_id | SnowflakeType | |
DeleteAllUserMessagesResponse
Related endpoints
| Field | Type | Description |
|---|
| channel_count | Int32Type | |
| dry_run | boolean | |
| job_id? | SnowflakeType | |
| message_count | Int32Type | |
| success | enum<true> | |
DeleteApiKeyResponse
Related endpoints
| Field | Type | Description |
|---|
| success | enum<true> | |
DeleteGuildRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
DeleteMessageRequest
Related endpoints
| Field | Type | Description |
|---|
| channel_id | SnowflakeType | |
| message_id | SnowflakeType | |
DeleteMessageResponse
Related endpoints
| Field | Type | Description |
|---|
| success | enum<true> | |
DeleteSnowflakeReservationRequest
Related endpoints
| Field | Type | Description |
|---|
| email | EmailType | |
DeleteVoiceRegionRequest
Related endpoints
| Field | Type | Description |
|---|
| id | SnowflakeType | ID of the voice region to delete |
DeleteVoiceResponse
Related endpoints
| Field | Type | Description |
|---|
| success | boolean | Whether the deletion was successful |
DeleteVoiceServerRequest
Related endpoints
| Field | Type | Description |
|---|
| region_id | SnowflakeType | ID of the region the server belongs to |
| server_id | SnowflakeType | ID of the voice server to delete |
DeleteWebAuthnCredentialRequest
Related endpoints
| Field | Type | Description |
|---|
| credential_id | SnowflakeType | ID of the WebAuthn credential to delete |
| user_id | SnowflakeType | |
DisableForSuspiciousActivityRequest
Related endpoints
DisableMfaRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
DiscoveryAdminRejectRequest
Related endpoints
| Field | Type | Description |
|---|
| reason | string | Rejection reason |
DiscoveryAdminRemoveRequest
Related endpoints
| Field | Type | Description |
|---|
| reason | string | Removal reason |
DiscoveryAdminReviewRequest
Related endpoints
| Field | Type | Description |
|---|
| reason? | string | Review reason |
DiscoveryApplicationResponse
Related endpoints
| Field | Type | Description |
|---|
| applied_at | string | Application timestamp |
| category_type | number | Discovery category type |
| description | string | Discovery description |
| guild_id | SnowflakeType | Guild ID |
| review_reason? | ?string | Review reason |
| reviewed_at? | ?string | Review timestamp |
| status | string | Application status |
DownloadUrlResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| downloadUrl | string | |
| expiresAt | string | |
Error
Related endpoints
| Field | Type | Description |
|---|
| code | APIErrorCode | |
| errors? | ValidationErrorItem[] | Field-specific validation errors |
| message | string | Human-readable error message |
ExpandVisionarySlotsRequest
Related endpoints
| Field | Type | Description |
|---|
| count | integer (int32) | Number of new slots to create |
ForceAddUserToGuildRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| user_id | SnowflakeType | |
GenerateGiftCodesRequest
Related endpoints
| Field | Type | Description |
|---|
| count | integer (int32) | Number of gift codes to generate |
| product_type | enum<gift_1_month, gift_1_year> | Type of gift subscription |
GetArchiveResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| archive | ?AdminArchiveResponseSchema | |
GetIndexRefreshStatusRequest
Related endpoints
| Field | Type | Description |
|---|
| job_id | SnowflakeType | ID of the index refresh job to check |
GetProcessMemoryStatsRequest
Related endpoints
| Field | Type | Description |
|---|
| limit? | integer (int32) | |
GetVoiceRegionRequest
Related endpoints
| Field | Type | Description |
|---|
| id | SnowflakeType | ID of the voice region to retrieve |
| include_servers? | boolean | Whether to include voice servers in the response |
GetVoiceRegionResponse
Related endpoints
| Field | Type | Description |
|---|
| region | ?VoiceRegionWithServersResponse | Voice region details or null if not found |
GetVoiceServerRequest
Related endpoints
| Field | Type | Description |
|---|
| region_id | SnowflakeType | ID of the region the server belongs to |
| server_id | SnowflakeType | ID of the voice server to retrieve |
GetVoiceServerResponse
Related endpoints
| Field | Type | Description |
|---|
| server | ?VoiceServerAdminResponse | Voice server details or null if not found |
GuildMemoryStatsResponse
Related endpoints
GuildUpdateResponse
Related endpoints
| Field | Type | Description |
|---|
| guild | GuildUpdateResponseGuild | |
IndexRefreshStatusResponse
Related endpoints
Type: MessageShredStatusNotFoundResponse | IndexRefreshStatusResponseOneOf1
InstanceConfigResponse
Related endpoints
| Field | Type | Description |
|---|
| manual_review_active_now | boolean | |
| manual_review_enabled | boolean | |
| manual_review_schedule_enabled | boolean | |
| manual_review_schedule_end_hour_utc | Int32Type | |
| manual_review_schedule_start_hour_utc | Int32Type | |
| registration_alerts_webhook_url | ?string | |
| self_hosted | boolean | |
| sso | SsoConfigResponse | |
| system_alerts_webhook_url | ?string | |
InstanceConfigUpdateRequest
Related endpoints
| Field | Type | Description |
|---|
| manual_review_enabled? | boolean | |
| manual_review_schedule_enabled? | boolean | |
| manual_review_schedule_end_hour_utc? | integer (int32) | |
| manual_review_schedule_start_hour_utc? | integer (int32) | |
| registration_alerts_webhook_url? | ?string (uri) | |
| sso? | InstanceConfigUpdateRequestSso | |
| system_alerts_webhook_url? | ?string (uri) | |
KickGuildMemberRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| user_id | SnowflakeType | |
LegalHoldRequest
Related endpoints
| Field | Type | Description |
|---|
| expires_at? | string | ISO 8601 timestamp when the legal hold expires |
LegalHoldResponse
Related endpoints
| Field | Type | Description |
|---|
| held | boolean | |
LimitConfigGetResponse
Related endpoints
| Field | Type | Description |
|---|
| bounds? | map<string, LimitConfigGetResponseBoundsAdditionalProperties> | |
| categories | map<string, string> | |
| defaults | map<string, JSON value> | |
| limit_config | LimitConfigGetResponseLimitConfig | |
| limit_config_json | string | |
| limit_keys | string[] | |
| metadata | map<string, LimitConfigGetResponseMetadataAdditionalProperties> | |
| self_hosted | boolean | |
LimitConfigUpdateRequest
Related endpoints
| Field | Type | Description |
|---|
| limit_config | LimitConfigUpdateRequestLimitConfig | New limit configuration snapshot |
LimitFilterResponse
| Field | Type | Description |
|---|
| guildFeatures? | string[] | Guild feature filters for this limit rule |
| traits? | string[] | Trait filters for this limit rule |
LimitRuleResponse
| Field | Type | Description |
|---|
| filters? | LimitFilterResponse | |
| id | SnowflakeType | Unique identifier for this limit rule |
| overrides | map<string, number> | Map of limit keys to their override values (differences from defaults) |
ListAdminApiKeyResponse
Related endpoints
| Field | Type | Description |
|---|
| acls | string[] | List of access control permissions for the key |
| created_at | string | ISO 8601 timestamp when the key was created |
| created_by_user_id | SnowflakeType | User ID of the admin who created this key |
| expires_at | ?string | ISO 8601 timestamp when the key expires, or null if no expiration |
| key_id | SnowflakeType | Unique identifier for the API key |
| last_used_at | ?string | ISO 8601 timestamp when the key was last used, or null if never used |
| name | string | Display name for the API key |
ListArchivesRequest
Related endpoints
| Field | Type | Description |
|---|
| include_expired? | boolean | Whether to include expired archives |
| limit? | number | Maximum number of archives to return |
| requested_by? | SnowflakeType | |
| subject_id? | SnowflakeType | |
| subject_type? | ListArchivesRequestSubjectType | Type of archives to list |
ListArchivesResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| archives | AdminArchiveResponseSchema[] | |
ListAuditLogsRequest
Related endpoints
| Field | Type | Description |
|---|
| admin_user_id? | SnowflakeType | |
| limit? | integer (int32) | Maximum number of entries to return |
| offset? | integer (int64) | Number of entries to skip |
| target_id? | string | Filter by target entity ID (user, channel, role, invite code, etc.) |
| target_type? | string | Filter by target entity type |
ListBansRequest
Related endpoints
| Field | Type | Description |
|---|
| limit? | integer (int32) | Maximum number of bans to return |
ListEmailBansResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| bans | EmailType[] | |
ListGuildEmojisResponse
Related endpoints
| Field | Type | Description |
|---|
| emojis | GuildAssetItemSchema[] | |
| guild_id | SnowflakeType | |
ListGuildMembersRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| limit? | integer (int32) | |
| offset? | integer (int64) | |
ListGuildMembersResponse
Related endpoints
ListGuildStickersResponse
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| stickers | GuildAssetItemSchema[] | |
ListIpBansResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| bans | IpBanListEntrySchema[] | |
ListPhoneBansResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| bans | PhoneNumberType[] | |
ListReportsRequest
Related endpoints
| Field | Type | Description |
|---|
| limit? | integer (int32) | Maximum number of reports to return |
| offset? | integer (int64) | Number of reports to skip |
| status? | ReportStatus | |
ListReportsResponse
Related endpoints
| Field | Type | Description |
|---|
| reports | ReportAdminResponseSchema[] | |
ListSnowflakeReservationsResponse
Related endpoints
| Field | Type | Description |
|---|
| reservations | SnowflakeReservationEntry[] | List of snowflake reservations |
ListSystemDmJobsResponse
Related endpoints
| Field | Type | Description |
|---|
| jobs | SystemDmJobResponse[] | List of system DM jobs |
| next_cursor? | ?string | Pagination cursor for the next page |
ListUserChangeLogRequest
Related endpoints
| Field | Type | Description |
|---|
| limit? | number | Maximum number of entries to return |
| page_token? | string | Pagination token for the next page of results |
| user_id | SnowflakeType | |
ListUserChangeLogResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| entries | UserContactChangeLogEntrySchema[] | |
| next_page_token | ?string | |
ListUserDmChannelsRequest
Related endpoints
| Field | Type | Description |
|---|
| after? | SnowflakeType | |
| before? | SnowflakeType | |
| limit? | integer (int32) | Maximum number of DM channels to return |
| user_id | SnowflakeType | |
ListUserDmChannelsResponse
Related endpoints
| Field | Type | Description |
|---|
| channels | AdminUserDmChannelSchema[] | |
ListUserGuildsRequest
Related endpoints
| Field | Type | Description |
|---|
| after? | SnowflakeType | |
| before? | SnowflakeType | |
| limit? | integer (int32) | |
| user_id | SnowflakeType | |
| with_counts? | boolean | |
ListUserGuildsResponse
Related endpoints
| Field | Type | Description |
|---|
| guilds | GuildAdminResponse[] | |
ListUserSessionsRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
ListUserSessionsResponse
Related endpoints
| Field | Type | Description |
|---|
| sessions | UserSessionResponse[] | |
ListVisionarySlotsResponse
Related endpoints
| Field | Type | Description |
|---|
| reserved_count | integer (int32) | Number of reserved slots |
| slots | VisionarySlotSchema[] | List of all visionary slots |
| total_count | integer (int32) | Total number of slots |
ListVoiceRegionsRequest
Related endpoints
| Field | Type | Description |
|---|
| include_servers? | boolean | Whether to include voice servers in the response |
ListVoiceRegionsResponse
Related endpoints
| Field | Type | Description |
|---|
| regions | VoiceRegionAdminResponse[] | List of voice regions |
ListVoiceServersRequest
Related endpoints
| Field | Type | Description |
|---|
| region_id | SnowflakeType | ID of the region to list servers for |
ListVoiceServersResponse
Related endpoints
| Field | Type | Description |
|---|
| servers | VoiceServerAdminResponse[] | List of voice servers |
ListWebAuthnCredentialsRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
LookupGuildRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
LookupGuildResponse
Related endpoints
| Field | Type | Description |
|---|
| guild | ?LookupGuildResponseGuild | |
LookupMessageByAttachmentRequest
Related endpoints
| Field | Type | Description |
|---|
| attachment_id | SnowflakeType | |
| channel_id | SnowflakeType | |
| context_limit? | integer (int32) | |
| filename | string | |
LookupMessageRequest
Related endpoints
| Field | Type | Description |
|---|
| channel_id | SnowflakeType | |
| context_limit? | integer (int32) | |
| message_id | SnowflakeType | |
LookupMessageResponse
Related endpoints
LookupUserByIdsRequest
| Field | Type | Description |
|---|
| user_ids | SnowflakeType[] | |
LookupUserByQueryRequest
| Field | Type | Description |
|---|
| query | string | |
LookupUserRequest
Related endpoints
Type: LookupUserByQueryRequest | LookupUserByIdsRequest
LookupUserResponse
Related endpoints
| Field | Type | Description |
|---|
| users | UserAdminResponseSchema[] | |
MessageShredRequest
Related endpoints
| Field | Type | Description |
|---|
| entries | DeleteMessageRequest[] | |
| user_id | SnowflakeType | |
MessageShredResponse
Related endpoints
| Field | Type | Description |
|---|
| job_id | SnowflakeType | |
| requested? | integer (int64) | |
| success | enum<true> | |
MessageShredStatusRequest
Related endpoints
| Field | Type | Description |
|---|
| job_id | SnowflakeType | |
MessageShredStatusResponse
Related endpoints
Type: MessageShredStatusNotFoundResponse | MessageShredStatusProgressResponse
NcmecSubmissionStatusResponse
Related endpoints
| Field | Type | Description |
|---|
| failure_reason | ?string | Reason for submission failure if failed |
| ncmec_report_id | ?SnowflakeType | NCMEC report ID if submitted |
| status | NcmecSubmissionStatusResponseStatus | NCMEC submission status |
| submitted_at | ?string | ISO 8601 timestamp when the report was submitted |
| submitted_by_admin_id | ?SnowflakeType | ID of the admin who submitted the report |
NcmecSubmitResultResponse
Related endpoints
| Field | Type | Description |
|---|
| error | ?string | |
| ncmec_report_id | ?SnowflakeType | |
| success | boolean | |
NodeStatsResponse
Related endpoints
| Field | Type | Description |
|---|
| calls | Int32Type | |
| guilds | Int32Type | |
| memory | NodeStatsResponseMemory | |
| presences | Int32Type | |
| process_count | Int32Type | |
| process_limit | Int32Type | |
| sessions | Int32Type | |
| status | string | |
| uptime_seconds | Int32Type | |
PurgeGuildAssetErrorSchema
| Field | Type | Description |
|---|
| error | string | |
| id | SnowflakeType | |
PurgeGuildAssetResultSchema
| Field | Type | Description |
|---|
| asset_type | PurgeGuildAssetResultSchemaAssetType | Type of guild asset |
| found_in_db | boolean | Whether the asset was found in the database |
| guild_id | ?SnowflakeType | ID of the guild the asset belongs to |
| id | SnowflakeType | Unique identifier of the asset |
PurgeGuildAssetsRequest
Related endpoints
| Field | Type | Description |
|---|
| ids | SnowflakeType[] | List of asset IDs to purge |
PurgeGuildAssetsResponseSchema
Related endpoints
RefreshSearchIndexRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id? | SnowflakeType | |
| index_type | RefreshSearchIndexRequestIndexType | Type of search index to refresh |
| user_id? | SnowflakeType | |
RefreshSearchIndexResponse
Related endpoints
| Field | Type | Description |
|---|
| job_id | SnowflakeType | |
| success | enum<true> | |
ReloadAllGuildsResponse
Related endpoints
| Field | Type | Description |
|---|
| count | Int32Type | |
ReloadGuildRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
ReloadGuildsRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_ids | SnowflakeType[] | List of guild IDs to reload |
ReportAdminResponseSchema
Related endpoints
| Field | Type | Description |
|---|
| additional_info | ?string | |
| category | ?string | |
| message_context? | ReportAdminResponseSchemaMessageContextItem[] | |
| mutual_dm_channel_id? | ?SnowflakeType | |
| public_comment | ?string | |
| report_id | SnowflakeType | |
| report_type | ReportType | |
| reported_at | string | |
| reported_channel_id | ?SnowflakeType | |
| reported_channel_name | ?string | |
| reported_guild_id | ?SnowflakeType | |
| reported_guild_invite_code | ?string | |
| reported_guild_name | ?string | |
| reported_message_id | ?SnowflakeType | |
| reported_user_avatar_hash | ?string | |
| reported_user_discriminator | ?string | |
| reported_user_id | ?SnowflakeType | |
| reported_user_tag | ?string | |
| reported_user_username | ?string | |
| reporter_country_of_residence | ?string | |
| reporter_discriminator | ?string | |
| reporter_email | ?string | |
| reporter_full_legal_name | ?string | |
| reporter_id | ?SnowflakeType | |
| reporter_tag | ?string | |
| reporter_username | ?string | |
| resolved_at | ?string | |
| resolved_by_admin_id | ?SnowflakeType | |
| status | ReportStatus | |
ResendVerificationEmailRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
ReserveVisionarySlotRequest
Related endpoints
| Field | Type | Description |
|---|
| slot_index | integer (int32) | Slot index to reserve (must be >= 1) |
| user_id | ?Int64StringType | User ID to reserve the slot for, or null to unreserve (special value -1 is also valid) |
ResolveReportRequest
Related endpoints
| Field | Type | Description |
|---|
| public_comment? | string | Public comment to include with the resolution |
| report_id | SnowflakeType | |
ResolveReportResponse
Related endpoints
| Field | Type | Description |
|---|
| public_comment | ?string | |
| report_id | SnowflakeType | |
| resolved_at | ?string | |
| status | ReportStatus | |
ScheduleAccountDeletionRequest
Related endpoints
| Field | Type | Description |
|---|
| days_until_deletion? | integer (int32) | Number of days until the account is deleted |
| public_reason? | string | Public-facing reason for the deletion |
| reason_code | integer (int32) | Code indicating the reason for deletion |
| user_id | SnowflakeType | |
SearchAuditLogsRequest
Related endpoints
| Field | Type | Description |
|---|
| admin_user_id? | SnowflakeType | |
| limit? | integer (int32) | Maximum number of entries to return |
| offset? | integer (int64) | Number of entries to skip |
| query? | string | Search query string |
| sort_by? | SearchAuditLogsRequestSortBy | Field to sort audit logs by |
| sort_order? | SearchAuditLogsRequestSortOrder | Sort order direction |
| target_id? | string | Filter by target entity ID (user, channel, role, invite code, etc.) |
SearchGuildsRequest
Related endpoints
| Field | Type | Description |
|---|
| limit? | integer (int32) | |
| offset? | integer (int64) | |
| query? | string | |
SearchGuildsResponse
Related endpoints
| Field | Type | Description |
|---|
| guilds | GuildAdminResponse[] | |
| total | number | |
SearchReportsRequest
Related endpoints
| Field | Type | Description |
|---|
| category? | string | Filter by report category |
| guild_context_id? | SnowflakeType | |
| limit? | integer (int32) | Maximum number of entries to return |
| offset? | integer (int64) | Number of entries to skip |
| query? | string | Search query string |
| report_type? | ReportType | |
| reported_channel_id? | SnowflakeType | |
| reported_guild_id? | SnowflakeType | |
| reported_user_id? | SnowflakeType | |
| reporter_id? | SnowflakeType | |
| resolved_by_admin_id? | SnowflakeType | |
| sort_by? | SearchReportsRequestSortBy | Field to sort reports by |
| sort_order? | SearchAuditLogsRequestSortOrder | Sort order direction |
| status? | ReportStatus | |
SearchReportsResponse
Related endpoints
| Field | Type | Description |
|---|
| limit | number | |
| offset | number | |
| reports | ReportAdminResponseSchema[] | |
| total | number | |
SearchUsersRequest
Related endpoints
| Field | Type | Description |
|---|
| limit? | integer (int32) | |
| offset? | integer (int64) | |
| query? | string | |
SearchUsersResponse
Related endpoints
| Field | Type | Description |
|---|
| total | number | |
| users | UserAdminResponseSchema[] | |
SendPasswordResetRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
SetUserAclsRequest
Related endpoints
| Field | Type | Description |
|---|
| acls | string[] | List of access control permissions to assign |
| user_id | SnowflakeType | |
SetUserBotStatusRequest
Related endpoints
| Field | Type | Description |
|---|
| bot | boolean | Whether the user should be marked as a bot |
| user_id | SnowflakeType | |
SetUserSystemStatusRequest
Related endpoints
| Field | Type | Description |
|---|
| system | boolean | Whether the user should be marked as a system user |
| user_id | SnowflakeType | |
SetUserTraitsRequest
Related endpoints
| Field | Type | Description |
|---|
| traits | string[] | List of traits to assign to the user |
| user_id | SnowflakeType | |
ShrinkVisionarySlotsRequest
Related endpoints
| Field | Type | Description |
|---|
| target_count | integer (int32) | Target total number of slots (removes from highest indices, minimum 0 slots) |
ShutdownGuildRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
SnowflakeReservationEntry
| Field | Type | Description |
|---|
| email | SnowflakeType | Email address the snowflake is reserved for |
| snowflake | SnowflakeType | Reserved snowflake ID |
| updated_at | ?string | ISO 8601 timestamp when the reservation was last updated |
SuccessResponse
Related endpoints
| Field | Type | Description |
|---|
| success | enum<true> | Whether the operation succeeded |
SuspiciousActivityFlags
Bitmask of suspicious activity flags that triggered the disable
Type: Bitflags32
| Flag | Value | Description |
|---|
| REQUIRE_VERIFIED_EMAIL | 1 | Requires verified email address |
| REQUIRE_REVERIFIED_EMAIL | 2 | Requires re-verified email address |
| REQUIRE_VERIFIED_PHONE | 4 | Requires verified phone number |
| REQUIRE_REVERIFIED_PHONE | 8 | Requires re-verified phone number |
| REQUIRE_VERIFIED_EMAIL_OR_VERIFIED_PHONE | 16 | Requires verified email or verified phone |
| REQUIRE_REVERIFIED_EMAIL_OR_VERIFIED_PHONE | 32 | Requires re-verified email or re-verified phone |
| REQUIRE_VERIFIED_EMAIL_OR_REVERIFIED_PHONE | 64 | Requires verified email or re-verified phone |
| REQUIRE_REVERIFIED_EMAIL_OR_REVERIFIED_PHONE | 128 | Requires re-verified email or re-verified phone |
SwapVisionarySlotsRequest
Related endpoints
| Field | Type | Description |
|---|
| slot_index_a | integer (int32) | First slot index to swap (must be >= 1) |
| slot_index_b | integer (int32) | Second slot index to swap (must be >= 1) |
SystemDmJobResponse
Related endpoints
| Field | Type | Description |
|---|
| approved_at? | ?string | ISO 8601 timestamp when the job was approved |
| content | string | Message content being sent |
| created_at | string | ISO 8601 timestamp when the job was created |
| excluded_guild_ids | SnowflakeType[] | List of excluded guild IDs |
| failed_count | integer (int32) | Number of messages that failed to send |
| job_id | SnowflakeType | Unique identifier for the job |
| last_error? | ?string | Last error message if the job failed |
| registration_end? | ?string | Registration date filter end |
| registration_start? | ?string | Registration date filter start |
| sent_count | integer (int32) | Number of messages successfully sent |
| status | SystemDmJobResponseStatus | Current status of the system DM job |
| target_count | integer (int32) | Total number of users targeted |
TempBanUserRequest
Related endpoints
| Field | Type | Description |
|---|
| duration_hours | integer (int32) | Duration of the ban in hours. Use 0 for a permanent ban (until manually unbanned). |
| reason? | string | Reason for the temporary ban |
| user_id | SnowflakeType | |
TerminateSessionsRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
TerminateSessionsResponse
Related endpoints
| Field | Type | Description |
|---|
| terminated_count | Int32Type | |
TransferGuildOwnershipRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| new_owner_id | SnowflakeType | |
TriggerGuildArchiveRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
TriggerUserArchiveRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
UnlinkPhoneRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
UpdateGuildFeaturesRequest
Related endpoints
| Field | Type | Description |
|---|
| add_features? | GuildFeatureSchema[] | Guild features to add |
| guild_id | SnowflakeType | |
| remove_features? | GuildFeatureSchema[] | Guild features to remove |
UpdateGuildNameRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| name | string | New name for the guild |
UpdateGuildSettingsRequest
Related endpoints
| Field | Type | Description |
|---|
| default_message_notifications? | DefaultMessageNotifications | Default notification setting for new members |
| disabled_operations? | GuildOperations | |
| explicit_content_filter? | GuildExplicitContentFilter | Explicit content filter level |
| guild_id | SnowflakeType | |
| mfa_level? | GuildMFALevel | Required MFA level for moderators |
| nsfw_level? | NSFWLevel | NSFW content level for the guild |
| verification_level? | GuildVerificationLevel | Required verification level for guild members |
UpdateGuildVanityRequest
Related endpoints
| Field | Type | Description |
|---|
| guild_id | SnowflakeType | |
| vanity_url_code | ?string | New vanity URL code, or null to remove |
UpdateSuspiciousActivityFlagsRequest
Related endpoints
UpdateUserFlagsRequest
Related endpoints
| Field | Type | Description |
|---|
| add_flags? | UserFlags[] | User flags to add |
| remove_flags? | UserFlags[] | User flags to remove |
| user_id | SnowflakeType | |
UpdateVoiceRegionRequest
Related endpoints
| Field | Type | Description |
|---|
| allowed_guild_ids? | SnowflakeType[] | Guild IDs explicitly allowed to use this region |
| allowed_user_ids? | SnowflakeType[] | User IDs explicitly allowed to use this region |
| emoji? | string | Emoji representing the region |
| id | SnowflakeType | Unique identifier for the voice region |
| is_default? | boolean | Whether this is the default region |
| latitude? | number | Geographic latitude coordinate |
| longitude? | number | Geographic longitude coordinate |
| name? | string | Display name of the voice region |
| required_guild_features? | string[] | Guild features required to use this region |
| vip_only? | boolean | Whether this region is restricted to VIP users |
UpdateVoiceRegionResponse
Related endpoints
| Field | Type | Description |
|---|
| region | VoiceRegionAdminResponse | Updated voice region |
UpdateVoiceServerRequest
Related endpoints
| Field | Type | Description |
|---|
| allowed_guild_ids? | SnowflakeType[] | Guild IDs explicitly allowed to use this server |
| allowed_user_ids? | SnowflakeType[] | User IDs explicitly allowed to use this server |
| api_key? | string | API key for authenticating with the voice server |
| api_secret? | string | API secret for authenticating with the voice server |
| endpoint? | string (uri) | Client signal WebSocket endpoint URL for the voice server |
| is_active? | boolean | Whether the server is currently active |
| region_id | SnowflakeType | ID of the region this server belongs to |
| required_guild_features? | string[] | Guild features required to use this server |
| server_id | SnowflakeType | Unique identifier for the voice server |
| vip_only? | boolean | Whether this server is restricted to VIP users |
UpdateVoiceServerResponse
Related endpoints
| Field | Type | Description |
|---|
| server | VoiceServerAdminResponse | Updated voice server |
UserMutationResponse
Related endpoints
| Field | Type | Description |
|---|
| user | UserAdminResponseSchema | |
VerifyUserEmailRequest
Related endpoints
| Field | Type | Description |
|---|
| user_id | SnowflakeType | |
VisionarySlotOperationResponse
Related endpoints
| Field | Type | Description |
|---|
| success | enum<true> | |
WebAuthnCredentialListResponse
Related endpoints
Type: WebAuthnCredentialResponse[]
AdminArchiveResponseSchemaSubjectType
Type of subject being archived
| Value | Description |
|---|
user | User data archive |
guild | Guild data archive |
ListArchivesRequestSubjectType
Type of archives to list
| Value | Description |
|---|
user | List user archives |
guild | List guild archives |
all | List all archives |
PurgeGuildAssetResultSchemaAssetType
Type of guild asset
| Value | Description |
|---|
emoji | Custom emoji asset |
sticker | Custom sticker asset |
unknown | Unknown asset type |
SearchAuditLogsRequestSortBy
Field to sort audit logs by
| Value | Description |
|---|
createdAt | Sort by creation timestamp |
relevance | Sort by search relevance score |
SearchAuditLogsRequestSortOrder
Sort order direction
| Value | Description |
|---|
asc | Ascending order (oldest first) |
desc | Descending order (newest first) |
SearchReportsRequestSortBy
Field to sort reports by
| Value | Description |
|---|
createdAt | Sort by creation timestamp |
reportedAt | Sort by report submission timestamp |
resolvedAt | Sort by resolution timestamp |
NcmecSubmissionStatusResponseStatus
NCMEC submission status
| Value | Description |
|---|
not_submitted | Report has not been submitted to NCMEC |
submitted | Report has been submitted to NCMEC |
failed | Report submission to NCMEC failed |
RefreshSearchIndexRequestIndexType
Type of search index to refresh
| Value | Description |
|---|
guilds | Guild search index |
users | User search index |
reports | Report search index |
audit_logs | Audit log search index |
channel_messages | Channel message search index |
guild_members | Guild member search index |
favorite_memes | Favourite meme search index |
discovery | Discovery guild search index |
SystemDmJobResponseStatus
Current status of the system DM job
| Value | Description |
|---|
pending | Job is pending approval |
approved | Job has been approved and is queued |
running | Job is currently running |
completed | Job completed successfully |
failed | Job failed |
ClearGuildFieldsRequestFields
Guild image field that can be cleared
| Value | Description |
|---|
icon | Guild icon image |
banner | Guild banner image |
splash | Guild invite splash image |
embed_splash | Guild embedded invite splash image |
ClearUserFieldsRequestFields
User profile field that can be cleared
| Value | Description |
|---|
avatar | User profile avatar image |
banner | User profile banner image |
bio | User biography text |
pronouns | User pronouns |
global_name | User display name |
GuildMemoryStatsResponseGuildsItem
| Field | Type | Description |
|---|
| guild_icon | ?string | |
| guild_id | ?SnowflakeType | |
| guild_name | string | |
| member_count | Int32Type | |
| memory | Int64StringType | |
| presence_count | Int32Type | |
| session_count | Int32Type | |
GuildUpdateResponseGuild
| Field | Type | Description |
|---|
| banner | ?string | |
| features | string[] | |
| icon | ?string | |
| id | SnowflakeType | |
| member_count | Int32Type | |
| name | string | |
| owner_id | SnowflakeType | |
IndexRefreshStatusResponseOneOf1
| Field | Type | Description |
|---|
| completed_at? | string | ISO 8601 timestamp when the job completed |
| error? | string | Error message if the job failed |
| failed_at? | string | ISO 8601 timestamp when the job failed |
| index_type | string | Type of index being refreshed |
| indexed? | number | Number of items indexed so far |
| started_at? | string | ISO 8601 timestamp when the job started |
| status | MessageShredStatusProgressResponseStatus | Current status of the index refresh job |
| total? | number | Total number of items to index |
InstanceConfigUpdateRequestSso
| Field | Type | Description |
|---|
| allowed_domains? | string[] | |
| authorization_url? | ?string | |
| auto_provision? | boolean | |
| client_id? | ?SnowflakeType | |
| client_secret? | ?string | |
| display_name? | ?string | |
| enabled? | boolean | |
| issuer? | ?string | |
| jwks_url? | ?string | |
| redirect_uri? | ?string (uri) | |
| scope? | ?string | |
| token_url? | ?string | |
| userinfo_url? | ?string | |
LimitConfigGetResponseBoundsAdditionalProperties
| Field | Type | Description |
|---|
| max | number | |
| min | number | |
LimitConfigGetResponseLimitConfig
| Field | Type | Description |
|---|
| rules | LimitConfigGetResponseLimitConfigRulesItem[] | |
| traitDefinitions | string[] | |
| Field | Type | Description |
|---|
| category | string | |
| description | string | |
| isToggle | boolean | |
| key | string | |
| label | string | |
| max? | number | |
| min? | number | |
| scope | string | |
| unit? | LimitConfigGetResponseMetadataAdditionalPropertiesUnit | |
LimitConfigUpdateRequestLimitConfig
New limit configuration snapshot
| Field | Type | Description |
|---|
| rules | LimitConfigUpdateRequestLimitConfigRulesItem[] | Limit rules |
| traitDefinitions? | string[] | Trait definitions used by rules |
LookupGuildResponseGuild
| Field | Type | Description |
|---|
| afk_channel_id | ?SnowflakeType | |
| afk_timeout | Int32Type | |
| banner | ?string | |
| channels | LookupGuildResponseGuildChannelsItem[] | |
| default_message_notifications | DefaultMessageNotifications | |
| disabled_operations | Int32Type | |
| embed_splash | ?string | |
| explicit_content_filter | GuildExplicitContentFilter | |
| features | string[] | |
| icon | ?string | |
| id | SnowflakeType | |
| member_count | Int32Type | |
| mfa_level | GuildMFALevel | |
| name | string | |
| nsfw_level | NSFWLevel | |
| owner_id | SnowflakeType | |
| roles | LookupGuildResponseGuildRolesItem[] | |
| rules_channel_id | ?SnowflakeType | |
| splash | ?string | |
| system_channel_flags | SystemChannelFlags | |
| system_channel_id | ?SnowflakeType | |
| vanity_url_code | ?string | |
| verification_level | GuildVerificationLevel | |
LookupMessageResponseMessagesItem
| Field | Type | Description |
|---|
| attachments | LookupMessageResponseMessagesItemAttachmentsItem[] | |
| author_discriminator | string | |
| author_id | SnowflakeType | |
| author_username | string | |
| channel_id | SnowflakeType | |
| content | string | |
| id | SnowflakeType | |
| timestamp | string | |
NodeStatsResponseMemory
ReportAdminResponseSchemaMessageContextItem
| Field | Type | Description |
|---|
| attachments | LookupMessageResponseMessagesItemAttachmentsItem[] | |
| author_discriminator | string | |
| author_id | SnowflakeType | |
| author_username | string | |
| channel_id | SnowflakeType | |
| content | string | |
| guild_id | ?SnowflakeType | |
| id | SnowflakeType | |
| timestamp | string | |
