Sign in
Review embed configs

Create a new review embed config for a business

post/businesses/{id}/review_embed_configs

Path parameters

idstring required

The ID of the business

Request body

titlestring

The title of the review embed

review_text_promptstring

The prompt for the review text

review_text_placeholderstring

The placeholder for the review text

min_stars_to_prompt_reviewinteger

The minimum number of stars to prompt for a review

google_request_review_urlstring nullable

The URL to request a review from Google

submit_ctastring

The text for the submit button

slugstring

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

redirect_to_google_request_review_urlboolean

Whether to redirect directly to the Google review link

Response

The created review embed configuration

idstring required

The ID of the review embed config

titlestring required

The title of the review embed

review_text_promptstring required

The prompt for the review text

review_text_placeholderstring required

The placeholder for the review text

min_stars_to_prompt_reviewinteger required

The minimum number of stars to prompt for a review

google_request_review_urlstring nullable required

The URL to request a review from Google

submit_ctastring required

The text for the submit button

slugstring required

The unique identifier that appears in the public review URL

redirect_to_google_request_review_urlboolean required

Whether to redirect directly to the Google review link

permanent_review_page_urlstring required

The permanent review page URL

Changes

No recorded changes to this endpoint across all 1 revision of this API.