v1Ressources/Invitations à laisser un avis

Invitations à laisser un avis

Recherchez et gérez les destinataires de vos campagnes d'invitation à laisser un avis.

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

Rechercher des destinataires

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
  }
}

v1Ressources/Invitations à laisser un avis/postAjouter 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.

Ajouter des destinataires à une campagne

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
  }
}

v1Ressources/Invitations à laisser un avis/postMettre à 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.

Mettre à jour un destinataire

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"
  }
}

v1Ressources/Invitations à laisser un avis/getLister les campagnes

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

Lister les campagnes

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
  }
}

v1Ressources/Invitations à laisser un avis/postCréer une campagne

Crée une nouvelle campagne d'invitation à laisser un avis à l'état de brouillon. locationId est obligatoire ; le reste peut être défini maintenant ou plus tard via l'endpoint de mise à jour. Utilisez l'endpoint d'action pour la publier une fois configurée — ceci seul n'envoie rien.

Créer une campagne

post/api/v1/review-invites/campaigns

review-invite:write

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.

post/api/v1/review-invites/campaigns

Votre clé API

{
  "data": {
    "id": "cm_campaign_1",
    "agencyId": "cm_agency_1",
    "locationId": "cm_loc_1",
    "clientLocationId": "cm_loc_1",
    "name": "Spring Checkup Follow-up",
    "campaignType": "email_sms",
    "channels": "EMAIL",
    "status": "draft",
    "fromEmail": null,
    "replyToEmail": null,
    "emailSubject": null,
    "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-20T09:00:00.000Z",
    "createdByUserId": null,
    "createdByType": "user",
    "archived": false
  }
}

v1Ressources/Invitations à laisser un avis/getRécupérer une campagne

Renvoie une campagne unique par son id.

Récupérer une campagne

get/api/v1/review-invites/campaigns/{id}

review-invite:read

Paramètres de requête

idstringobligatoire

L'id de la campagne. Obligatoire.

Réponse

dataobjectfacultatif

Erreurs

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/{id}

Votre clé API

id *

{
  "data": {
    "id": "cm_campaign_1",
    "agencyId": "cm_agency_1",
    "locationId": "cm_loc_1",
    "clientLocationId": "cm_loc_1",
    "name": "Spring Checkup Follow-up",
    "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-20T09:00:00.000Z",
    "createdByUserId": null,
    "createdByType": "user",
    "archived": false
  }
}

v1Ressources/Invitations à laisser un avis/patchMettre à 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.

Mettre à jour une campagne

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
  }
}

v1Ressources/Invitations à laisser un avis/postExécuter une action de cycle de vie sur une campagne

Exécute une action de cycle de vie sur une campagne. publish la lance — si autoSend est activé, cela déclenche immédiatement l'envoi de vrais e-mails ou SMS, et c'est conditionné par canal : une campagne incluant EMAIL nécessite un domaine d'envoi vérifié pour le client, et une incluant SMS nécessite un numéro vérifié par l'opérateur pour l'établissement. Si l'une de ces conditions échoue, une erreur 422 explicative est renvoyée ; le provisionnement d'un domaine ou d'un numéro de téléphone est une étape réservée à l'interface, pas quelque chose que cette API peut faire à votre place. stop arrête une campagne active. clone la duplique en un nouveau brouillon. autoSend active ou désactive l'envoi automatique pour les nouveaux destinataires — transmettez on. archive archive une campagne arrêtée ; sur une campagne encore active, c'est un no-op, pas une erreur — la réponse est {id, skipped: true} au lieu de la campagne complète, donc vérifiez skipped plutôt que de supposer que data est toujours une Campaign. unarchive restaure une campagne archivée.

Exécuter une action de cycle de vie sur une campagne

post/api/v1/review-invites/campaigns/{id}/action

review-invite:write

Paramètres de requête

idstringobligatoire

La campagne sur laquelle agir. Obligatoire.

Corps de la requête

apiDocs.resources.review-invites.action.paramsOp

onbooleanfacultatif

apiDocs.resources.review-invites.action.paramsOn

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.

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/campaigns/{id}/action

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 (copy)",
    "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": false,
    "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-21T10:05:00.000Z",
    "updatedAt": "2026-01-21T10:05:00.000Z",
    "createdByUserId": null,
    "createdByType": "user",
    "archived": false
  }
}

v1Ressources/Invitations à laisser un avis/getLister les modèles de messages

Liste les modèles de messages d'invitation à laisser un avis enregistrés par l'agence — du contenu e-mail/SMS réutilisable pour les campagnes.

Lister les modèles de messages

get/api/v1/review-invites/templates

review-invite:read

Réponse

dataarray of unknownfacultatif

Erreurs

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/templates

Votre clé API

{
  "data": [
    {
      "id": "cm_tmpl_1",
      "name": "Standard follow-up",
      "description": "Default post-visit email template",
      "content": null,
      "assignedLocationIds": [],
      "createdAt": "2026-01-15T09:00:00.000Z"
    }
  ]
}

v1Ressources/Invitations à laisser un avis/postCréer un modèle de message

Crée un modèle de message d'invitation à laisser un avis réutilisable. content est le format JSON de texte enrichi produit par l'éditeur du créateur de campagnes.

Créer un modèle de message

post/api/v1/review-invites/templates

review-invite:write

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.

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/templates

Votre clé API

{
  "data": {
    "id": "cm_tmpl_1",
    "agencyId": "cm_agency_1",
    "name": "Standard follow-up",
    "description": "Default post-visit email template",
    "content": null,
    "assignedLocationIds": [],
    "createdAt": "2026-01-15T09:00:00.000Z",
    "updatedAt": "2026-01-15T09:00:00.000Z"
  }
}

v1Ressources/Invitations à laisser un avis/patchMettre à jour un modèle de message

Modifie un modèle. Ne transmettez que les champs à modifier.

Mettre à jour un modèle de message

patch/api/v1/review-invites/templates/{id}

review-invite:write

Paramètres de requête

idstringobligatoire

Le modèle à mettre à jour. Obligatoire.

Corps de la requête

namestringfacultatif

Le nom d'affichage du modèle.

descriptionstringfacultatif

Une brève description de quand utiliser ce modèle.

contentobjectfacultatif

Le contenu du modèle, dans le format JSON de texte enrichi du créateur de campagnes.

assignedLocationIdsarray of stringfacultatif

Ids d'établissement pour lesquels ce modèle est suggéré. À omettre pour le rendre disponible dans toute l'agence.

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/templates/{id}

Votre clé API

id *

Corps de la requête

{
  "data": {
    "id": "cm_tmpl_1",
    "agencyId": "cm_agency_1",
    "name": "Standard follow-up",
    "description": "Default post-visit email template (updated)",
    "content": null,
    "assignedLocationIds": [
      "cm_loc_1"
    ],
    "createdAt": "2026-01-15T09:00:00.000Z",
    "updatedAt": "2026-01-16T09:00:00.000Z"
  }
}

v1Ressources/Invitations à laisser un avis/deleteSupprimer un modèle de message

Supprime définitivement un modèle. Cela n'affecte pas les campagnes utilisant déjà son contenu — cela ne fait que retirer le modèle réutilisable.

Supprimer un modèle de message

delete/api/v1/review-invites/templates/{id}

review-invite:write

Paramètres de requête

idstringobligatoire

Le modèle à supprimer. Obligatoire.

Réponse

dataobjectfacultatif

deletedbooleanfacultatif

Erreurs

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.

delete/api/v1/review-invites/templates/{id}

Votre clé API

id *

{
  "data": {
    "ok": true
  }
}