Synupv1
Schlüssel erstellen
v1Ressourcen/Review Invites

Review Invites

Suchen und Verwalten der Empfänger in Ihren Review-Invite-Kampagnen.

Sucht Empfänger nach Name, E-Mail-Adresse oder Telefonnummer über die Review-Invite-Kampagnen Ihrer Agentur hinweg.

Empfänger suchen

get/api/v1/review-invites
review-invite:read
Query-Parameter
querystringerforderlich
Suchtext, abgeglichen gegen Name, E-Mail-Adresse und Telefonnummer. Erforderlich.
limitintegeroptional
Maximale Anzahl zurückzugebender Ergebnisse, 1–100. Standardmäßig 25.
Antwort
dataobjectoptional
recipientsarray of objectoptional
Die passenden Empfänger.
idstringoptional
Eindeutige Kennung des Empfängers.
namestringoptional
Der Name des Empfängers, oder leer, falls nicht angegeben.
emailstringoptional
Die E-Mail-Adresse des Empfängers, oder leer, falls nicht angegeben.
phonestringoptional
Die Telefonnummer des Empfängers, oder leer, falls nicht angegeben.
sourcestringoptional
Woher dieser Empfänger stammt, z. B. manual, csv, crm.
contactTypestringoptional
Einer von: Customer, Lead, Prospect, Contact.
statusstringoptional
Aktueller Zustellstatus für diesen Empfänger.
campaignIdstringoptional
ID der Kampagne, zu der dieser Empfänger gehört.
campaignNamestringoptional
Name der Kampagne, zu der dieser Empfänger gehört.
locationIdstringoptional
ID des Standorts, für den die Kampagne gilt, oder null.
locationLabelstringoptional
Anzeigename dieses Standorts, oder leer, wenn er nicht aufgelöst werden kann.
alreadyMessagedbooleanoptional
Ob diesem Empfänger bereits eine Nachricht gesendet wurde. Sobald true, können E-Mail-Adresse und Telefonnummer nicht mehr geändert werden.
countnumberoptional
Gesamtzahl der zur Suche passenden Empfänger.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/review-invites
Ihr API-Schlüssel
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
  }
}
v1Ressourcen/Review Invites/postEmpfänger zu einer Kampagne hinzufügen

Fügt einer Review-Invite-Kampagne einen oder mehrere Empfänger hinzu, dedupliziert gegen die Charge selbst und gegen alle bereits auf der Kampagne vorhandenen Empfänger. Warnung — dies kann einen echten Nachrichtenversand auslösen: Ist die Zielkampagne bereits gestartet und die automatische Zustellung aktiv, werden die neu hinzugefügten Empfänger sofort in die Warteschlange eingereiht und an ihre echte E-Mail-Adresse oder Telefonnummer gesendet.

Empfänger zu einer Kampagne hinzufügen

post/api/v1/review-invites
review-invite:write
Anfragetext
campaignIdstringerforderlich
Die Kampagne, zu der Empfänger hinzugefügt werden sollen. Erforderlich.
recipientsarray of objecterforderlich
Die hinzuzufügenden Empfänger. Erforderlich, nicht leer.
namestringoptional
Name des Empfängers.
emailstringoptional
E-Mail-Adresse des Empfängers.
phonestringoptional
Telefonnummer des Empfängers.
sourcestringoptional
Woher dieser Empfänger stammt. Standardmäßig manual.
contactTypestring (Customer | Lead | Prospect | Contact)optional
Einer von: Customer, Lead, Prospect, Contact. Standardmäßig Customer.
channelstringoptional
Über welchen Kanal dieser Empfänger kontaktiert werden soll (z. B. email, sms), oder weglassen, um den Standard-Kanalmix der Kampagne zu verwenden.
smsConsentobjectoptional
SMS-Einwilligungsbestätigung für diese Charge. Erforderlich, damit ein Empfänger in der Charge per SMS kontaktiert werden kann — Zeilen, die ohne diese Angabe hinzugefügt werden, werden beim SMS-Versand übersprungen.
bystringoptional
Name oder Kennung der Person, die bestätigt, dass für diese Charge eine Einwilligung eingeholt wurde.
Antwort
dataobjectoptional
countnumberoptional
Anzahl der tatsächlich hinzugefügten Empfänger.
duplicatesnumberoptional
Anzahl der Zeilen innerhalb der Anfrage-Charge selbst, die eine andere Zeile in derselben Charge duplizierten.
alreadyPresentnumberoptional
Anzahl der Zeilen, die übersprungen wurden, weil diese E-Mail-Adresse oder Telefonnummer bereits auf dieser Kampagne vorhanden war.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/review-invites
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "count": 1,
    "duplicates": 0,
    "alreadyPresent": 0
  }
}
v1Ressourcen/Review Invites/postEmpfänger aktualisieren

