Skip to main content

ChannelUpdate Object

Update a channel.

Requires the MANAGE_CHANNELSpermission.
Requires one of the following permissions when updating only `orderSettings` field: `MANAGE_CHANNELS``MANAGE_ORDERS`
Requires one of the following permissions when updating only `checkoutSettings` field: `MANAGE_CHANNELS``MANAGE_CHECKOUTS`
Requires one of the following permissions when updating only `paymentSettings` field: `MANAGE_CHANNELS``HANDLE_PAYMENTS`

Triggers the following webhook events:

  • CHANNEL_UPDATED (async): A channel was updated.
  • CHANNEL_METADATA_UPDATED (async): Optionally triggered when public or private metadata is updated.
type ChannelUpdate {
  channelErrors: [ChannelError!]! @deprecated
  errors: [ChannelError!]!
  channel: Channel
}

Fields​

errors ● [ChannelError!]!​

channel ● Channel​

Show deprecated

Returned By​

channelUpdate mutation