Skip to main content

channelDelete Mutation

Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.

Requires the MANAGE_CHANNELSpermission.

Triggers the following webhook events:

  • CHANNEL_DELETED (async): A channel was deleted.
channelDelete(
  id: ID!
  input: ChannelDeleteInput
): ChannelDelete
Show return type

Arguments​

id ● ID!​

ID of a channel to delete.

input ● ChannelDeleteInput​

Fields required to delete a channel.

Type​

ChannelDelete​

Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.

Requires the MANAGE_CHANNELSpermission.

Triggers the following webhook events:

  • CHANNEL_DELETED (async): A channel was deleted.