Create a review request

POST/api/v2/review-requests

Creates a review request, inviting a client to leave a review for your firm. Send it from your case management system as soon as a matter completes.

Body parameters

Field	Type	Required	Description
`firstName`	`string`	Required	The client first name. Between 2 and 50 characters.
`lastName`	`string`	Required	The client last name. Between 2 and 50 characters.
`email`	`string`	Required	The client email address.
`reference`	`string`	Required	Your case reference for this matter. Must be unique for your firm.
`phoneNumber`	`string`	Optional	The client phone number. Must be a valid UK mobile number.
`postcode`	`string`	Optional	The client postcode.
`professional`	`string`	Optional	The name of the professional who handled the matter.
`workArea`	`string`	Optional	The area of law the matter relates to.
`language`	`string`	Optional	Language code for the invitation, such as `EN`. See Language codes. Defaults to your firm’s default language.
`personalMessage`	`string`	Optional	A personal message shown to the client at the top of the review questionnaire. Up to 2000 characters.

The company is taken from your access token, so there is no company field in the body.

Request

cURL

POST /api/v2/review-requests


curl --location 'https://www.reviewsolicitors.co.uk/api/v2/review-requests' \
     --header 'Authorization: Bearer {access_token}' \
     --header 'Content-Type: application/json' \
     --data   '{
          "firstName": "Jane",
          "lastName": "Doe",
          "email": "jane.doe@example.com",
          "reference": "MATTER-1234",
          "phoneNumber": "07700900123",
          "postcode": "SW1A 1AA",
          "professional": "Alex Smith",
          "workArea": "Conveyancing",
          "language": "EN",
          "personalMessage": "Thank you for trusting us with your purchase."
     }'

Response

200 OK


{
  "message" : "Review request successfully created"
}

Errors

A rejected request returns 400 with an errors object keyed by the field that caused it:

400 Bad Request


{
  "errors": {
    "reference": "Review request with this reference already exists"
  }
}

Field	Message	Cause
`reference`	Review request with this reference already exists	You have already created a review request with this `reference`.
`reference`	Review request with this reference is blocked	This `reference` has been blocked.

A field that fails validation, such as a missing email or a firstName shorter than 2 characters, returns 400 with a list instead, one entry per field:

400 Bad Request


[
  {
    "field": "firstName",
    "error": ["firstName should be between 2 and 50 characters"]
  }
]

See Errors.

A request is rejected if a review request was already sent, or a review already left, for the same contact details within the past year.

Language codes

Pass one of these as language. Anything unrecognised falls back to your firm’s default.

Code	Language	Code	Language
`EN`	English	`NL`	Dutch
`FR`	French	`NO`	Norwegian
`AR`	Arabic	`PT`	Portuguese
`SP`	Spanish	`UK`	Ukrainian
`FI`	Finnish	`RO`	Romanian
`BI`	Bangla	`RU`	Russian
`IT`	Italian	`TL`	Filipino
`PL`	Polish	`TR`	Turkish
`DA`	Danish	`ZH`	Chinese
`EL`	Greek	`DE`	German
`LT`	Lithuanian	`SE`	Swedish
`WL`	Welsh	`TW`	Traditional Chinese
`VI`	Vietnamese	`TH`	Thai