Cancel a review request
POST/api/v2/review-requests/{matterReference}/cancel
Cancels every attempt on a review request that has not been sent yet, so nothing further goes out. Use it when a matter should no longer receive reminders, for example because the client has complained or the matter was closed early.
What gets cancelled
| Attempt | Outcome |
|---|---|
Attempts still PENDING, including the first one | Cancelled. Their status becomes CANCELLED_BY_REVIEW. |
Attempts already SENT or further along | Left as they are. A message that has gone out cannot be recalled. |
The response does not list which attempts were cancelled. To check, call
Get a review request and read each attempt’s status.
Path parameters
| Param | Type | Required | Description |
|---|---|---|---|
matterReference | string | Required | The reference the review request was created with. |
Request
cURL
POST /api/v2/review-requests/{matterReference}/cancel
curl --location --request POST 'https://www.reviewsolicitors.co.uk/api/v2/review-requests/{matterReference}/cancel' \
--header 'Authorization: Bearer {access_token}'Response
200 OK
{
"message": "review request cancelled"
}The response is the same even when no review request exists for the reference. Check that the reference is right with Get a review request if you need to be sure.
Last updated on