Field notation
Resource tables use a compact notation:| Notation | Meaning |
|---|---|
field | Required field |
field? | Optional field (may be omitted) |
?type | Nullable (value can be null) |
field? with ?type | Optional and nullable |
Resources by domain
- Admin (173 schemas)
- Auth (37 schemas)
- Billing (3 schemas)
- Channels (66 schemas)
- Common (35 schemas)
- Gateway (2 schemas)
- Gifts (1 schemas)
- Guilds (63 schemas)
- Instance (1 schemas)
- Invites (4 schemas)
- Klipy (5 schemas)
- Oauth2 (25 schemas)
- Packs (7 schemas)
- Premium (2 schemas)
- Read states (1 schemas)
- Reports (14 schemas)
- Saved media (5 schemas)
- Search (2 schemas)
- Themes (2 schemas)
- Users (80 schemas)
- Webhooks (9 schemas)
All schemas
- AddSnowflakeReservationRequest
- AdminArchiveResponseSchema
- AdminAuditLogResponseSchema
- AdminUserDmChannelSchema
- AdminUsersMeResponse
- APIErrorCode
- ApplicationBotResponse
- ApplicationCreateRequest
- ApplicationFlags
- ApplicationListResponse
- ApplicationPublicResponse
- ApplicationResponse
- ApplicationsMeResponse
- ApplicationUpdateRequest
- AuditLogActionType
- AuditLogChangeSchema
- AuditLogsListResponseSchema
- AuditLogWebhookResponse
- AuthenticatorType
- AuthLoginResponse
- AuthMfaRequiredResponse
- AuthorizeConsentRequest
- AuthorizeIpRequest
- AuthRegisterResponse
- AuthSessionClientInfo
- AuthSessionLocation
- AuthSessionResponse
- AuthSessionsResponse
- AuthTokenWithUserIdResponse
- BanCheckResponseSchema
- BanEmailRequest
- BanGuildMemberRequest
- BanIpRequest
- BanPhoneRequest
- Base64ImageType
- BlueskyAuthorizeRequest
- BlueskyAuthorizeResponse
- BotFlags
- BotProfileResponse
- BotProfileUpdateRequest
- BotTokenResetResponse
- BulkAddGuildMembersRequest
- BulkDeleteMessagesRequest
- BulkOperationFailedResponse
- BulkOperationResponse
- BulkScheduleUserDeletionRequest
- BulkUpdateGuildFeaturesRequest
- BulkUpdateUserFlagsRequest
- CallEligibilityResponse
- CallRingBodySchema
- CallUpdateBodySchema
- CancelBulkMessageDeletionRequest
- ChangeDobRequest
- ChangeEmailRequest
- ChangeUsernameRequest
- ChannelCreateCategoryRequest
- ChannelCreateLinkRequest
- ChannelCreateRequest
- ChannelCreateTextRequest
- ChannelCreateVoiceRequest
- ChannelInviteCreateRequest
- ChannelNicknameOverrides
- ChannelOverwriteRequest
- ChannelOverwriteResponse
- ChannelPartialRecipientResponse
- ChannelPartialResponse
- ChannelPinMessageResponse
- ChannelPinResponse
- ChannelPinsResponse
- ChannelPositionUpdateRequest
- ChannelResponse
- ChannelUpdateCategoryRequest
- ChannelUpdateGroupDmRequest
- ChannelUpdateLinkRequest
- ChannelUpdateRequest
- ChannelUpdateTextRequest
- ChannelUpdateVoiceRequest
- ClearGuildFieldsRequest
- ClearUserFieldsRequest
- CodesResponse
- ConnectionListResponse
- ConnectionResponse
- ConnectionVerificationResponse
- CreateAdminApiKeyRequest
- CreateAdminApiKeyResponse
- CreateCheckoutSessionRequest
- CreateConnectionRequest
- CreateFavoriteMemeBodySchema
- CreateFavoriteMemeFromUrlBodySchema
- CreatePrivateChannelRequest
- CreateSystemDmJobRequest
- CreateVoiceRegionRequest
- CreateVoiceRegionResponse
- CreateVoiceServerRequest
- CreateVoiceServerResponse
- CustomStatusPayload
- CustomStatusResponse
- DefaultMessageNotifications
- DeleteAllUserMessagesRequest
- DeleteAllUserMessagesResponse
- DeleteApiKeyResponse
- DeleteGuildRequest
- DeleteMessageRequest
- DeleteMessageResponse
- DeleteSnowflakeReservationRequest
- DeleteVoiceRegionRequest
- DeleteVoiceResponse
- DeleteVoiceServerRequest
- DeleteWebAuthnCredentialRequest
- DisableForSuspiciousActivityRequest
- DisableMfaRequest
- DisableTotpRequest
- DiscoveryAdminRejectRequest
- DiscoveryAdminRemoveRequest
- DiscoveryAdminReviewRequest
- DiscoveryApplicationPatchRequest
- DiscoveryApplicationRequest
- DiscoveryApplicationResponse
- DiscoveryCategoryListResponse
- DiscoveryCategoryResponse
- DiscoveryGuildListResponse
- DiscoveryGuildResponse
- DiscoveryStatusResponse
- DonationCheckoutRequest
- DonationCheckoutResponse
- DonationRequestLinkRequest
- DownloadUrlResponseSchema
- DsaReportEmailSendRequest
- DsaReportEmailVerifyRequest
- DsaReportGuildRequest
- DsaReportMessageRequest
- DsaReportRequest
- DsaReportUserRequest
- EmailChangeBouncedRequestNewRequest
- EmailChangeBouncedVerifyNewRequest
- EmailChangeRequestNewRequest
- EmailChangeRequestNewResponse
- EmailChangeStartResponse
- EmailChangeTicketRequest
- EmailChangeVerifyNewRequest
- EmailChangeVerifyOriginalRequest
- EmailChangeVerifyOriginalResponse
- EmailRevertRequest
- EmailTokenResponse
- EmailType
- EmbedAuthorResponse
- EmbedFieldResponse
- EmbedFooterResponse
- EmbedMediaFlags
- EmbedMediaResponse
- EmptyBodyRequest
- EnabledToggleRequest
- EnableMfaTotpRequest
- Error
- ExpandVisionarySlotsRequest
- FavoriteMemeListResponse
- FavoriteMemeResponse
- ForceAddUserToGuildRequest
- ForgotPasswordRequest
- FriendRequestByTagRequest
- FriendSourceFlags
- GatewayBotResponse
- GenerateGiftCodesRequest
- GetArchiveResponseSchema
- GetIndexRefreshStatusRequest
- GetProcessMemoryStatsRequest
- GetVoiceRegionRequest
- GetVoiceRegionResponse
- GetVoiceServerRequest
- GetVoiceServerResponse
- GiftCodeMetadataResponse
- GiftCodeResponse
- GitHubWebhook
- GlobalSearchMessagesRequest
- GroupDmAddPermissionFlags
- GroupDmInviteMetadataResponse
- GroupDmInviteResponse
- GuildAdminResponse
- GuildAssetItemSchema
- GuildAuditLogEntryResponse
- GuildAuditLogListResponse
- GuildBanCreateRequest
- GuildBanResponse
- GuildCreateRequest
- GuildDeleteRequest
- GuildEmojiBulkCreateRequest
- GuildEmojiBulkCreateResponse
- GuildEmojiCreateRequest
- GuildEmojiResponse
- GuildEmojiUpdateRequest
- GuildEmojiWithUserListResponse
- GuildEmojiWithUserResponse
- GuildExplicitContentFilter
- GuildFeatureSchema
- GuildFolderFlags
- GuildInviteMetadataResponse
- GuildInviteResponse
- GuildMemberProfileFlags
- GuildMemberResponse
- GuildMemberSearchRequest
- GuildMemberSearchResponse
- GuildMemberSearchResult
- GuildMemberUpdateRequest
- GuildMemoryStatsResponse
- GuildMFALevel
- GuildOperations
- GuildReportCategoryEnum
- GuildResponse
- GuildRoleCreateRequest
- GuildRoleHoistPositionItem
- GuildRoleHoistPositionsRequest
- GuildRolePositionItem
- GuildRolePositionsRequest
- GuildRoleResponse
- GuildRoleUpdateRequest
- GuildStickerBulkCreateRequest
- GuildStickerBulkCreateResponse
- GuildStickerCreateRequest
- GuildStickerResponse
- GuildStickerUpdateRequest
- GuildStickerWithUserListResponse
- GuildStickerWithUserResponse
- GuildTransferOwnershipRequest
- GuildUpdateRequest
- GuildUpdateResponse
- GuildVanityURLResponse
- GuildVanityURLUpdateRequest
- GuildVanityURLUpdateResponse
- GuildVerificationLevel
- HandoffCompleteRequest
- HandoffInitiateResponse
- HandoffStatusResponse
- HarvestCreationResponseSchema
- HarvestDownloadUrlResponse
- HarvestStatusEnum
- HarvestStatusResponseSchema
- HarvestStatusResponseSchemaNullable
- IncomingCallFlags
- IndexRefreshStatusResponse
- InstanceConfigResponse
- InstanceConfigUpdateRequest
- Int32Type
- Int64StringType
- Int64Type
- IntrospectRequestForm
- InviteMetadataResponseSchema
- InviteResponseSchema
- IpAuthorizationPollResponse
- IpBanListEntrySchema
- JoinSourceType
- KickGuildMemberRequest
- KlipyCategoryTagResponse
- KlipyFeaturedResponse
- KlipyGifResponse
- KlipyRegisterShareRequest
- LegalHoldRequest
- LegalHoldResponse
- LimitConfigGetResponse
- LimitConfigUpdateRequest
- LimitFilterResponse
- LimitRuleResponse
- ListAdminApiKeyResponse
- ListArchivesRequest
- ListArchivesResponseSchema
- ListAuditLogsRequest
- ListBansRequest
- ListEmailBansResponseSchema
- ListGuildEmojisResponse
- ListGuildMembersRequest
- ListGuildMembersResponse
- ListGuildStickersResponse
- ListIpBansResponseSchema
- ListPhoneBansResponseSchema
- ListReportsRequest
- ListReportsResponse
- ListSnowflakeReservationsResponse
- ListSystemDmJobsResponse
- ListUserChangeLogRequest
- ListUserChangeLogResponseSchema
- ListUserDmChannelsRequest
- ListUserDmChannelsResponse
- ListUserGuildsRequest
- ListUserGuildsResponse
- ListUserSessionsRequest
- ListUserSessionsResponse
- ListVisionarySlotsResponse
- ListVoiceRegionsRequest
- ListVoiceRegionsResponse
- ListVoiceServersRequest
- ListVoiceServersResponse
- ListWebAuthnCredentialsRequest
- Locale
- LoginRequest
- LogoutAuthSessionsRequest
- LookupGuildRequest
- LookupGuildResponse
- LookupMessageByAttachmentRequest
- LookupMessageRequest
- LookupMessageResponse
- LookupUserByIdsRequest
- LookupUserByQueryRequest
- LookupUserRequest
- LookupUserResponse
- MessageAckRequest
- MessageAttachmentFlags
- MessageAttachmentResponse
- MessageAuthorType
- MessageBaseResponseSchema
- MessageCallResponse
- MessageContentType
- MessageEmbedChildResponse
- MessageEmbedResponse
- MessageEmbedType
- MessageFlags
- MessageListResponse
- MessageReactionResponse
- MessageReferenceResponse
- MessageReferenceType
- MessageReportCategoryEnum
- MessageResponseSchema
- MessageSearchIndexingResponse
- MessageSearchResponse
- MessageSearchResultsResponse
- MessageSearchScope
- MessageShredRequest
- MessageShredResponse
- MessageShredStatusNotFoundResponse
- MessageShredStatusProgressResponse
- MessageShredStatusRequest
- MessageShredStatusResponse
- MessageSnapshotResponse
- MessageSortField
- MessageSortOrder
- MessageStickerResponse
- MfaBackupCodeResponse
- MfaBackupCodesRequest
- MfaBackupCodesResponse
- MfaSmsRequest
- MfaTicketRequest
- MfaTotpRequest
- MutualGuildResponse
- MyGuildMemberUpdateRequest
- NcmecSubmissionStatusResponse
- NcmecSubmitResultResponse
- NodeStatsResponse
- NSFWLevel
- OAuth2AuthorizationResponse
- OAuth2AuthorizationsListResponse
- OAuth2ConsentResponse
- OAuth2IntrospectResponse
- OAuth2MeResponse
- OAuth2RedirectURICreateType
- OAuth2RedirectURIUpdateType
- OAuth2TokenResponse
- OAuth2UserInfoResponse
- OkResponse
- PackCreateRequest
- PackDashboardResponse
- PackInviteCreateRequest
- PackInviteMetadataResponse
- PackInviteResponse
- PackSummaryResponse
- PackUpdateRequest
- PasswordChangeCompleteRequest
- PasswordChangeStartResponse
- PasswordChangeTicketRequest
- PasswordChangeVerifyRequest
- PasswordChangeVerifyResponse
- PasswordType
- PermissionOverwriteCreateRequest
- PhoneAddRequest
- PhoneNumberType
- PhoneSendVerificationRequest
- PhoneVerifyRequest
- PhoneVerifyResponse
- PreloadMessagesRequest
- PreloadMessagesResponse
- PriceIdsResponse
- PublicUserFlags
- PurgeGuildAssetErrorSchema
- PurgeGuildAssetResultSchema
- PurgeGuildAssetsRequest
- PurgeGuildAssetsResponseSchema
- PushSubscribeRequest
- PushSubscribeResponse
- PushSubscriptionItemResponse
- PushSubscriptionsListResponse
- ReactionUsersListResponse
- ReadStateAckBulkRequest
- RefreshSearchIndexRequest
- RefreshSearchIndexResponse
- RegisterRequest
- RelationshipNicknameUpdateRequest
- RelationshipResponse
- RelationshipTypePutRequest
- RelationshipTypes
- ReloadAllGuildsResponse
- ReloadGuildRequest
- ReloadGuildsRequest
- RenderSpoilers
- ReorderConnectionsRequest
- ReportAdminResponseSchema
- ReportGuildRequest
- ReportMessageRequest
- ReportResponse
- ReportStatus
- ReportType
- ReportUserRequest
- ResendVerificationEmailRequest
- ReserveVisionarySlotRequest
- ResetPasswordRequest
- ResolveReportRequest
- ResolveReportResponse
- RevokeRequestForm
- RtcRegionResponse
- SavedMessageEntryListResponse
- SavedMessageEntryResponse
- SaveMessageRequest
- ScheduleAccountDeletionRequest
- ScheduledMessageAllowedMentionsSchema
- ScheduledMessageReferenceSchema
- ScheduledMessageResponseSchema
- SearchAuditLogsRequest
- SearchGuildsRequest
- SearchGuildsResponse
- SearchReportsRequest
- SearchReportsResponse
- SearchUsersRequest
- SearchUsersResponse
- SendPasswordResetRequest
- SentryWebhook
- SetUserAclsRequest
- SetUserBotStatusRequest
- SetUserSystemStatusRequest
- SetUserTraitsRequest
- ShrinkVisionarySlotsRequest
- ShutdownGuildRequest
- SlackWebhookRequest
- SnowflakeReservationEntry
- SnowflakeType
- SsoCompleteRequest
- SsoCompleteResponse
- SsoConfigResponse
- SsoStartRequest
- SsoStartResponse
- SsoStatusResponse
- StickerAnimationOptions
- StreamPreviewUploadBodySchema
- StreamUpdateBodySchema
- SuccessResponse
- SudoMfaMethodsResponse
- SudoVerificationSchema
- SuspiciousActivityFlags
- SwapVisionarySlotsRequest
- SystemChannelFlags
- SystemDmJobResponse
- TempBanUserRequest
- TenorCategoryTagResponse
- TenorFeaturedResponse
- TenorGifResponse
- TenorRegisterShareRequest
- TerminateSessionsRequest
- TerminateSessionsResponse
- ThemeCreateRequest
- ThemeCreateResponse
- TicketResponse
- TimeFormatTypes
- TokenRequest
- TransferGuildOwnershipRequest
- TriggerGuildArchiveRequest
- TriggerUserArchiveRequest
- UnlinkPhoneRequest
- UnsignedInt64Type
- UpdateConnectionRequest
- UpdateFavoriteMemeBodySchema
- UpdateGuildFeaturesRequest
- UpdateGuildNameRequest
- UpdateGuildSettingsRequest
- UpdateGuildVanityRequest
- UpdateSuspiciousActivityFlagsRequest
- UpdateUserFlagsRequest
- UpdateVoiceRegionRequest
- UpdateVoiceRegionResponse
- UpdateVoiceServerRequest
- UpdateVoiceServerResponse
- UrlResponse
- UserAdminResponseSchema
- UserAuthenticatorTypes
- UserContactChangeLogEntrySchema
- UserFlags
- UserGuildSettingsResponse
- UserGuildSettingsUpdateRequest
- UserMutationResponse
- UsernameSuggestionsRequest
- UsernameSuggestionsResponse
- UsernameType
- UserNoteResponse
- UserNotesRecordResponse
- UserNoteUpdateRequest
- UserNotificationSettings
- UserPartialResponse
- UserPremiumTypes
- UserPrivateResponse
- UserProfileFullResponse
- UserReportCategoryEnum
- UserSessionResponse
- UserSettingsResponse
- UserSettingsUpdateRequest
- UserStatusType
- UserTagCheckResponse
- UserThemeType
- UserUpdateWithVerificationRequest
- ValidationErrorCodeSchema
- ValidationErrorItem
- VerifyAndCreateConnectionRequest
- VerifyEmailRequest
- VerifyUserEmailRequest
- VisionarySlotOperationResponse
- VisionarySlotSchema
- VoiceRegionAdminResponse
- VoiceRegionWithServersResponse
- VoiceServerAdminResponse
- WebAuthnAuthenticateRequest
- WebAuthnAuthenticationOptionsResponse
- WebAuthnChallengeResponse
- WebAuthnCredentialListResponse
- WebAuthnCredentialResponse
- WebAuthnCredentialUpdateRequest
- WebAuthnMfaRequest
- WebAuthnRegisterRequest
- WebhookCreateRequest
- WebhookReceivedResponse
- WebhookResponse
- WebhookTokenResponse
- WebhookTokenUpdateRequest
- WebhookType
- WebhookUpdateRequest
- WellKnownFluxerResponse
- AdminArchiveResponseSchemaSubjectType
- ListArchivesRequestSubjectType
- PurgeGuildAssetResultSchemaAssetType
- SearchAuditLogsRequestSortBy
- SearchAuditLogsRequestSortOrder
- MessageShredStatusProgressResponseStatus
- SearchReportsRequestSortBy
- NcmecSubmissionStatusResponseStatus
- RefreshSearchIndexRequestIndexType
- SystemDmJobResponseStatus
- ChannelUpdateTextRequestType
- ChannelOverwriteRequestType
- ChannelUpdateVoiceRequestType
- ChannelUpdateCategoryRequestType
- ChannelUpdateLinkRequestType
- ChannelUpdateGroupDmRequestType
- MessageResponseSchemaType
- DonationCheckoutRequestCurrency
- DonationCheckoutRequestInterval
- GuildUpdateRequestSplashCardAlignment
- GuildUpdateRequestMfaMethod
- GuildMemberSearchRequestSortBy
- RevokeRequestFormTokenTypeHint
- PriceIdsResponseCurrency