Sign in

Create feedback review

POST https://{organization}.myguper.com/api/register/feedback/review

Records a customer review for a specific order. Exactly one review per order is allowed — a second POST for the same orderId returns 409.

The review carries a type discriminator that tells which scale the rating follows:

  • type: csat — rating from 1 to 5 (Customer Satisfaction)
  • type: nps — rating from 0 to 10 (Net Promoter Score)

comment is always required (free-form text, must not be empty after trim). categoryId is optional — supply it only if the organization has created the corresponding category beforehand. When omitted, the review is uncategorized.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Request body

Content-Type: application/json

{
    "personId": 12345,
    "orderId": "ORD-789",
    "type": "csat",
    "rating": 5,
    "comment": "Great delivery, on time and well packaged.",
    "categoryId": 1,                                            // optional
    "source": "journey",                                        // optional
    "data": "<data>"                                            // optional
}

Responses

{
    "id": 1,
    "personId": 12345,
    "orderId": "ORD-789",
    "type": "csat",
    "categoryId": 1,
    "rating": 5,
    "comment": "Great delivery, on time and well packaged.",
    "source": "journey",
    "data": null,
    "createdAt": "2026-05-14T11:00:00-03:00",
    "updatedAt": "2026-05-14T11:00:00-03:00"
}
Copied to clipboard