Channels

Update channel settings

Changed on

Modifies channel properties such as name, description, topic, nsfw flag, and slowmode. Requires management permissions in the channel.

patch/channels/{channel_id}

Request

  • Base URL: https://web.fluxer.app/api/v1
  • URL: https://web.fluxer.app/api/v1/channels/{channel_id}
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

Path parameters

string snowflake required
OR
integer required

The ID of the channel

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

Success

idstring snowflake required
guild_idstring snowflake
namestring nullable

The name of the channel

topicstring nullable

The topic of the channel

urlstring uri nullable

The URL associated with the channel

iconstring nullable

The icon hash of the channel (for group DMs)

owner_idstring snowflake
type0 | 1 | 2 | 3 | 4 | 5 | 10 | 11 | 12 | 15 | 16 | 998 | 999 required

The type of the channel

positioninteger
parent_idstring snowflake
bitrateinteger
user_limitinteger
voice_connection_limitinteger
rtc_regionstring nullable

The voice region ID for the voice channel

rtc_p2pboolean

Whether calls in the voice channel connect participants directly instead of through a voice server

last_message_idstring snowflake
last_pin_timestampstring date-time nullable

The ISO 8601 timestamp of when the last pinned message was pinned

nsfwboolean

Whether the channel is marked as NSFW (effective value, walking channel → category → guild)

nsfw_overrideboolean nullable

Per-channel adult-content override; null means inherit from parent category and then guild. Categories use this same field as their own override.

content_warning_level0 | 1

The content warning level for a guild, category, or channel

content_warning_textstring nullable

Custom channel content warning text (max 200 characters); null inherits from parent or guild

rate_limit_per_userinteger
nicksobject

Custom nicknames for users in this channel (for group DMs)

flagsinteger
applied_tagsSnowflakeStringType[]

IDs of the tags applied to a forum or media post

message_countinteger
total_message_sentinteger
member_countinteger
member_ids_previewSnowflakeStringType[]

IDs of the most recently joined members of a forum or media post, newest first

default_auto_archive_durationinteger
default_thread_rate_limit_per_userinteger
default_sort_orderinteger
default_forum_layoutinteger
default_tag_setting'match_some' | 'match_all'

Default tag search setting

Changes

  • b620d9da76aaRevision changes
    • breaking

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the request body anyOf list

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the request body anyOf list

    • info

      added the optional property to the response with the status

  • b1021ec8360dRevision changes
    • info

      added the new optional request property /