Create Review
createReviewCreate Review
Create a review for a customer identified by email or phone, creating the customer when needed, with optional source, location, tags, and review date.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Email address used to find or create the customer. | ||
| phone | No | Phone number used to find or create the customer. | |
| score | Yes | Star rating from 1 to 5. | |
| review | No | Plain-text review body; HTML is derived server-side. Accepts at most 5000 characters. | |
| company | No | Company or organization name associated with the customer. | |
| last_name | No | Customer last name. | |
| tag_slugs | No | Review tag slugs to assign after create. | |
| created_at | No | When the review was written. Optional instant for request bodies: Unix timestamp as integer (seconds), or a date/time string of at most 50 characters that PHP Carbon can parse. For strings, ISO-8601 / RFC 3339 (for example 2026-04-28T15:30:00Z) is the recommended format in examples and client integrations. Invalid values fail validation. When the field is omitted or null, the API uses the current server time where that behavior is documented on the operation. | |
| first_name | Yes | Customer first name. | |
| source_slug | No | Slug of an existing review source. Returns 404 if the slug is not found. Accepts at most 50 characters. | |
| external_url | No | Public URL of the review on an external site (for example Google or Yelp). Accepts at most 500 characters. | |
| location_slug | No | Slug of an existing project location. Returns 404 if the slug is not found. Accepts at most 50 characters. | |
| customer_photo_url | No | Public image URL downloaded and stored as the customer photo before the review is created. Returns 400 if the URL cannot be fetched or is not a valid image. Accepts at most 500 characters. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Short code or application-level status code for this resource. | |
| data | No | Response payload for the request. | |
| success | No | Indicates whether the request completed successfully. |