Ask a job's homeowner for a review

Creates a review request for the job's homeowner and queues it for sending. Send platform
(google, facebook, yelp or bbb) inside a review_request object. The recipient is always
the job's contact; you don't choose it.

The request is sent in the background: by text message if the homeowner has a phone number and has
opted in to texts, and by email if they have an email address and have opted in to email. The
response comes back with status pending; read the request later to see whether it was sent.

A platform can only be used once a review link has been set up for it; otherwise the request is
rejected. The token's role must be able to work on sales.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
review_request
object
Responses
201

The new review request, queued for sending.

422

The request could not be created, for example because platform is missing, not recognized, or has no review link set up; errors lists the reasons.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!