Synup
Créer une clé
v1Ressources/Reviews/postEnvoyer des réponses à la validation du client

Envoyer des réponses à la validation du client

Demande à des utilisateurs du portail client d’approuver des brouillons de réponse, une demande par avis. Chaque élément contient un reviewId et le texte de la réponse ; sans text, le brouillon enregistré de l’avis est utilisé. Le texte est aussi enregistré comme brouillon de l’avis. Chaque personne de clientUserIds doit être un utilisateur actif du portail du client de l’avis et pouvoir voir l’établissement de l’avis. Les vérifications de contenu passent d’abord, et une réponse qu’elles signalent n’est pas envoyée. Si l’avis a déjà une demande ouverte, elle est mise à jour : un nouveau texte devient une nouvelle version soumise à nouveau au client, et les nouvelles personnes y sont ajoutées. Chaque avis réussit ou échoue séparément, donc l’appel renvoie 201 même si certains éléments échouent ; vérifiez ok et code dans chaque résultat. Les utilisateurs clients reçoivent un e-mail et une notification dans l’application, et les demandes envoyées à peu d’intervalle arrivent à chaque personne en un seul message. Si l’e-mail ne peut pas être envoyé, la demande reste en attente dans leur portail.

post/api/v1/reviews/reply-approvals
reviews:write
Corps de la requête
itemsarray of objectobligatoire
Les avis à envoyer, de 1 à 200. Chaque avis reçoit sa propre demande.
reviewIdstringobligatoire
L’avis auquel la réponse répond.
textstringfacultatif
La réponse à approuver, 4096 caractères au maximum. Omettez-la pour utiliser le brouillon enregistré de l’avis.
clientUserIdsarray of stringobligatoire
Les utilisateurs du portail client à solliciter, de 1 à 50, issus de la liste des utilisateurs du portail du client. Chacun doit pouvoir voir l’établissement de l’avis, sinon cet avis échoue avec ineligible_assignee.
notestringfacultatif
Un message facultatif pour les utilisateurs clients, 2000 caractères au maximum.
Réponse
dataobjectfacultatif
resultsarray of objectfacultatif
Un résultat par élément. Les avis introuvables, ou appartenant à un client auquel le jeton n’a pas accès, figurent à la fin.
reviewIdstringfacultatif
L’avis concerné par ce résultat.
okbooleanfacultatif
true si la demande a été créée ou mise à jour.
requestIdstringfacultatif
L’identifiant de la demande, quand ok vaut true.
errorstringfacultatif
Pourquoi cet avis n’a pas été envoyé, quand ok vaut false.
codestring (not_found | not_respondable | no_draft | ineligible_assignee | content_checks)facultatif
La raison de l’échec : not_found (avis inexistant, ou appartenant à un client auquel le jeton n’a pas accès), not_respondable (impossible de répondre à l’avis dans Synup, ou il a déjà une réponse publiée), no_draft (aucun text envoyé et aucun brouillon enregistré pour l’avis), ineligible_assignee (une personne de clientUserIds ne voit pas l’établissement de l’avis) ou content_checks (les vérifications de contenu ont signalé la réponse ; corrigez-la et renvoyez-la).
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/reply-approvals
Votre clé API
Corps de la requête*
{}

Guides qui utilisent cette ressource