Toggle favorite state

POST/api/unstable/favorites/toggle

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

Request Body

application/json

objectHandle*string

Object handle for the favorite operation. Currently only products are supported.

Length1 <= length

Example"products"

objectId*string

Object identifier to favorite or unfavorite.

Length1 <= length

Example"product_123"

[key: string]?never

Response Body

`application/json`

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

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

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Toggle favorite state

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`