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

Ajouter des destinataires à une campagne

Ajoute un ou plusieurs destinataires à une campagne d'invitation à laisser un avis, dédupliqués au sein du lot lui-même et par rapport à tous ceux déjà sur la campagne. Attention — cela peut déclencher un envoi de message réel : si la campagne cible est déjà lancée avec l'envoi automatique activé, les destinataires nouvellement ajoutés sont mis en file et envoyés immédiatement, sur leur véritable adresse e-mail ou numéro de téléphone.

post/api/v1/review-invites
review-invite:write
Corps de la requête
campaignIdstringobligatoire
La campagne à laquelle ajouter des destinataires. Obligatoire.
recipientsarray of objectobligatoire
Les destinataires à ajouter. Obligatoire, non vide.
namestringfacultatif
Nom du destinataire.
emailstringfacultatif
Adresse e-mail du destinataire.
phonestringfacultatif
Numéro de téléphone du destinataire.
sourcestringfacultatif
D'où vient ce destinataire. Par défaut manual.
contactTypestring (Customer | Lead | Prospect | Contact)facultatif
L'une des valeurs : Customer, Lead, Prospect, Contact. Par défaut Customer.
channelstringfacultatif
Sur quel canal contacter ce destinataire (par ex. email, sms), ou à omettre pour utiliser le mix par défaut de la campagne.
smsConsentobjectfacultatif
Attestation de consentement SMS pour ce lot. Requise pour que tout destinataire du lot puisse être contacté par SMS — les lignes ajoutées sans cela sont ignorées pour l'envoi par SMS.
bystringfacultatif
Nom ou identifiant de la personne attestant que le consentement a été obtenu pour ce lot.
Réponse
dataobjectfacultatif
countnumberfacultatif
Nombre de destinataires réellement ajoutés.
duplicatesnumberfacultatif
Nombre de lignes du lot de la requête qui dupliquaient une autre ligne du même lot.
alreadyPresentnumberfacultatif
Nombre de lignes ignorées car cet e-mail ou ce téléphone était déjà sur cette campagne.
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.
post/api/v1/review-invites
Votre clé API
Corps de la requête*
{
  "data": {
    "count": 1,
    "duplicates": 0,
    "alreadyPresent": 0
  }
}