Skip to main content

POST Enviar Link de Avaliação do Google

Envia ao paciente da avaliação, pelo WhatsApp, o link para ele avaliar a clínica no Google. O envio é feito uma única vez por paciente: se o link já foi enviado, a rota recusa.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão read_reports.

Efeito externo

Dispara uma mensagem real de WhatsApp para o telefone do cadastro do paciente (número sem o prefixo 55 recebe o prefixo automaticamente).


Endpoint​

POST https://api-dev.imagemais.com.br/api/avaliacao/{id}/google-review

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idnumber✅ID da avaliação (não do paciente)

Requisição​

curl -X 'POST' \
'https://api-dev.imagemais.com.br/api/avaliacao/1/google-review' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

201 Sucesso​

{
"success": true
}

400 Requisição inválida​

O link já foi enviado a este paciente (ou id não é numérico, com Validation failed (numeric string is expected)).

{
"message": "O link do Google já foi enviado para este paciente.",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

404 Não encontrado​

{
"message": "Avaliação não encontrada.",
"error": "Not Found",
"statusCode": 404
}

502 Falha no WhatsApp​

{
"message": "Não foi possível enviar a mensagem pelo WhatsApp.",
"error": "Bad Gateway",
"statusCode": 502
}