Docs
V2 APIReviews

Create review

POST/api/v2/reviews

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/reviews" \  -H "Content-Type: application/json" \  -d '{    "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",    "reviewer_name": "string",    "rating": 1,    "review_date": "2019-08-24T14:15:22Z"  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5",    "source": "google_business_profile",    "external_review_id": "string",    "reviewer_name": "string",    "reviewer_photo_url": "string",    "review_text": "string",    "reply_text": "string",    "reply_date": "2019-08-24T14:15:22Z",    "rating": 1,    "review_date": "2019-08-24T14:15:22Z",    "is_published": true  }}