> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useboom.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Change the review widget look

> Change how the review widgets look on the storefront. Send only what should change: store-wide fields replace, each widget merges with its own settings, and a preset sets the layout, star color, corners, card style and headings in one go, leaving the rest of the look alone. Shoppers see the new look within about five minutes. Returns the look as it now stands.



## OpenAPI

````yaml /api-reference/openapi.json patch /api/v1/reviews/widget-look
openapi: 3.1.0
info:
  title: Boom API
  version: 1.0.0
  description: >-
    Boom's public REST API — one uniform surface over every platform capability.
    CDP: upsert people and custom objects, define object and relationship types,
    link and unlink relationships, and record behavioral events — one record per
    request or up to 1000 per request via the `/batch` endpoints. Segments: read
    (list, read, membership) and full authoring — discover the filterable
    catalog, validate a filter, create and update segments, preview match
    counts, and trigger evaluation. Initiatives: create and configure outreach
    initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel,
    archive), and read collected-data summaries. Participants: enroll people
    into an active initiative, track their status, read conversation
    transcripts, and stop outreach. Journeys: read-only access to always-on
    message flows and their metrics. WhatsApp templates: list your WhatsApp
    numbers and list, read, and create message templates. The same capabilities
    are exposed as MCP tools with identical schemas.
servers:
  - url: https://www.useboom.ai
    description: Production
  - url: https://dev.useboom.ai
    description: Development (sandbox — use a development organization API key)
security:
  - bearerAuth: []
