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

Exé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.

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