commercetools icon

commercetools

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

Actions671

Recurrence-policy → Update RecurrencePolicy by Key

AI-generated

Summary

Update a RecurrencePolicy in commercetools identified by its key, using a specified version and one or more update actions.

Inputs

  • Recurrence-policy Key (required) — The unique key of the RecurrencePolicy to update.
  • Version (required) — The current version number of the RecurrencePolicy to ensure concurrency control.
  • Actions (JSON) — A raw JSON array of update actions to perform on the RecurrencePolicy; if provided and non-empty, overrides the UI-defined actions.
  • Actions (UI) — A collection of update actions selectable via UI parameters, including setting description, key, name, or schedule. Multiple actions can be added and will be applied in order if 'Actions (JSON)' is empty.

Output shape

a single JSON object representing the updated RecurrencePolicy as returned by the commercetools API

Returns the updated RecurrencePolicy JSON object. Update requires providing the correct current version to avoid conflicts. Errors will be thrown on failure.

Examples

Example 1: Update the name and schedule of a RecurrencePolicy identified by key

Set 'Recurrence-policy Key' to the policy's key, 'Version' to the current version number, and use the UI 'Actions' to set the new name and schedule JSON values.

Links

Discussion