v1Recursos/Reviews/postEnviar respostas para aprovação do cliente

Enviar respostas para aprovação do cliente

Pede a usuários do portal do cliente que aprovem rascunhos de resposta, uma solicitação por avaliação. Cada item leva um reviewId e o texto da resposta; sem text, é usado o rascunho salvo da avaliação. O texto também é salvo como rascunho da avaliação. Cada pessoa em clientUserIds precisa ser um usuário ativo do portal do cliente da avaliação e conseguir ver o local da avaliação. As verificações de conteúdo rodam primeiro, e uma resposta sinalizada por elas não é enviada. Se a avaliação já tiver uma solicitação aberta, ela é atualizada: um texto novo vira uma nova versão sobre a qual o cliente é consultado de novo, e as pessoas novas são adicionadas. Cada avaliação dá certo ou falha por conta própria, então a chamada retorna 201 mesmo quando alguns itens falham; confira ok e code em cada resultado. Os usuários do cliente recebem um e-mail e uma notificação no app, e solicitações enviadas em sequência chegam a cada pessoa como uma única mensagem. Se o e-mail não puder ser enviado, a solicitação continua aguardando no portal.

post/api/v1/reviews/reply-approvals
reviews:write
Corpo da solicitação
itemsarray of objectobrigatório
As avaliações a enviar, de 1 a 200. Cada avaliação recebe sua própria solicitação.
reviewIdstringobrigatório
A avaliação que a resposta responde.
textstringopcional
A resposta a aprovar, até 4096 caracteres. Omita para usar o rascunho salvo da avaliação.
clientUserIdsarray of stringobrigatório
Os usuários do portal do cliente a consultar, de 1 a 50, da lista de usuários do portal do cliente. Cada um precisa conseguir ver o local da avaliação; caso contrário, essa avaliação falha com ineligible_assignee.
notestringopcional
Uma mensagem opcional para os usuários do cliente, até 2000 caracteres.
Resposta
dataobjectopcional
resultsarray of objectopcional
Um resultado por item. Avaliações não encontradas, ou de um cliente ao qual o token não tem acesso, aparecem no fim.
reviewIdstringopcional
A avaliação a que este resultado se refere.
okbooleanopcional
true quando a solicitação foi criada ou atualizada.
requestIdstringopcional
O ID da solicitação, quando ok é true.
errorstringopcional
Por que esta avaliação não foi enviada, quando ok é false.
codestring (not_found | not_respondable | no_draft | ineligible_assignee | content_checks)opcional
Por que falhou: not_found (a avaliação não existe, ou é de um cliente ao qual o token não tem acesso), not_respondable (não é possível responder à avaliação na Synup, ou ela já tem uma resposta publicada), no_draft (nenhum text foi enviado e a avaliação não tem rascunho salvo), ineligible_assignee (alguém em clientUserIds não consegue ver o local da avaliação) ou content_checks (as verificações de conteúdo sinalizaram a resposta; corrija e envie de novo).
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/reviews/reply-approvals
Sua chave de API
Corpo da solicitação*
{}

Guias que usam este recurso