Synupv1
Schlüssel erstellen
v1Ressourcen/Review Invites/patchEine Kampagne aktualisieren

Eine 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.

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