Skip to main content

favoriteListDelete

Permanently delete a favorite list from the system.

Removes the favorite list and all associated data from the system. This is a destructive operation that cannot be undone.

Deletion process includes:

  • Complete removal of the favorite list record
  • Cleanup of all associated item references
  • Removal from any cached data structures
  • Audit trail logging for compliance

This operation will affect any external references to this favorite list, so it should be used with caution. The operation returns true on successful deletion.

Warning: This is a permanent operation that cannot be reversed. Ensure the list is no longer needed before deletion.

Possible errors:

  • FAVORITE_LISTS_NOT_FOUND_ERROR: Favorite list with the specified ID does not exist
  • FAVORITE_LISTS_DELETE_ERROR: Failed to delete the favorite list due to system error
  • FAVORITE_LISTS_UNKNOWN_ERROR: Unexpected system error during deletion operation

AUTH: Role=[system] OR ('user is authenticated')

favoriteListDelete(
  id: String!
): Boolean!

Arguments​

favoriteListDelete.id ● String! non-null scalar​

Unique identifier of the favorite list to delete.

Must be a valid MongoDB ObjectId string with length of 12 or 24 characters representing an existing favorite list. The ObjectId format is validated automatically and will return an error for invalid formats.

Validation constraints:

  • Required field (cannot be null or empty)
  • Must be valid ObjectId format (hexadecimal string)
  • Must reference an existing favorite list in the system

Warning: This operation permanently removes the favorite list and cannot be undone.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.