Save Collection

Method: POST

Fields:

• id - optional; include when editing the collection element.
• name - required.
• handle - optional; generated when empty.
• description - optional.
• isDefault - optional boolean.
• userId - optional; empty means global collection.
• allowedElementTypes[] - optional; omit all values to allow every element type.
• fields[...] - optional custom field values.

Permission:

• super-favourite:manage-collections
• super-favourite:manage-global-collections is also required when creating or editing a global/default collection.

Delete Collection

Method: POST

Fields:

• id - required collection element ID.
• deleteItems - optional boolean. When truthy, the collection is deleted immediately and favourite item cleanup is queued.

Requires login. Admins can delete any collection; users can delete their own collections. Global collections require admin access or super-favourite:manage-global-collections. Without deleteItems, collections that still contain enabled favourite items cannot be deleted.

Non-JSON failures return the failed collection model via Craft's model failure response. JSON success and failure responses include a boolean success value.

Set Default Collection

Method: POST

Fields:

• id - required collection element ID.

Permission:

• super-favourite:manage-collections
• super-favourite:manage-global-collections

Reorder Collections

Method: POST

Fields:

• ids - array of collection IDs in the desired order.

Permission:

• super-favourite:manage-collections
• super-favourite:manage-global-collections is also required when the submitted order includes global collections.

Add Favourite

Method: POST

Fields:

• elementId - required.
• elementType - optional class name; derived from elementId when omitted.
• collectionId - required valid collection ID.
• notes - optional.

Requires login.

Save Favourite

Method: POST

Fields:

• id - optional; include when editing the favourite item element.
• elementType - optional; derived from elementId when omitted.
• elementId - required. CP element select may submit an array.
• userId - optional for frontend; current user is used when empty.
• collectionId - required valid collection ID.
• notes - optional.
• fields[...] - optional custom field values.

CP requests require super-favourite:manage-favourites. Frontend requests require login.

Frontend non-JSON failures return the failed favourite model via Craft's model failure response. JSON success and failure responses include success and a favourite payload; failures also include Craft's errors payload.

Remove Favourite by Element

Method: POST

Fields:

• elementId - required.
• collectionId - optional. If omitted, matching favourites for the element can be removed across collections.

Requires login.

Non-JSON failures return the failed favourite model when a favourite item can be identified. JSON success and failure responses include success and a favourite payload.

Toggle Favourite

Method: POST

Fields:

• elementId - required.
• elementType - optional; derived from elementId when omitted.
• collectionId - required.

Requires login.

Non-JSON failures return the failed favourite model. JSON success and failure responses include success and a favourite payload; failures also include Craft's errors payload.

Successful responses include Craft's model success data plus:

• success
• action - added or removed
• favourite - the favourite item model data.

Check Favourite

Method: GET or request params

Fields:

• elementId - required.
• collectionId - optional.

Requires login.

Move Favourite

Method: POST

Fields:

• id - required favourite item element ID.
• collectionId - required destination collection.

Requires login.

Delete Favourite by Favourite ID

Method: POST

Fields:

• id - required favourite item element ID.

Requires login. The current user must own the favourite or be an admin.

Get Allowed Types

Fields:

• collectionId - required.

Anonymous access is allowed by the controller.

Get Elements With Favourite Status

Fields:

• elementType - optional; derived from elementId when omitted.
• collectionId - required.
• limit - optional, defaults to 10.

Anonymous access is allowed, but favourite status is only meaningful when a user is logged in.