HIhint
PartnerProductHighlight

Create Product Highlight

post/partner/products/{product_id}/highlights

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/partner/products/{product_id}/highlights
  • Auth
    API key in header AUTHORIZATION

Path parameters

product_idstring required

Unique Product ID

Request body

titlestring

Short title (1–4 words) shown above the description.

descriptionstring

One-line description of the highlight.

imagestring

Image as a base64 data URI ("data:image/png;base64,..."). Note: the field name differs across listing sections. Highlights use image; overview images (ProductOverviewSanitizer.ImageSanitizer) use url. Both take the same data-URI payload — only the key differs.

positioninteger

Display order. Optional — defaults to the next position via acts_as_list.

Response

Successful response

idstring
descriptionstring
image_urlstring
positioninteger
titlestring

Changes

No recorded changes to this operation across all 2 revisions of this API.