channelUpdate Mutation

Update a channel.

Requires one of the following permissions:MANAGE_CHANNELS

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.

Applied directives

@webhookEventsInfo(asyncEvents: [CHANNEL_UPDATED, CHANNEL_METADATA_UPDATED], syncEvents: [])

channelUpdate(id: ID!, input: ChannelUpdateInput!): ChannelUpdate

Returns

ChannelUpdate

Show return type

type ChannelUpdate {
  channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.")
  errors: [ChannelError!]!
  channel: Channel
}

Arguments

id

id · ID!

ID of a channel to update.

input

input · ChannelUpdateInput!

Fields required to update a channel.

Schema: Saleor 3.23.43. Download SDL.