Korrigiert Name, E-Mail-Adresse, Telefonnummer oder Kontakttyp eines Empfängers. E-Mail-Adresse und Telefonnummer werden eingefroren, sobald eine Nachricht an diesen Empfänger gesendet wurde — eine Änderung nach einem Versand liefert einen 409, da Zustellbestätigungen und Antworten an die tatsächlich verwendete Adresse gebunden sind.

Empfänger aktualisieren

post/api/v1/review-invites/update
review-invite:write
Anfragetext
recipientIdstringerforderlich
Der zu aktualisierende Empfänger. Erforderlich.
namestringoptional
Neuer Name.
emailstringoptional
Neue E-Mail-Adresse. Wird mit einem 409 abgelehnt, wenn diesem Empfänger bereits eine Nachricht gesendet wurde.
phonestringoptional
Neue Telefonnummer. Wird mit einem 409 abgelehnt, wenn diesem Empfänger bereits eine Nachricht gesendet wurde.
contactTypestring (Customer | Lead | Prospect | Contact)optional
Neuer Kontakttyp: Customer, Lead, Prospect oder Contact.
Antwort
dataobjectoptional
idstringoptional
Eindeutige Kennung des Empfängers.
namestringoptional
Der Name des Empfängers, oder leer, falls nicht angegeben.
emailstringoptional
Die E-Mail-Adresse des Empfängers, oder leer, falls nicht angegeben.
phonestringoptional
Die Telefonnummer des Empfängers, oder leer, falls nicht angegeben.
contactTypestringoptional
Einer von: Customer, Lead, Prospect, Contact.
statusstringoptional
Aktueller Zustellstatus für diesen Empfänger.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/review-invites/update
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "id": "cm_recip_1",
    "name": "Jordan Lee",
    "email": "jordan@example.com",
    "phone": null,
    "contactType": "Customer",
    "status": "pending"
  }
}
v1Ressourcen/Review Invites/getKampagnen auflisten

Listet die Review-Invite-Kampagnen eines Standorts auf, neueste zuerst.

Kampagnen auflisten

get/api/v1/review-invites/campaigns
review-invite:read
Query-Parameter
locationIdstringerforderlich
Der Standort, dessen Kampagnen aufgelistet werden. Erforderlich.
pageintegeroptional
Nullbasierte Seitenzahl. Standardmäßig 0.
statusstring (all | draft | launched | stopped | archived)optional
Nach Status filtern. Standardmäßig all.
Antwort
dataobjectoptional
campaignsarray of unknownoptional
Die passenden Kampagnen.
totalnumberoptional
Gesamtzahl der zu den Filtern passenden Kampagnen.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/review-invites/campaigns
Ihr API-Schlüssel
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
  }
}
v1Ressourcen/Review Invites/postEine Kampagne erstellen

Erstellt eine neue Review-Invite-Kampagne als Entwurf. locationId ist erforderlich; alles Weitere kann jetzt oder später über den Update-Endpunkt gesetzt werden. Verwenden Sie den Aktions-Endpunkt, um sie nach der Konfiguration zu veröffentlichen — dies allein versendet nichts.

Eine Kampagne erstellen

post/api/v1/review-invites/campaigns
review-invite:write
Antwort
dataobjectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/review-invites/campaigns
Ihr API-Schlüssel
{
  "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
  }
}
v1Ressourcen/Review Invites/getEine Kampagne abrufen

Gibt eine einzelne Kampagne anhand ihrer ID zurück.

Eine Kampagne abrufen

get/api/v1/review-invites/campaigns/{id}
review-invite:read
Query-Parameter
idstringerforderlich
Die ID der Kampagne. Erforderlich.
Antwort
dataobjectoptional
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/review-invites/campaigns/{id}
Ihr API-Schlüssel
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
  }
}
v1Ressourcen/Review Invites/patchEine Kampagne aktualisieren

Bearbeitet die Konfiguration einer Kampagne. Übergeben Sie nur die Felder, die geändert werden sollen. Um den Lebenszyklusstatus zu ändern (publish, stop, clone, archive, unarchive), verwenden Sie den Aktions-Endpunkt statt status hier direkt zu setzen.

Eine Kampagne aktualisieren

