channelUpdate

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.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the channelUpdate action (under Channel).
Fill in the fields below, then reference the result from later steps as {{channelupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation ChannelUpdate($id: ID!, $input: ChannelUpdateInput!) {
  channelUpdate(id: $id, input: $input) {
    channel {
      accountId
      accountName
      activeRegions
      app {
        apiKey
        appStoreAppUrl
        appStoreDeveloperUrl
        availableAccessScopes
        banner
        description
        developerName
        developerType
        developerUrl
        embedded
        failedRequirements
        features
        feedback
        handle
        icon
        id
        installUrl
        installation
        isPostPurchaseAppInUse
        launchUrl
        navigationItems
        optionalAccessScopes
        previouslyInstalled
        pricingDetails
        pricingDetailsSummary
        privacyPolicyUrl
        publicCategory
        published
        requestedAccessScopes
        screenshots
        shopifyDeveloped
        title
        uninstallMessage
        uninstallUrl
        webhookApiVersion
      }
      handle
      id
      marketsCount {
        count
        precision
      }
      name
      navigationItems {
        id
        title
        url
      }
      overviewPath
      resourceFeedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      specificationHandle
      supportsFuturePublishing
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) to update.

inputobjectrequired

The input fields for updating the channel.

handlestring

specificationHandlestring

accountIdstring

accountNamestring

json

{
  "id": "string",
  "input": {
    "handle": "string",
    "specificationHandle": "string",
    "accountId": "string",
    "accountName": "string"
  }
}

Response

Read the result with {{channelupdate.response.data.data.channelUpdate}}. If the API returns errors, the step fails and they are at {{channelupdate.response.data.errors}}.

channelobject

accountIdstring

accountNamestring

activeRegionsarray<object>

appobject35 fields

handlestring

idstring

marketsCountobject2 fields

namestring

navigationItemsarray<object>

overviewPathstring

resourceFeedbackobject6 fields

specificationHandlestring

supportsFuturePublishingboolean

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?