Passa al contenuto principale

Bot user

Direct messages, bot status, presence and external users.

Set bot presence​

Updates the bot's online status and activity.

Inputs

NameTypeRequiredDetails
StatusPresence statusYesOnline status to display. Default: Online.
Activity typeActivity typeNoType of activity to show.
Activity textTextNoText shown after the activity verb. Maximum length: 128 characters. Shown when Activity type is Playing, Streaming, Listening, Watching, Custom status, Competing.
Stream URLURLNoTwitch / YouTube URL (streaming activity only). Shown when Activity type is.

Set bot username​

Change the bot's global username.

Inputs

NameTypeRequiredDetails
New usernameTextYesThe new global username (2-32 chars). Length: 2 to 32 characters.

Outputs

NameTypeDetails
Bot userUserThe updated bot user.

Set bot avatar​

Change or remove the bot's global avatar.

Inputs

NameTypeRequiredDetails
Avatar URLURLYesURL of the new avatar image, or empty to remove.

Outputs

NameTypeDetails
Bot userUserThe updated bot user.

Set bot banner​

Change or remove the bot's profile banner.

Inputs

NameTypeRequiredDetails
Banner URLURLYesURL of the new banner image, or empty to remove.

Outputs

NameTypeDetails
Bot userUserThe updated bot user.

Fetch bot user (fresh from Discord)​

Requests the bot's own user account from Discord, so the data is always current. Costs one API request, counts toward the rate limit and can fail - use the cached version if you do not need fresh data.

Outputs

NameTypeDetails
Bot userUserThe bot's user account, freshly fetched from Discord.

Fetch application​

Fetches the bot's own Discord application, including all public metadata.

Outputs

NameTypeDetails
ApplicationApplicationThe bot's Discord application.

Edit application​

Edits settings of the bot's Discord application.

Inputs

NameTypeRequiredDetails
Custom Install URLURLNoCustom URL Discord redirects users to for installing the app.
DescriptionTextNoNew description for the application.
Role Connections Verification URLURLNoURL Discord opens to verify role connections.
Install ParametersApplication install parametersNoDefault in-app authorization parameters.
FlagsList of Application flagNoApplication flags to set (only some flags are settable).
IconURLNoURL of the new icon image.
Cover ImageURLNoURL of the new cover image.
Interactions Endpoint URLURLNoURL Discord sends interactions to instead of the gateway.
TagsList of TextNoUp to 5 tags describing the application (each at most 20 chars). Maximum length: 20 characters. Maximum items: 5.

Outputs

NameTypeDetails
ApplicationApplicationThe updated application.

Fetch application role connection metadata​

Fetches the role-connection metadata entries currently registered for the application.

Outputs

NameTypeDetails
EntriesList of Role connection metadataThe role connection metadata entries currently registered.

Update application role connection metadata​

Replaces the role-connection metadata entries registered for the application (max 5).

Inputs

NameTypeRequiredDetails
EntriesList of Role connection metadataYesUp to five metadata entries to register for the application. Maximum items: 5.

Outputs

NameTypeDetails
EntriesList of Role connection metadataThe metadata entries as stored after the update.

Update user role connection​

Updates the application's role connection for a specific user (platform name, username, and metadata values).

Inputs

NameTypeRequiredDetails
UserUserYesThe user whose role connection to update.
Platform NameTextNoName of the connected platform shown in Discord (max 50 chars). Maximum length: 50 characters.
Platform UsernameTextNoUser's name on the connected platform (max 100 chars). Maximum length: 100 characters.
MetadataLookup table of Text to TextNoLookup table of metadata keys to text values reported to Discord.

Outputs

NameTypeDetails
SuccessYes/NoWhether the update was applied successfully.

Fetch bot user (from cache, no API call)​

Returns the bot's own user account from the local cache. Instant and free, with no API request, but the username, avatar or banner can be briefly out of date right after a change.

Outputs

NameTypeDetails
Bot userUserThe bot's user account, read from the cache.

Fetch bot as server member​

Returns the bot resolved as a member of the given server.

Outputs

NameTypeDetails
Bot memberServer memberThe bot's server membership.
Need more help?
Can't find what you're looking for? Our team is happy to help.