API Documentation

Send Review Request

Sends a Google review request email to a customer. Use this endpoint to ask customers for a review after any interaction.

Authentication

Pass your Sherli API key using one of three methods (checked in this order): the X-API-Key header, the Authorization header, or the api_key query parameter.

X-API-Key: YOUR_API_KEY
# or
Authorization: YOUR_API_KEY
# or
?api_key=YOUR_API_KEY

Request Body

# Using X-API-Key header
curl -X POST https://admin.sherli.com/api/webhooks/review-request \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"email": "customer@example.com", "full_name": "Jane Doe"}'

# Using Authorization header
curl -X POST https://admin.sherli.com/api/webhooks/review-request \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{"email": "customer@example.com", "full_name": "Jane Doe"}'

# Using query parameter
curl -X POST "https://admin.sherli.com/api/webhooks/review-request?api_key=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "customer@example.com", "full_name": "Jane Doe"}'

Responses

{
  "success": true,
  "message": "Review request email sent successfully",
  "email": "customer@example.com",
  "business": "Your Business Name",
  "review_link": "https://search.google.com/local/writereview?placeid=..."
}

{ "success": false, "error": "email is required" }

{ "success": false, "error": "Invalid or missing API key" }

{ "success": false, "error": "Business is not fully configured to receive review requests" }

{ "success": false, "error": "Failed to send review request email" }