Skip to main content

CreateChannelInput

Create a channel in an app.

input CreateChannelInput {
  appId: BigInt!
  name: String!
  description: String
  membershipPolicy: String
  membersCanSend: Boolean
  membersCanSpeak: Boolean
}

Fields​

CreateChannelInput.appId ● BigInt! non-null scalar​

The app (tenant) the channel belongs to.

CreateChannelInput.name ● String! non-null scalar​

Display name for the channel (max 128 chars; unique per app+type).

CreateChannelInput.description ● String scalar​

Optional free-text description of the channel.

CreateChannelInput.membershipPolicy ● String scalar​

open | request | invite | admin. Defaults to the app policy.

CreateChannelInput.membersCanSend ● Boolean scalar​

When true (default), new members are auto-granted send_messages so they can post (open chat channel). When false, only roles you grant may post (announce/read-only channel).

CreateChannelInput.membersCanSpeak ● Boolean scalar​

When true, new members are also auto-granted send_voice so they can send channel audio (party or guild voice, delivered to every member wherever they are). False (default): only roles you grant send_voice may speak. Voice also needs the player's use_voice_chat tier permission, and every member's downlink is billed as egress, so keep voice channels small.

Member Of​

createChannel mutation