commercetools icon

commercetools

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

Actions671

Channel → Update Channel by Key

AI-generated

Summary

Update a commercetools Channel identified by its key by specifying a version and a list of update actions.

Inputs

  • Channel Key (required) — Unique key of the Channel to update.
  • Version (required) — The current version number of the Channel resource to ensure update concurrency control.
  • Actions (JSON) — Raw JSON array of update actions to apply to the Channel. Overrides the UI actions if provided and not empty.
  • Actions (UI) — A collection of predefined update actions selectable through the UI, such as changing description, name, key, roles, address, custom fields, geo location, etc. Multiple actions can be added.

Output shape

a list of JSON objects representing the updated Channel resources, one per input item

The response contains the updated Channel object(s) with applied changes. The update requires providing the current version to avoid conflicts. Errors halt execution unless 'continueOnFail' is enabled.

Examples

Example 1: Update a Channel description and add roles by specifying these actions using the UI action collection.

Set the Channel Key and Version, choose 'ChangeDescription' and 'AddRoles' actions in the UI, and provide the appropriate JSON values for description and roles.

Links

Discussion