Entrar

Criar avaliação

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

Registra uma avaliação de um cliente para um pedido específico. Apenas uma avaliação por pedido é permitida — um segundo POST para o mesmo orderId devolve 409.

A avaliação carrega um discriminador type que define qual escala o rating segue:

  • type: csat — nota de 1 a 5 (Customer Satisfaction)
  • type: nps — nota de 0 a 10 (Net Promoter Score)

comment é sempre obrigatório (texto livre, não pode ser vazio depois do trim). categoryId é opcional — envie apenas se a organização tiver criado a categoria correspondente antes. Quando omitido, a avaliação fica sem categoria.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

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

Cabeçalhos

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.

Corpo da requisição

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
}

Respostas

{
    "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