Skip to main content

channelDeactivate Mutation

Deactivate a channel.

Requires the MANAGE_CHANNELSpermission.

Triggers the following webhook events:

  • CHANNEL_STATUS_CHANGED (async): A channel was deactivated.
channelDeactivate(
  id: ID!
): ChannelDeactivate
Details
type ChannelDeactivate {
  channel: Channel
  channelErrors: [ChannelError!]! @deprecated
  errors: [ChannelError!]!
}

Arguments​

id ● ID!​

ID of the channel to deactivate.

Type​

ChannelDeactivate​

Deactivate a channel.

Requires the MANAGE_CHANNELSpermission.

Triggers the following webhook events:

  • CHANNEL_STATUS_CHANGED (async): A channel was deactivated.