Synupv1
Créer une clé
v1Ressources/Invitations à laisser un avis/getLister les campagnes

Lister les campagnes

Liste les campagnes d'invitation à laisser un avis d'un établissement, les plus récentes en premier.

get/api/v1/review-invites/campaigns
review-invite:read
Paramètres de requête
locationIdstringobligatoire
L'établissement dont lister les campagnes. Obligatoire.
pageintegerfacultatif
Numéro de page, à partir de 0. Par défaut 0.
statusstring (all | draft | launched | stopped | archived)facultatif
Filtrer par statut. Par défaut all.
Réponse
dataobjectfacultatif
campaignsarray of unknownfacultatif
Les campagnes correspondantes.
totalnumberfacultatif
Nombre total de campagnes correspondant aux filtres.
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.
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/campaigns
Votre clé API
locationId *
page
status
{
  "data": {
    "rows": [
      {
        "id": "cm_campaign_1",
        "name": "Spring Checkup Follow-up",
        "type": "email_sms",
        "collectMode": "directory",
        "status": "draft",
        "archived": false,
        "locationLabel": "Acme Dental — Downtown · Austin",
        "emailsSent": 0,
        "smsSent": 0,
        "repliesCount": 0,
        "clickRate": null,
        "followUpSent": 0,
        "autoSend": true,
        "yelpCompliant": true,
        "staticUrl": null
      }
    ],
    "total": 1
  }
}