Connections

Update a Discord channel

Rename a channel or change whether it's a default target.

patch/discord/channels/{channel_id}

Request

  • Base URL: https://api.shortsync.app/v1
  • URL: https://api.shortsync.app/v1/discord/channels/{channel_id}
  • Auth: HTTP bearer

Request body

labelstring
is_defaultboolean

Pre-select this channel for posts that don't set channel_ids.

Response

The updated channel.

idstring uuid required

Pass in platform_options.discord.channel_ids.

labelstring required

Display name shown in ShortSync.

guild_idstring nullable

Discord server id.

guild_namestring nullable
channel_idstring required

Discord's channel id.

is_defaultboolean required

Posts without channel_ids go to every default channel.

is_forumboolean required

Forum channel; each post needs a thread_name (falls back to the caption's first line). Learned on the first publish.

status'active' | 'needs_reconnect' required

needs_reconnect means Discord no longer accepts the webhook.

source'paste' | 'oauth' required

Connected by pasting a webhook URL or through Discord sign-in.

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.