Skip to content

Update Channel

Partially updates a channel — send only the fields you want to change. Fields you omit keep their current values.

Operation

OperationTypePurpose
updateAdminSettingsChannel(input:)MutationUpdate a channel

Notes

  • Partial update preserves pivots. When you omit the locales, currencies, or inventorySources arrays, the channel's existing assignments are kept. Supplying any of those arrays replaces that assignment set entirely, so always send the full intended set.
  • Translatable scalars target the request locale. A change to a top-level scalar like name / maintenanceModeText applies to the channel's request locale only (in the example, the en translation is updated while other locales keep their previous value). Top-level scalars are broadcast to every locale on create; on update they edit the active locale.
  • code is unique. Changing it must not collide with another channel.
  • Connections are not in the mutation payload. The update payload returns scalars + the SEO triplet; re-query adminSettingsChannel(id:) to read the refreshed locales / currencies / inventorySources / translations connections.

Prerequisites

The example uses an illustrative id. Replace it with a channel id that exists in your store — use the adminSettingsChannels query to discover valid ids.

Released under the MIT License.