v1Ressourcen/Review Invites/postEine Kampagnen-Lebenszyklusaktion ausführen

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

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

review-invite:write

Query-Parameter

idstringerforderlich

Die Kampagne, auf die die Aktion angewendet wird. Erforderlich.

Anfragetext

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