Synupv1
Créer une clé
v1Ressources/Invitations à laisser un avis/getRechercher des destinataires

Rechercher des destinataires

Recherche des destinataires par nom, e-mail ou téléphone sur les campagnes d'invitation à laisser un avis de votre agence.

get/api/v1/review-invites
review-invite:read
Paramètres de requête
querystringobligatoire
Texte de recherche, comparé au nom, à l'e-mail et au téléphone. Obligatoire.
limitintegerfacultatif
Nombre maximal de résultats à renvoyer, de 1 à 100. Par défaut 25.
Réponse
dataobjectfacultatif
recipientsarray of objectfacultatif
Les destinataires correspondants.
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.
sourcestringfacultatif
D'où vient ce destinataire, par ex. manual, csv, crm.
contactTypestringfacultatif
L'une des valeurs : Customer, Lead, Prospect, Contact.
statusstringfacultatif
Statut de livraison actuel pour ce destinataire.
campaignIdstringfacultatif
ID de la campagne à laquelle appartient ce destinataire.
campaignNamestringfacultatif
Nom de la campagne à laquelle appartient ce destinataire.
locationIdstringfacultatif
ID de l'établissement concerné par la campagne, ou null.
locationLabelstringfacultatif
Nom d'affichage de cet établissement, ou vide quand il ne peut pas être résolu.
alreadyMessagedbooleanfacultatif
Si un message a déjà été envoyé à ce destinataire. Une fois true, son e-mail et son téléphone ne peuvent plus être modifiés.
countnumberfacultatif
Nombre total de destinataires correspondant à la recherche.
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.
get/api/v1/review-invites
Votre clé API
query *
limit
{
  "data": {
    "recipients": [
      {
        "id": "cm_recip_1",
        "name": "Jordan Lee",
        "email": "jordan@example.com",
        "phone": "",
        "source": "manual",
        "contactType": "Customer",
        "status": "pending",
        "campaignId": "cm_campaign_1",
        "campaignName": "Spring Checkup Follow-up",
        "locationId": "cm_loc_1",
        "locationLabel": "Acme Dental — Downtown · Austin",
        "alreadyMessaged": false
      }
    ],
    "count": 1
  }
}