Reviews
BlueSuite MCP tools for reviews
See connection and authentication and workflow rules before calling these tools.
Related REST API and behavior.
request_review
Ask a client to leave a review. Sends immediately over whichever channels the workspace has turned on (email, SMS) and the client can actually receive. Confirm with the user before calling, this puts a message in front of their customer. Mention the appointment with event_id when the request is about one specific visit: it switches to a message that names the visit and the crew who attended, which lands far better than a generic ask. BlueSuite also asks automatically after jobs complete or invoices are paid if the workspace set that up, so check whether a recent request already went out before adding another.
Parameters
| Field | Type / accepted values | Required | Details |
|---|---|---|---|
contact_id | integer | Yes | Client to ask. Use list_contacts to resolve a name first. They need an email address, or a mobile number with SMS consent. |
event_id | JSON value | No | The appointment this is about. Including it uses the message that names the visit and the crew. |
invoice_id | JSON value | No | The invoice this is about, when the ask follows a payment. |
ignore_cooldown | boolean | No | Ask even if this client was asked recently or has already left a review. Off by default, and the workspace cooldown normally applies. Only set this when the user has said to ask anyway. |
Result
| Field | Type / accepted values | Required | Details |
|---|---|---|---|
data | object or null | Yes | The affected record, or the result of the operation. Null when nothing matched. |
list_review_requests
Review requests that have gone out and what came back, star rating, written feedback, and whether the client clicked through to a review platform. Use this to answer how the reviews are going, and to check whether a client has been asked recently before asking again.
Parameters
| Field | Type / accepted values | Required | Details |
|---|---|---|---|
contact_id | integer | No | Only requests sent to this client. |
status | "pending", "completed", "expired" | No | pending (sent, no response yet), completed (the client responded), or expired (the link lapsed). |
page | integer | No | Page number (default: 1) |
per_page | JSON value | No | Results per page (default: 25) |
Result
| Field | Type / accepted values | Required | Details |
|---|---|---|---|
data | array of object | Yes | The matching records for this page. |
pagination | object | No | How many more pages of results exist. Absent when the API returned an unpaged result. |
pagination.page | integer | When parent supplied | Current page number, 1-based. |
pagination.per_page | integer | When parent supplied | Number of results per page. |
pagination.total_pages | integer | When parent supplied | Total number of pages available. |
The downloadable tool schemas include the full input and output contracts. Tables describe schema-level required fields; cross-field rules still apply.