Skip to main content
POST
Create a new review embed config for a business

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the business

Body

application/json
title
string

The title of the review embed

review_text_prompt
string

The prompt for the review text

review_text_placeholder
string

The placeholder for the review text

min_stars_to_prompt_review
integer

The minimum number of stars to prompt for a review

google_request_review_url
string | null

The URL to request a review from Google

submit_cta
string

The text for the submit button

slug
string

The slug for the review embed. If not provided, one will be auto-generated based on the business name.

redirect_to_google_request_review_url
boolean

Whether to redirect directly to the Google review link

Response

200 - application/json

The created review embed configuration

id
string
required

The ID of the review embed config

title
string
required

The title of the review embed

review_text_prompt
string
required

The prompt for the review text

review_text_placeholder
string
required

The placeholder for the review text

min_stars_to_prompt_review
integer
required

The minimum number of stars to prompt for a review

google_request_review_url
string | null
required

The URL to request a review from Google

submit_cta
string
required

The text for the submit button

slug
string
required

The unique identifier that appears in the public review URL

redirect_to_google_request_review_url
boolean
required

Whether to redirect directly to the Google review link

permanent_review_page_url
string
required

The permanent review page URL