Skip to main content

favoriteListUpdate

Update an existing favorite list's configuration.

Modifies favorite list details including name and content. Only provided fields will be updated, others remain unchanged. This operation supports partial updates, allowing selective modification of list properties.

Update capabilities include:

  • Name modification (automatically regenerates slug)
  • Content updates (products and clusters using ID or source format)
  • Default status changes
  • Ownership cannot be changed after creation

The update operation preserves existing data for fields not included in the input, making it safe for partial updates. All validation rules from creation apply to the updated values.

Validation constraints:

  • Name must be unique within the owner's scope if provided (maximum 64 characters)
  • Product and cluster references must exist if provided
  • Array fields must contain unique values
  • External source references must have valid format

Possible errors:

  • FAVORITE_LISTS_NOT_FOUND_ERROR: Favorite list with the specified ID does not exist
  • FAVORITE_LISTS_UPDATE_ERROR: Failed to update the favorite list due to system error
  • FAVORITE_LISTS_INVALID_INPUT_ERROR: Updated favorite list data validation failed
  • FAVORITE_LISTS_UNKNOWN_ERROR: Unexpected system error during update operation

AUTH: Role=[shop.OWNER,shop.EDITOR] OR ('user is authenticated')

favoriteListUpdate(
  id: String!
  input: FavoriteListsUpdateInput!
): FavoriteList!

Arguments​

favoriteListUpdate.id ● String! non-null scalar​

Unique identifier of the favorite list to update.

Must be the identifier of an existing favorite list. Two formats are accepted and both remain valid: a 24-character hexadecimal id (lists created before the PostgreSQL migration) or a UUID (lists created after it). The format is validated automatically and will return an error for anything else.

Validation constraints:

  • Required field (cannot be null or empty)
  • Must be a 24-character hexadecimal id or a UUID
  • Must reference an existing favorite list in the system

favoriteListUpdate.input ● FavoriteListsUpdateInput! non-null input​

Updated favorite list information.

Contains the favorite list properties to update. All fields are optional for partial updates. Only provided fields will be changed, others remain unchanged.

Updatable fields:

  • name: New descriptive name (maximum 64 characters, must be unique within owner scope)
  • productIds/productSources: Replace current product associations
  • clusterIds/clusterSources: Replace current cluster associations
  • isDefault: Change default status

Note: Ownership (company, contact, customer) cannot be modified after creation.

Type​

FavoriteList object​