Record private feedback from a customer

Save a customer's comment and star rating, tied to the review request they received, and notify the business. The comment is saved as a review on the location, under the review site you pass; it isn't posted to that site. Called by the Shout About Us-hosted landing page: it needs a reCAPTCHA token from that page, so it can't be called from a backend, a script, or Postman.

Prerequisites: no token; a reCAPTCHA token from a Shout About Us-hosted page and the review request's unique code.

Authentication: Public (no token). No bearer token; the review request's unique_code decides the location.

Rate limit: 30 requests per minute, counted per client IP address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 50
Defaults to 4xwu8

The email or SMS review request's unique code, up to 50 characters.

string
required
length ≤ 100

The customer's email address, up to 100 characters. Checked with an RFC and DNS lookup, so the domain must accept mail.

string
required
length ≤ 100
Defaults to Jane Smith

The customer's name, up to 100 characters. Saved as the reviewer.

string
length between 7 and 20
Defaults to +15555550100

The customer's phone number, 7–20 characters.

string
required
length ≤ 255
Defaults to Great service, thank you!

The comment, up to 255 characters. Saved as the review text.

integer
required
1 to 5
Defaults to 5

The rating, 1–5.

string
required

The Google reCAPTCHA token from the Shout About Us-hosted page.

integer
required
Defaults to 44

The review site to save the feedback under. Must be an existing review site.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json