For Developers

Ticket rating

Your integration can pass on the customer’s rating of the support: from 1 to 5, with a comment. There is no separate endpoint to read it: the rating is in the rating field of any ticket object.

POST/api/v1/tickets/{ticket_id}/rate

Rate a ticket

body

{ "rating": 5, "comment": "Great!" }

Fields:

rating: an integer from 1 to 5, required; anything else gives 422
comment: a string, optional

A ticket in any status can be rated; a repeat call overwrites the rating and the comment. The response is the ticket object. REST API responses don’t include the comment: it’s visible in the dashboard, in the ticket.rated webhook and in the ticket.rated event from /updates.

curl

curl -X POST https://api.support.forestsnet.com/api/v1/tickets/TICKET_ID/rate \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{"rating": 5, "comment": "Great!"}'

Python SDK

client.tickets.rate("TICKET_ID", 5, comment="Great!")

Ratings customers leave themselves in the widget or in Telegram go into the same rating field.

Was this page helpful?