Synupv1
Créer une clé
v1Ressources/Invitations à laisser un avis/patchMettre à jour une campagne

Mettre à jour une campagne

Modifie la configuration d'une campagne. Ne transmettez que les champs à modifier. Pour changer le statut du cycle de vie (publish, stop, clone, archive, unarchive), utilisez l'endpoint d'action plutôt que de définir status directement ici.

patch/api/v1/review-invites/campaigns/{id}
review-invite:write
Paramètres de requête
idstringobligatoire
La campagne à mettre à jour. Obligatoire.
Corps de la requête
namestringfacultatif
Le nom d'affichage de la campagne.
locationIdstringfacultatif
L'établissement pour lequel cette campagne envoie des invitations. Obligatoire à la création.
campaignTypestringfacultatif
Le mix de canaux, par ex. email, sms, email_sms.
channelsstringfacultatif
Sur quels canaux la campagne envoie : EMAIL, SMS ou SMS_AND_EMAIL. Les exigences e-mail (adresse d'expédition, domaine d'envoi vérifié) ne s'appliquent que si EMAIL est inclus ; une campagne SMS uniquement nécessite à la place un numéro vérifié par l'opérateur pour son établissement.
fromEmailstringfacultatif
L'adresse e-mail d'expédition (« from »). Nécessite un domaine d'envoi vérifié pour envoyer réellement.
replyToEmailstringfacultatif
L'adresse e-mail de réponse.
emailSubjectstringfacultatif
L'objet de l'e-mail.
emailBodyobjectfacultatif
Le corps de l'e-mail, sous la forme du JSON de texte enrichi produit par l'éditeur du créateur de campagnes.
emailHtmlstringfacultatif
Version HTML de secours du corps de l'e-mail.
smsBodystringfacultatif
Le texte du message SMS.
smsReviewSitestringfacultatif
Vers quel site d'avis pointe le lien du SMS.
reviewSitesobjectfacultatif
Le ou les sites d'avis proposés aux clients satisfaits, dans le format JSON du créateur de campagnes.
screeningEnabledbooleanfacultatif
S'il faut filtrer les clients selon leur note en étoiles avant de les diriger vers un site d'avis public.
landingTitlestringfacultatif
Titre affiché sur la page d'atterrissage de la campagne.
landingContentstringfacultatif
Contenu affiché sur la page d'atterrissage de la campagne.
hideAddressbooleanfacultatif
Masquer l'adresse de l'établissement sur la page d'atterrissage.
hideBusinessNamebooleanfacultatif
Masquer le nom de l'établissement sur la page d'atterrissage.
hideImagebooleanfacultatif
Masquer l'image de l'établissement sur la page d'atterrissage.
followupsobjectfacultatif
Calendrier des rappels de relance, dans le format JSON du créateur de campagnes.
stopFollowupOnClickbooleanfacultatif
Arrêter les relances dès que le destinataire a cliqué sur le lien.
scheduleAtstringfacultatif
Date/heure ISO à laquelle programmer le lancement de la campagne. Laisser vide pour un envoi immédiat à la publication.
timezonestringfacultatif
Fuseau horaire IANA pour la planification, par ex. America/New_York.
autoSendbooleanfacultatif
Si les nouveaux destinataires sont contactés automatiquement une fois la campagne lancée.
staticUrlstringfacultatif
Un slug d'URL statique/QR de demande d'avis pour cette campagne, si utilisé à la place ou en complément de l'envoi par e-mail/SMS.
thankYouEnabledbooleanfacultatif
S'il faut afficher une relance de remerciement après un avis positif.
thankYouSubjectstringfacultatif
Objet de l'e-mail de remerciement.
thankYouBodystringfacultatif
Corps de l'e-mail de remerciement.
thankYouDelayHoursnumberfacultatif
Nombre d'heures à attendre avant d'envoyer la relance de remerciement.
funnelThresholdnumberfacultatif
Seuil de note en étoiles qui dirige un répondant vers le site d'avis public ou vers un retour privé.
funnelStyleobjectfacultatif
Style de présentation de l'entonnoir, dans le format JSON du créateur de campagnes.
lowRankContentstringfacultatif
Contenu affiché aux répondants notant en dessous de funnelThreshold.
hideFeedbackBoxbooleanfacultatif
Masquer le champ de retour en texte libre sur la page d'atterrissage.
collectModestringfacultatif
Comment le retour est collecté sur la page d'atterrissage.
ratingMechanismobjectfacultatif
La configuration du widget d'étoiles/de notation, dans le format JSON du créateur de campagnes.
askNamebooleanfacultatif
Demander son nom au répondant.
askFeedbackbooleanfacultatif
Demander au répondant un retour en texte libre.
Réponse
dataobjectfacultatif
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.
patch/api/v1/review-invites/campaigns/{id}
Votre clé API
id *
Corps de la requête
{
  "data": {
    "id": "cm_campaign_1",
    "agencyId": "cm_agency_1",
    "locationId": "cm_loc_1",
    "clientLocationId": "cm_loc_1",
    "name": "Spring Checkup Follow-up (updated)",
    "campaignType": "email_sms",
    "channels": "EMAIL",
    "status": "draft",
    "fromEmail": null,
    "replyToEmail": null,
    "emailSubject": "How was your visit?",
    "emailBody": null,
    "smsBody": null,
    "smsReviewSite": null,
    "reviewSites": null,
    "screeningEnabled": false,
    "landingTitle": null,
    "landingContent": null,
    "hideAddress": false,
    "hideBusinessName": false,
    "followups": null,
    "stopFollowupOnClick": false,
    "scheduleAt": null,
    "timezone": null,
    "autoSend": true,
    "staticUrl": null,
    "launchedAt": null,
    "emailHtml": null,
    "thankYouEnabled": false,
    "thankYouSubject": null,
    "thankYouBody": null,
    "thankYouDelayHours": 12,
    "funnelThreshold": 4,
    "funnelStyle": null,
    "lowRankContent": null,
    "hideFeedbackBox": false,
    "ratingMechanism": null,
    "askName": true,
    "askFeedback": true,
    "archivedAt": null,
    "hideImage": false,
    "clientId": "cm_client_1",
    "createdAt": "2026-01-20T09:00:00.000Z",
    "updatedAt": "2026-01-21T10:00:00.000Z",
    "createdByUserId": null,
    "createdByType": "user",
    "archived": false
  }
}