Skip to main content
PATCH
Change the review widget look

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Body

application/json
layout
enum<string>
Available options:
split,
cards,
list
starColor
Pattern: ^#[0-9a-fA-F]{6}$
corners
enum<string>
Available options:
square,
soft,
round
cards
enum<string>
Available options:
lines,
outline,
filled
headings
enum<string>
Available options:
body,
theme
badge
enum<string>
Available options:
count,
average,
compact
defaultSort
enum<string>
Available options:
recent,
highest,
lowest
hideWhenEmpty
boolean
showVerifiedBadge
boolean
showInsights
boolean
showPhotoStrip
boolean
showPhotos
boolean
showInitials
boolean
showDate
boolean
showReplies
boolean
widgets
object

Per widget: an optional look of its own, and that widget’s settings. A widget you leave out keeps what it had.

preset
enum<string>

A designed starting point applied before everything else in the same call: editorial (the default), minimal, soft or bold. It sets five fields — layout, star color, corners, card style and headings — and leaves the rest of the look as it was. Anything you also send wins over it.

Available options:
editorial,
minimal,
soft,
bold

Response

Success

layout
enum<string>
required
Available options:
split,
cards,
list
starColor
required
Pattern: ^#[0-9a-fA-F]{6}$
corners
enum<string>
required
Available options:
square,
soft,
round
cards
enum<string>
required
Available options:
lines,
outline,
filled
headings
enum<string>
required
Available options:
body,
theme
badge
enum<string>
required
Available options:
count,
average,
compact
defaultSort
enum<string>
required
Available options:
recent,
highest,
lowest
hideWhenEmpty
boolean
required
showVerifiedBadge
boolean
required
showInsights
boolean
required
showPhotoStrip
boolean
required
showPhotos
boolean
required
showInitials
boolean
required
showDate
boolean
required
showReplies
boolean
required
widgets
object
required
preset
enum<string> | null
required

The preset this look matches, or null once it was adjusted.

Available options:
editorial,
minimal,
soft,
bold