patch/api/v1/review-invites/campaigns/{id}
review-invite:write
Query-Parameter
idstringerforderlich
Die zu aktualisierende Kampagne. Erforderlich.
Anfragetext
namestringoptional
Der Anzeigename der Kampagne.
locationIdstringoptional
Der Standort, für den diese Kampagne Einladungen versendet. Bei der Erstellung erforderlich.
campaignTypestringoptional
Der Kanal-Mix, z. B. email, sms, email_sms.
channelsstringoptional
Über welche Kanäle die Kampagne versendet: EMAIL, SMS oder SMS_AND_EMAIL. E-Mail-Anforderungen (Absenderadresse, verifizierte Absenderdomain) gelten nur, wenn EMAIL enthalten ist; eine reine SMS-Kampagne benötigt stattdessen eine carrier-verifizierte Nummer für ihren Standort.
fromEmailstringoptional
Die versendende "Von"-E-Mail-Adresse. Erfordert eine verifizierte Absenderdomain, um tatsächlich zu versenden.
replyToEmailstringoptional
Die Antwort-an-E-Mail-Adresse.
emailSubjectstringoptional
Die Betreffzeile der E-Mail.
emailBodyobjectoptional
Der E-Mail-Text, als das Rich-Text-JSON-Format, das der Editor des Kampagnen-Builders erzeugt.
emailHtmlstringoptional
Gerendertes HTML-Fallback des E-Mail-Textes.
smsBodystringoptional
Der SMS-Nachrichtentext.
smsReviewSitestringoptional
Auf welche Bewertungsseite der SMS-Link verweist.
reviewSitesobjectoptional
Die Bewertungsseite(n), die zufriedenen Kunden angeboten werden, als das JSON-Format des Builders.
screeningEnabledbooleanoptional
Ob Kunden anhand der Sternebewertung gefiltert werden sollen, bevor sie zu einer öffentlichen Bewertungsseite geleitet werden.
landingTitlestringoptional
Titel, der auf der Landingpage der Kampagne angezeigt wird.
landingContentstringoptional
Textinhalt, der auf der Landingpage der Kampagne angezeigt wird.
hideAddressbooleanoptional
Die Geschäftsadresse auf der Landingpage ausblenden.
hideBusinessNamebooleanoptional
Den Geschäftsnamen auf der Landingpage ausblenden.
hideImagebooleanoptional
Das Geschäftsbild auf der Landingpage ausblenden.
followupsobjectoptional
Der Follow-up-Erinnerungsplan, als das JSON-Format des Builders.
stopFollowupOnClickbooleanoptional
Follow-ups stoppen, sobald der Empfänger auf den Link geklickt hat.
scheduleAtstringoptional
ISO-Datum/Uhrzeit, für die der Kampagnenstart geplant werden soll. Leer lassen, um sofort bei publish zu versenden.
timezonestringoptional
IANA-Zeitzone für die Planung, z. B. America/New_York.
autoSendbooleanoptional
Ob neue Empfänger automatisch angeschrieben werden, sobald die Kampagne gestartet ist.
staticUrlstringoptional
Ein statischer QR-/Bewertungsanfrage-URL-Slug für diese Kampagne, falls anstelle von oder zusätzlich zu E-Mail/SMS-Versand verwendet.
thankYouEnabledbooleanoptional
Ob nach einer positiven Bewertung ein Dankes-Follow-up gezeigt werden soll.
thankYouSubjectstringoptional
Betreff der Dankes-E-Mail.
thankYouBodystringoptional
Text der Dankes-E-Mail.
thankYouDelayHoursnumberoptional
Wartezeit in Stunden, bevor das Dankes-Follow-up gesendet wird.
funnelThresholdnumberoptional
Sternebewertungs-Schwellenwert, der einen Antwortenden zur öffentlichen Bewertungsseite oder zu privatem Feedback leitet.
funnelStyleobjectoptional
Darstellungsstil des Funnels, als das JSON-Format des Builders.
lowRankContentstringoptional
Inhalt, der Antwortenden gezeigt wird, die unterhalb von funnelThreshold bewerten.
hideFeedbackBoxbooleanoptional
Das Freitext-Feedback-Feld auf der Landingpage ausblenden.
collectModestringoptional
Wie Feedback auf der Landingpage erfasst wird.
ratingMechanismobjectoptional
Die Konfiguration des Sterne-/Bewertungswidgets, als das JSON-Format des Builders.
askNamebooleanoptional
Den Antwortenden nach seinem Namen fragen.
askFeedbackbooleanoptional
Den Antwortenden um Freitext-Feedback bitten.
Antwort
dataobjectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/review-invites/campaigns/{id}
Ihr API-Schlüssel
id *
Anfragetext
{
  "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
  }
}
v1Ressourcen/Review Invites/postEine Kampagnen-Lebenszyklusaktion ausführen

