Discord icon

Discord

Interact with Discord API - users, messages, webhooks, guilds, interactions, and more

Actions193

Guild → Modify Onboarding

AI-generated

Summary

Updates a Discord guild’s onboarding configuration, including its prompts, default channels, enabled state, and mode.

Inputs

  • Authentication — Choose Bot Token (the default) or OAuth2 (User Token).
  • Guild (required) — The guild’s Discord snowflake ID.
  • Prompts (required) — A raw JSON array of Discord onboarding prompts.
  • Default Channel IDs (required) — Comma-separated channel snowflake IDs that members are opted into automatically.
  • Onboarding Enabled — Whether onboarding is enabled; defaults to true.
  • Onboarding Mode — Onboarding criteria mode: Default (0) or Advanced (1).
  • Audit Log Reason — Optional reason recorded in the guild audit log; Discord limits it to 512 characters.
  • Request Options — Optional batching, SSL certificate validation, proxy, and request timeout settings.

Output shape

A Discord API response for the updated guild onboarding configuration.

The operation-scoped source pack shows no Guild implementation body, so the response shape and runtime handling of these fields cannot be confirmed from the supplied source.

Links

Discussion