paths:
  /api/v1/reviews/widget-look:
    patch:
      tags:
        - Reviews
      summary: Change the review widget look
      description: >-
        Change how the review widgets look on the storefront. Send only what
        should change: store-wide fields replace, each widget merges with its
        own settings, and a preset sets the layout, star color, corners, card
        style and headings in one go, leaving the rest of the look alone.
        Shoppers see the new look within about five minutes. Returns the look as
        it now stands.
      operationId: reviews_widget_look_update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                layout:
                  type: string
                  enum:
                    - split
                    - cards
                    - list
                starColor:
                  anyOf:
                    - type: string
                      pattern: ^#[0-9a-fA-F]{6}$
                    - type: string
                      const: text
                corners:
                  type: string
                  enum:
                    - square
                    - soft
                    - round
                cards:
                  type: string
                  enum:
                    - lines
                    - outline
                    - filled
                headings:
                  type: string
                  enum:
                    - body
                    - theme
                badge:
                  type: string
                  enum:
                    - count
                    - average
                    - compact
                defaultSort:
                  type: string
                  enum:
                    - recent
                    - highest
                    - lowest
                hideWhenEmpty:
                  type: boolean
                showVerifiedBadge:
                  type: boolean
                showInsights:
                  type: boolean
                showPhotoStrip:
                  type: boolean
                showPhotos:
                  type: boolean
                showInitials:
                  type: boolean
                showDate:
                  type: boolean
                showReplies:
                  type: boolean
                widgets:
                  description: >-
                    Per widget: an optional look of its own, and that widget’s
                    settings. A widget you leave out keeps what it had.
                  type: object
                  properties:
                    product:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                    stars:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                    highlights:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                        showSummary:
                          type: boolean
                        showQuote:
                          type: boolean
                    carousel:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                        select:
                          type: string
                          enum:
                            - featured
                            - top
                            - photos
                            - newest
                        card:
                          type: string
                          enum:
                            - photo
                            - quote
                            - wall
                        perView:
                          anyOf:
                            - type: number
                              const: 3
                            - type: number
                              const: 4
                            - type: number
                              const: 5
                        autoplay:
                          type: boolean
                        showProduct:
                          type: boolean
                    wall:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                        select:
                          type: string
                          enum:
                            - newest
                            - top
                            - photos
                        showFilters:
                          type: boolean
                    testimonials:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                        select:
                          type: string
                          enum:
                            - featured
                            - top
                            - newest
                        autoplay:
                          type: boolean
                        showProduct:
                          type: boolean
                    gallery:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                    banner:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                        style:
                          type: string
                          enum:
                            - band
                            - strip
                    all:
                      type: object
                      properties:
                        look:
                          anyOf:
                            - type: object
                              properties:
                                starColor:
                                  anyOf:
                                    - type: string
                                      pattern: ^#[0-9a-fA-F]{6}$
                                    - type: string
                                      const: text
                                corners:
                                  type: string
                                  enum:
                                    - square
                                    - soft
                                    - round
                                cards:
                                  type: string
                                  enum:
                                    - lines
                                    - outline
                                    - filled
                                headings:
                                  type: string
                                  enum:
                                    - body
                                    - theme
                              required:
                                - starColor
                                - corners
                                - cards
                                - headings
                            - type: 'null'
                preset:
                  description: >-
                    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.
                  type: string
                  enum:
                    - editorial
                    - minimal
                    - soft
                    - bold
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  layout:
                    type: string
                    enum:
                      - split
                      - cards
                      - list
                  starColor:
                    anyOf:
                      - type: string
                        pattern: ^#[0-9a-fA-F]{6}$
                      - type: string
                        const: text
                  corners:
                    type: string
                    enum:
                      - square
                      - soft
                      - round
                  cards:
                    type: string
                    enum:
                      - lines
                      - outline
                      - filled
                  headings:
                    type: string
                    enum:
                      - body
                      - theme
                  badge:
                    type: string
                    enum:
                      - count
                      - average
                      - compact
                  defaultSort:
                    type: string
                    enum:
                      - recent
                      - highest
                      - lowest
                  hideWhenEmpty:
                    type: boolean
                  showVerifiedBadge:
                    type: boolean
                  showInsights:
                    type: boolean
                  showPhotoStrip:
                    type: boolean
                  showPhotos:
                    type: boolean
                  showInitials:
                    type: boolean
                  showDate:
                    type: boolean
                  showReplies:
                    type: boolean
                  widgets:
                    type: object
                    properties:
                      product:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                        additionalProperties: false
                      stars:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                        additionalProperties: false
                      highlights:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                          showSummary:
                            type: boolean
                          showQuote:
                            type: boolean
                        additionalProperties: false
                      carousel:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                          select:
                            type: string
                            enum:
                              - featured
                              - top
                              - photos
                              - newest
                          card:
                            type: string
                            enum:
                              - photo
                              - quote
                              - wall
                          perView:
                            anyOf:
                              - type: number
                                const: 3
                              - type: number
                                const: 4
                              - type: number
                                const: 5
                          autoplay:
                            type: boolean
                          showProduct:
                            type: boolean
                        additionalProperties: false
                      wall:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                          select:
                            type: string
                            enum:
                              - newest
                              - top
                              - photos
                          showFilters:
                            type: boolean
                        additionalProperties: false
                      testimonials:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                          select:
                            type: string
                            enum:
                              - featured
                              - top
                              - newest
                          autoplay:
                            type: boolean
                          showProduct:
                            type: boolean
                        additionalProperties: false
                      gallery:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                        additionalProperties: false
                      banner:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                          style:
                            type: string
                            enum:
                              - band
                              - strip
                        additionalProperties: false
                      all:
                        type: object
                        properties:
                          look:
                            anyOf:
                              - type: object
                                properties:
                                  starColor:
                                    anyOf:
                                      - type: string
                                        pattern: ^#[0-9a-fA-F]{6}$
                                      - type: string
                                        const: text
                                  corners:
                                    type: string
                                    enum:
                                      - square
                                      - soft
                                      - round
                                  cards:
                                    type: string
                                    enum:
                                      - lines
                                      - outline
                                      - filled
                                  headings:
                                    type: string
                                    enum:
                                      - body
                                      - theme
                                required:
                                  - starColor
                                  - corners
                                  - cards
                                  - headings
                                additionalProperties: false
                              - type: 'null'
                        additionalProperties: false
                    required:
                      - product
                      - stars
                      - highlights
                      - carousel
                      - wall
                      - testimonials
                      - gallery
                      - banner
                      - all
                    additionalProperties: false
                  preset:
                    anyOf:
                      - type: string
                        enum:
                          - editorial
                          - minimal
                          - soft
                          - bold
                      - type: 'null'
                    description: >-
                      The preset this look matches, or null once it was
                      adjusted.
                required:
                  - layout
                  - starColor
                  - corners
                  - cards
                  - headings
                  - badge
                  - defaultSort
                  - hideWhenEmpty
                  - showVerifiedBadge
                  - showInsights
                  - showPhotoStrip
                  - showPhotos
                  - showInitials
                  - showDate
                  - showReplies
                  - widgets
                  - preset
                additionalProperties: false
        '400':
          description: Validation failed or the request cannot proceed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '403':
          description: >-
            The key belongs to a partner workspace (`partner_workspace`); use a
            key from the brand.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '404':
          description: The resource does not exist in this organization.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '409':
          description: >-
            Conflicts with the current state (duplicates, wrong lifecycle
            state).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '422':
          description: The request is well-formed but semantically invalid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '429':
          description: Rate limit exceeded — retry after `Retry-After`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
        '503':
          description: Transient error — retry with a narrower request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: Stable machine-readable error code (snake_case).
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Organization API key, sent as `Authorization: Bearer boom_org_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.