Führt eine Lebenszyklusaktion für eine Kampagne aus. publish startet sie — ist autoSend aktiviert, werden sofort echte E-Mails oder SMS versendet, und dies ist pro Kanal abgesichert: Eine Kampagne mit EMAIL benötigt eine verifizierte Absenderdomain für den Kunden, eine mit SMS benötigt eine carrier-verifizierte Nummer für den Standort. Schlägt eine dieser Voraussetzungen fehl, wird ein erklärender 422 zurückgegeben — das Bereitstellen einer Domain oder Telefonnummer ist ein reiner UI-Schritt, den diese API nicht für Sie erledigen kann. stop hält eine aktive Kampagne an. clone dupliziert sie als neuen Entwurf. autoSend schaltet den automatischen Versand für neue Empfänger ein oder aus — übergeben Sie on. archive archiviert eine gestoppte Kampagne; bei einer noch aktiven ist dies ein No-op, kein Fehler — die Antwort ist {id, skipped: true} statt der vollständigen Kampagne, prüfen Sie also skipped, statt anzunehmen, dass data immer eine Campaign ist. unarchive stellt eine archivierte Kampagne wieder her.

Eine Kampagnen-Lebenszyklusaktion ausführen

post/api/v1/review-invites/campaigns/{id}/action
review-invite:write
Query-Parameter
idstringerforderlich
Die Kampagne, auf die die Aktion angewendet wird. Erforderlich.
Anfragetext
opstring (publish | stop | clone | autoSend | archive | unarchive)erforderlich
apiDocs.resources.review-invites.action.paramsOp
onbooleanoptional
apiDocs.resources.review-invites.action.paramsOn
Antwort
dataobjectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/review-invites/campaigns/{id}/action
Ihr API-Schlüssel
id *
Anfragetext*
{
  "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
  }
}
v1Ressourcen/Review Invites/getNachrichtenvorlagen auflisten

Listet die gespeicherten Review-Invite-Nachrichtenvorlagen der Agentur auf — wiederverwendbare E-Mail-/SMS-Inhalte für Kampagnen.

Nachrichtenvorlagen auflisten

get/api/v1/review-invites/templates
review-invite:read
Antwort
dataarray of unknownoptional
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/review-invites/templates
Ihr API-Schlüssel
{
  "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"
    }
  ]
}
v1Ressourcen/Review Invites/postEine Nachrichtenvorlage erstellen

Erstellt eine wiederverwendbare Review-Invite-Nachrichtenvorlage. content ist das Rich-Text-JSON-Format, das der Editor des Kampagnen-Builders erzeugt.

Eine Nachrichtenvorlage erstellen

post/api/v1/review-invites/templates
review-invite:write
Antwort
dataobjectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/review-invites/templates
Ihr API-Schlüssel
{
  "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"
  }
}
v1Ressourcen/Review Invites/patchEine Nachrichtenvorlage aktualisieren

Bearbeitet eine Vorlage. Übergeben Sie nur die Felder, die geändert werden sollen.

Eine Nachrichtenvorlage aktualisieren

patch/api/v1/review-invites/templates/{id}
review-invite:write
Query-Parameter
idstringerforderlich
Die zu aktualisierende Vorlage. Erforderlich.
Anfragetext
namestringoptional
Der Anzeigename der Vorlage.
descriptionstringoptional
Eine kurze Beschreibung, wann diese Vorlage verwendet werden sollte.
contentobjectoptional
Der Vorlageninhalt, als das Rich-Text-JSON-Format des Builders.
assignedLocationIdsarray of stringoptional
Standort-IDs, für die diese Vorlage vorgeschlagen wird. Weglassen, um sie agenturweit verfügbar zu machen.
Antwort
dataobjectoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/review-invites/templates/{id}
Ihr API-Schlüssel
id *
Anfragetext
{
  "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"
  }
}
v1Ressourcen/Review Invites/deleteEine Nachrichtenvorlage löschen

Löscht eine Vorlage endgültig. Dies wirkt sich nicht auf Kampagnen aus, die deren Inhalt bereits verwenden — es entfernt nur die wiederverwendbare Vorlage.

Eine Nachrichtenvorlage löschen

delete/api/v1/review-invites/templates/{id}
review-invite:write
Query-Parameter
idstringerforderlich
Die zu löschende Vorlage. Erforderlich.
Antwort
dataobjectoptional
deletedbooleanoptional
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/review-invites/templates/{id}
Ihr API-Schlüssel
id *
{
  "data": {
    "ok": true
  }
}