Report an enquiry

POST/api/v2/client-assist/{id}/report

Reports a Client Assist enquiry as invalid and moves it to REPORTED. Use it when the enquiry should never have reached your firm: it is not a genuine legal problem, the contact details do not work, or it is in the wrong area of law. The client is not notified.

Reporting is final. A reported enquiry cannot be accepted, rejected or reopened.

If the enquiry is genuine but your firm cannot take it on, reject it instead, so the client knows to look elsewhere.

Path parameters

Param	Type	Required	Description
`id`	`string`	Required	The `id` of the enquiry to report.

Body parameters

Field	Type	Required	Description
`reason`	`string`	Required	What is wrong with the enquiry. Use one of the report reasons. Cannot be empty.
`details`	`string`	Optional	More detail, in your own words. Stored with the enquiry for your firm’s records.

Report reasons

These are the reasons your dashboard offers, and it shows them by label. Any other text is accepted and shown as it is.

Value	Shown in your dashboard as	Use when
`invalid-enquiry`	Invalid client enquiry	The enquiry is illegible, untrue, or not about a legal problem.
`invalid-contact`	Invalid contact details	The email address or phone number is wrong or unreachable.
`mismatched-area`	Mismatched area of law	The enquiry does not match the area of law it was sent under.

Request

cURL

POST /api/v2/client-assist/{id}/report


curl --location 'https://www.reviewsolicitors.co.uk/api/v2/client-assist/{id}/report' \
     --header 'Authorization: Bearer {access_token}' \
     --header 'Content-Type: application/json' \
     --data   '{
          "reason": "invalid-contact",
          "details": "Phone number is not in service and the email bounced."
     }'

Response

200 OK


{
  "message": "Client assist enquiry reported"
}

The enquiry now shows status REPORTED, with reportedAt, reportReason and reportDetails set. See Retrieve an enquiry.

Errors

Code	Cause
400	`reason` is missing or empty, or the enquiry is already `REJECTED`, `REPORTED`, `COMPLETED` or `CLOSED`.
403	Client Assist is not active for your firm.
404	No Client Assist enquiry with that `id` belongs to your firm.

A missing reason returns a list of field errors:

400 Bad Request


[
  {
    "field": "reason",
    "error": ["A reason is required"]
  }
]