Skip to main content
PATCH
/
products
/
{id}
/
featured
Toggle product featured status
curl --request PATCH \
  --url https://api.salesive.com/api/v1/products/{id}/featured \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Toggle product featured status",
  "data": {
    "_id": "66a1f2c4e1b3a40012ab34cd",
    "name": "Classic Tee",
    "slug": "classic-tee",
    "price": 19.99,
    "quantity": 120,
    "featured": false,
    "listed": true,
    "shop": "66a1eee0e1b3a40012ab0001",
    "updatedAt": "2026-06-28T09:10:00.000Z"
  }
}
Flips the product’s featured flag (featured becomes unfeatured and vice versa) and returns the updated product. Requires the WRITE_INVENTORY scope.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Path Parameters

​
id
string
required

ObjectId of the product to toggle.

Response

Toggle product featured status — success.

​
status
integer
required
Example:

200

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Toggle product featured status"

​
data
object
required

An ecommerce catalog product.

Example:
{
  "_id": "66a1f2c4e1b3a40012ab34cd",
  "name": "Classic Tee",
  "slug": "classic-tee",
  "price": 19.99,
  "quantity": 120,
  "featured": false,
  "listed": true,
  "shop": "66a1eee0e1b3a40012ab0001",
  "updatedAt": "2026-06-28T09:10:00.000Z"
}