Organization API: Discord

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Put discord config

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`configured`	boolean
`application_id`	string or null
`public_key`	string or null
`guild_id`	string or null
`staff_channel_id`	string or null
`staff_channel_kind`	string
`is_enabled`	boolean
`has_bot_token`	boolean
`commands_registered_at`	string (date-time) or null
`interactions_url`	string or null
`last_error`	string or null
`gateway_status`	string
`bot_user_id`	string or null
`ticket_channels_enabled`	boolean
`ticket_category_prefix`	string
`staff_role_id`	string or null
`max_ticket_channels`	integer
`community_chat_enabled`	boolean
`community_invite_url`	string or null
`community_hidden_channels`	array of string

Put discord config

PUT /api/v1/orgs/{org_slug}/discord

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`application_id`	string	yes
`public_key`	string	yes
`bot_token`	string or null	no
`guild_id`	string or null	no
`staff_channel_id`	string or null	no
`staff_channel_kind`	string or null	no
`is_enabled`	boolean or null	no
`ticket_channels_enabled`	boolean or null	no
`ticket_category_prefix`	string or null	no
`staff_role_id`	string or null	no
`max_ticket_channels`	integer or null	no
`community_chat_enabled`	boolean or null	no
`community_invite_url`	string or null	no
`community_hidden_channels`	array of string or null	no

Responses

Section titled Switch the bot off and forget the token

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`configured`	boolean
`application_id`	string or null
`public_key`	string or null
`guild_id`	string or null
`staff_channel_id`	string or null
`staff_channel_kind`	string
`is_enabled`	boolean
`has_bot_token`	boolean
`commands_registered_at`	string (date-time) or null
`interactions_url`	string or null
`last_error`	string or null
`gateway_status`	string
`bot_user_id`	string or null
`ticket_channels_enabled`	boolean
`ticket_category_prefix`	string
`staff_role_id`	string or null
`max_ticket_channels`	integer
`community_chat_enabled`	boolean
`community_invite_url`	string or null
`community_hidden_channels`	array of string

Switch the bot off and forget the token

DELETE /api/v1/orgs/{org_slug}/discord

Switch the bot off and forget the token.

The row stays so the channel and application ids do not have to be re-entered, but the credential does not linger on a disabled integration.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Rebuild the public-channel allowlist from Discord's own permissions

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Rebuild the public-channel allowlist from Discord's own permissions

POST /api/v1/orgs/{org_slug}/discord/community/sync-channels

Rebuild the public-channel allowlist from Discord's own permissions.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Probe the bot, the guild, the staff channel and the job queue

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Probe the bot, the guild, the staff channel and the job queue

GET /api/v1/orgs/{org_slug}/discord/diagnostics

Probe the bot, the guild, the staff channel and the job queue.

Answers "why did my ticket not appear in Discord?" without needing shell access.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Register commands

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Register commands

POST /api/v1/orgs/{org_slug}/discord/register-commands

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled List role menus

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List role menus

GET /api/v1/orgs/{org_slug}/discord/role-menus

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled A new role menu

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].channel_id`	string or null
`[].menu_key`	string or null
`[].message_id`	string or null
`[].title`	string
`[].description`	string or null
`[].options`	array of RoleOption
`[].options[].role_id`	string
`[].options[].label`	string
`[].options[].key`	string or null
`[].options[].emoji`	string or null
`[].options[].description`	string or null
`[].is_enabled`	boolean
`[].published`	boolean

A new role menu

POST /api/v1/orgs/{org_slug}/discord/role-menus

A new role menu. menu_key is optional and one per organization: a key another of its menus has answers 409.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`channel_id`	string or null	no
`menu_key`	string or null	no
`title`	string	yes
`description`	string or null	no
`options`	array of RoleOption	no
`options[].role_id`	string	yes
`options[].label`	string	yes
`options[].key`	string or null	no
`options[].emoji`	string or null	no
`options[].description`	string or null	no
`is_enabled`	boolean	no

Responses

Section titled Replace a role menu

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`channel_id`	string or null
`menu_key`	string or null
`message_id`	string or null
`title`	string
`description`	string or null
`options`	array of RoleOption
`options[].role_id`	string
`options[].label`	string
`options[].key`	string or null
`options[].emoji`	string or null
`options[].description`	string or null
`is_enabled`	boolean
`published`	boolean

PUT /api/v1/orgs/{org_slug}/discord/role-menus/{menu_id}

Replace a role menu. A menu_key another of the org's menus has answers 409.

Parameters

Name	In	Type	Required
`menu_id`	path	integer	yes
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`channel_id`	string or null	no
`menu_key`	string or null	no
`title`	string	yes
`description`	string or null	no
`options`	array of RoleOption	no
`options[].role_id`	string	yes
`options[].label`	string	yes
`options[].key`	string or null	no
`options[].emoji`	string or null	no
`options[].description`	string or null	no
`is_enabled`	boolean	no

Responses

Section titled Delete role menu

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`id`	integer
`channel_id`	string or null
`menu_key`	string or null
`message_id`	string or null
`title`	string
`description`	string or null
`options`	array of RoleOption
`options[].role_id`	string
`options[].label`	string
`options[].key`	string or null
`options[].emoji`	string or null
`options[].description`	string or null
`is_enabled`	boolean
`published`	boolean

DELETE /api/v1/orgs/{org_slug}/discord/role-menus/{menu_id}

Parameters

Name	In	Type	Required
`menu_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled Post the menu to its channel, or edit the message already posted for it

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

POST /api/v1/orgs/{org_slug}/discord/role-menus/{menu_id}/publish

Post the menu to its channel, or edit the message already posted for it.

Parameters

Name	In	Type	Required
`menu_id`	path	integer	yes
`org_slug`	path	string	yes

Responses

Section titled The roles in the org's guild, so a menu can be built by picking not typing

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The roles in the org's guild, so a menu can be built by picking not typing

GET /api/v1/orgs/{org_slug}/discord/roles

The roles in the org's guild, so a menu can be built by picking not typing.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled List staff links

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

List staff links

GET /api/v1/orgs/{org_slug}/discord/staff

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Link a Discord account to the owner or a member of this organization

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].discord_user_id`	string
`[].user_id`	integer or null
`[].admin_user_id`	integer or null
`[].role`	string
`[].email`	string or null

Link a Discord account to the owner or a member of this organization

PUT /api/v1/orgs/{org_slug}/discord/staff

Link a Discord account to the owner or a member of this organization.

user_id names the person, and anyone outside the organization answers 404. A body without user_id, or with admin_user_id, answers 422: a link to one of the platform's own admins is not the organization's to make.

Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`discord_user_id`	string	yes
`user_id`	integer or null	no
`admin_user_id`	integer or null	no
`role`	string	no

Responses

Section titled Delete staff link

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 200 response:

Field	Type
`discord_user_id`	string
`user_id`	integer or null
`admin_user_id`	integer or null
`role`	string
`email`	string or null

Delete staff link

DELETE /api/v1/orgs/{org_slug}/discord/staff/{discord_user_id}

Parameters

Name	In	Type	Required
`discord_user_id`	path	string	yes
`org_slug`	path	string	yes

Responses