commercetools icon

commercetools

Interact with the commercetools API. Operations are auto-generated from the official Postman collection.

Actions671

Channel → Update Channel by ID

AI-generated

Summary

Update a commercetools Channel by its ID and version, applying one or more specified update actions to modify its properties.

Inputs

  • Channel ID (required) — The unique identifier of the Channel to update.
  • Version (required) — The current version of the Channel resource, used for concurrency control.
  • Actions (JSON) — A raw JSON array of update actions to apply to the Channel, overriding the UI-configured actions if provided.
  • Actions (UI) — One or more update actions selected via the UI, such as changing the name, description, key, roles, address, custom fields, or geolocation. Ignored if Actions (JSON) is provided.

Output shape

a single updated Channel object in JSON format

The operation returns the full Channel object after applying the specified update actions. The Channel must exist and the specified version must match for the update to succeed.

Examples

Example 1: Update Channel name using UI actions

Provide Channel ID and current version, then add a ChangeName action with the desired localized name.

Example 2: Update Channel using raw JSON actions

Provide Channel ID, version, and a JSON array of update actions to apply, bypassing the UI actions interface.

Links

Discussion