Skip to main content

updateProductLabelRecipe

Rename a label recipe or replace its saved settings.

Business Rules​

  • At least one of name or settings must be given; an omitted field keeps its value.
  • A new name follows the same rules as on creation: trimmed, not blank, at most 80 characters, unique among the company's active recipes ignoring case.
  • Replacement settings follow the same rules as on creation.
  • An archived recipe cannot be changed.

Error Scenarios​

  • **NOT_FOUND**: when the recipe does not exist or belongs to another company
  • **BAD_REQUEST**: when settings is not a JSON object
  • **VALIDATION**: when the recipe is archived, when nothing is given to update, or when the name or settings break the rules above

Permissions Required​

  • products:update_label_recipe permission.
updateProductLabelRecipe(
  input: UpdateProductLabelRecipeInput!
): UpdateProductLabelRecipePayload

Arguments​

updateProductLabelRecipe.input ● UpdateProductLabelRecipeInput! non-null input common​

Parameters for UpdateProductLabelRecipe

Type​

UpdateProductLabelRecipePayload object common​

Autogenerated return type of UpdateProductLabelRecipe.