Synupv1
Créer une clé
v1Ressources/Invitations à laisser un avis/postMettre à jour un destinataire

Mettre à jour un destinataire

Corrige le nom, l'e-mail, le téléphone ou le type de contact d'un destinataire. L'e-mail et le téléphone sont figés une fois qu'un message a été envoyé à ce destinataire — modifier l'un ou l'autre après un envoi renvoie une erreur 409, puisque les accusés de réception et les réponses sont liés à l'adresse réellement utilisée.

post/api/v1/review-invites/update
review-invite:write
Corps de la requête
recipientIdstringobligatoire
Le destinataire à mettre à jour. Obligatoire.
namestringfacultatif
Nouveau nom.
emailstringfacultatif
Nouvelle adresse e-mail. Rejetée avec une erreur 409 si un message a déjà été envoyé à ce destinataire.
phonestringfacultatif
Nouveau numéro de téléphone. Rejeté avec une erreur 409 si un message a déjà été envoyé à ce destinataire.
contactTypestring (Customer | Lead | Prospect | Contact)facultatif
Nouveau type de contact : Customer, Lead, Prospect ou Contact.
Réponse
dataobjectfacultatif
idstringfacultatif
Identifiant unique du destinataire.
namestringfacultatif
Le nom du destinataire, ou vide si non fourni.
emailstringfacultatif
L'adresse e-mail du destinataire, ou vide si non fournie.
phonestringfacultatif
Le numéro de téléphone du destinataire, ou vide si non fourni.
contactTypestringfacultatif
L'une des valeurs : Customer, Lead, Prospect, Contact.
statusstringfacultatif
Statut de livraison actuel pour ce destinataire.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/review-invites/update
Votre clé API
Corps de la requête*
{
  "data": {
    "id": "cm_recip_1",
    "name": "Jordan Lee",
    "email": "jordan@example.com",
    "phone": null,
    "contactType": "Customer",
    "status": "pending"
  }
}