Choose a version:

channelUpdate

mutation

Updates the properties of an existing Channel. Use this mutation to update account information — such as the display name shown in Shopify Admin — or to bind the channel to a different channel specification.

Updating the specificationHandle triggers re-evaluation of the specification's country coverage against the shop's region markets, reconciling product feeds accordingly. This is also the mechanism for migrating legacy channel records to the multi-channel model by assigning a specification handle.

Anchor to Arguments

Arguments

Anchor to idid

•ID!

required

The ID of the Channel to update.

Anchor to inputinput

•ChannelUpdateInput!

required

The input fields for updating the channel.

Was this section helpful?

Anchor to ChannelUpdatePayload returnsChannelUpdatePayload returns

Anchor to channelchannel •Channel: The channel that was updated.
Anchor to userErrorsuserErrors •[ChannelUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

channelUpdate reference

Mutation Reference

mutation channelUpdate($id: ID!, $input: ChannelUpdateInput!) {

channelUpdate(id: $id, input: $input) {

channel {

# Channel fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"input": {

"handle": "<your-handle>",

"specificationHandle": "<your-specificationHandle>",

"accountId": "<your-accountId>",

"accountName": "<your-accountName>"

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "input": {
    "handle": "<your-handle>",
    "specificationHandle": "<your-specificationHandle>",
    "accountId": "<your-accountId>",
    "accountName": "<your-accountName>"
  }
}

Schema

input ChannelUpdateInput {
  handle: String
  specificationHandle: String
  accountId: String
  accountName: String
}