SellApp
ResourcesHighlights

Manage highlights

List, search, create, retrieve, update, reorder, and delete highlights.

Create requests use multipart/form-data and the files[] field. All other mutations on this page use JSON. Reordering requires the complete set of published highlight IDs.

GET
/v2/highlights

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Query Parameters

limit?integer

Number of items to return per page.

Default15
Range1 <= value <= 100
page?integer

Page number to return.

Default1
Range1 <= value
pagination?boolean

Set to false to return at most 100 matching items in one data array without pagination links or metadata.

Defaulttrue

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/highlights"
{
  "data": [
    {
      "id": 0,
      "title": "string",
      "hidden": true,
      "sort_order": 0,
      "published_at": "2019-08-24T14:15:22Z",
      "media": [
        {
          "id": 0,
          "sort_order": 0,
          "type": "image",
          "url": "http://example.com",
          "filename": "string",
          "size": 0,
          "mime_type": "string",
          "cta_title": "string",
          "product_id": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "links": {
    "first": "https://sell.app/api/v1/blacklists?page=1",
    "last": "https://sell.app/api/v1/blacklists?page=4",
    "prev": null,
    "next": "https://sell.app/api/v1/blacklists?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "https://sell.app/api/v1/blacklists",
    "per_page": 15,
    "to": 15,
    "total": 57
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
POST
/v2/highlights/search

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Query Parameters

limit?integer

Number of items to return per page.

Default15
Range1 <= value <= 100
page?integer

Page number to return.

Default1
Range1 <= value
pagination?boolean

Set to false to return at most 100 matching items in one data array without pagination links or metadata.

Defaulttrue

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://sell.app/api/v2/highlights/search" \  -H "Content-Type: application/json" \  -d '{    "filters": [      {        "field": "id",        "operator": "=",        "value": 1      }    ],    "sort": [      {        "field": "created_at",        "direction": "desc"      }    ]  }'
{
  "data": [
    {
      "id": 0,
      "title": "string",
      "hidden": true,
      "sort_order": 0,
      "published_at": "2019-08-24T14:15:22Z",
      "media": [
        {
          "id": 0,
          "sort_order": 0,
          "type": "image",
          "url": "http://example.com",
          "filename": "string",
          "size": 0,
          "mime_type": "string",
          "cta_title": "string",
          "product_id": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "links": {
    "first": "https://sell.app/api/v1/blacklists?page=1",
    "last": "https://sell.app/api/v1/blacklists?page=4",
    "prev": null,
    "next": "https://sell.app/api/v1/blacklists?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "https://sell.app/api/v1/blacklists",
    "per_page": 15,
    "to": 15,
    "total": 57
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
POST
/v2/highlights

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://sell.app/api/v2/highlights" \  -F title="string" \  -F hidden="true" \  -F files="[    \"string\"  ]"
{
  "data": {
    "id": 42,
    "title": "Summer launch",
    "hidden": false,
    "sort_order": 1,
    "published_at": "2026-07-11T12:00:00Z",
    "media": [
      {
        "id": 84,
        "sort_order": 1,
        "type": "image",
        "url": "https://cdn.sell.app/store/1/highlights/example.png",
        "filename": "example.png",
        "size": 24576,
        "mime_type": "image/png",
        "cta_title": "View product",
        "product_id": 123,
        "created_at": "2026-07-11T12:00:00Z",
        "updated_at": "2026-07-11T12:00:00Z"
      }
    ],
    "created_at": "2026-07-11T12:00:00Z",
    "updated_at": "2026-07-11T12:00:00Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
GET
/v2/highlights/{highlight}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

highlight*integer

The highlight path parameter.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/highlights/0"
{
  "data": {
    "id": 42,
    "title": "Summer launch",
    "hidden": false,
    "sort_order": 1,
    "published_at": "2026-07-11T12:00:00Z",
    "media": [
      {
        "id": 84,
        "sort_order": 1,
        "type": "image",
        "url": "https://cdn.sell.app/store/1/highlights/example.png",
        "filename": "example.png",
        "size": 24576,
        "mime_type": "image/png",
        "cta_title": "View product",
        "product_id": 123,
        "created_at": "2026-07-11T12:00:00Z",
        "updated_at": "2026-07-11T12:00:00Z"
      }
    ],
    "created_at": "2026-07-11T12:00:00Z",
    "updated_at": "2026-07-11T12:00:00Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PATCH
/v2/highlights/{highlight}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

highlight*integer

The highlight path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://sell.app/api/v2/highlights/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": 42,
    "title": "Summer launch",
    "hidden": false,
    "sort_order": 1,
    "published_at": "2026-07-11T12:00:00Z",
    "media": [
      {
        "id": 84,
        "sort_order": 1,
        "type": "image",
        "url": "https://cdn.sell.app/store/1/highlights/example.png",
        "filename": "example.png",
        "size": 24576,
        "mime_type": "image/png",
        "cta_title": "View product",
        "product_id": 123,
        "created_at": "2026-07-11T12:00:00Z",
        "updated_at": "2026-07-11T12:00:00Z"
      }
    ],
    "created_at": "2026-07-11T12:00:00Z",
    "updated_at": "2026-07-11T12:00:00Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PUT
/v2/highlights/{highlight}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

highlight*integer

The highlight path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://sell.app/api/v2/highlights/0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": 42,
    "title": "Summer launch",
    "hidden": false,
    "sort_order": 1,
    "published_at": "2026-07-11T12:00:00Z",
    "media": [
      {
        "id": 84,
        "sort_order": 1,
        "type": "image",
        "url": "https://cdn.sell.app/store/1/highlights/example.png",
        "filename": "example.png",
        "size": 24576,
        "mime_type": "image/png",
        "cta_title": "View product",
        "product_id": 123,
        "created_at": "2026-07-11T12:00:00Z",
        "updated_at": "2026-07-11T12:00:00Z"
      }
    ],
    "created_at": "2026-07-11T12:00:00Z",
    "updated_at": "2026-07-11T12:00:00Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PATCH
/v2/highlights/reorder

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://sell.app/api/v2/highlights/reorder" \  -H "Content-Type: application/json" \  -d '{    "resources": [      42,      41    ]  }'
{
  "data": [
    {
      "id": 0,
      "title": "string",
      "hidden": true,
      "sort_order": 0,
      "published_at": "2019-08-24T14:15:22Z",
      "media": [
        {
          "id": 0,
          "sort_order": 0,
          "type": "image",
          "url": "http://example.com",
          "filename": "string",
          "size": 0,
          "mime_type": "string",
          "cta_title": "string",
          "product_id": 0,
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
DELETE
/v2/highlights/{highlight}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

highlight*integer

The highlight path parameter.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://sell.app/api/v2/highlights/0"
{
  "data": {
    "id": 42,
    "title": "Summer launch",
    "hidden": false,
    "sort_order": 1,
    "published_at": "2026-07-11T12:00:00Z",
    "media": [
      {
        "id": 84,
        "sort_order": 1,
        "type": "image",
        "url": "https://cdn.sell.app/store/1/highlights/example.png",
        "filename": "example.png",
        "size": 24576,
        "mime_type": "image/png",
        "cta_title": "View product",
        "product_id": 123,
        "created_at": "2026-07-11T12:00:00Z",
        "updated_at": "2026-07-11T12:00:00Z"
      }
    ],
    "created_at": "2026-07-11T12:00:00Z",
    "updated_at": "2026-07-11T12:00:00Z"
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}

Overview

Create and manage storefront highlights, their media, publication state, and display order.

Manage highlight media

Upload, replace, update, reorder, list, and delete highlight images and videos.