Toggle favorite state

POST/api/favorites/toggle

Toggles the favorite state of an object for the current workspace user.

Request Body

application/json

Request payload for Toggle favorite state.

TypeScript Definitions

Use the request body type in TypeScript.

objectHandle*string

Object handle for the favorite operation.

Length1 <= length

objectId*string

Object identifier to favorite or unfavorite.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/favorites/toggle" \  -H "Content-Type: application/json" \  -d '{    "objectHandle": "products",    "objectId": "product_123"  }'

{  "objectHandle": "products",  "objectId": "product_123",  "isFavorite": true}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Toggle favorite state

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`