v1Recursos/Review Invites/postEjecutar una acción del ciclo de vida de la campaña

Ejecutar una acción del ciclo de vida de la campaña

Ejecuta una acción del ciclo de vida sobre una campaña. publish la lanza — si autoSend está activado, esto empieza a enviar correos o SMS reales de inmediato, y está condicionado por canal: una campaña que incluya EMAIL necesita un dominio de envío verificado para el cliente, y una que incluya SMS necesita un número verificado por el operador para la ubicación. Si alguna de estas condiciones falla, se devuelve un 422 explicativo; aprovisionar un dominio o un número de teléfono es un paso solo disponible en la interfaz, no algo que esta API pueda hacer por usted. stop detiene una campaña activa. clone la duplica como un nuevo borrador. autoSend activa o desactiva el envío automático para los nuevos destinatarios — indique on. archive archiva una campaña detenida; en una que sigue activa esto es un no-op, no un error — la respuesta es {id, skipped: true} en lugar de la campaña completa, así que compruebe skipped en vez de asumir que data siempre es una Campaign. unarchive restaura una campaña archivada.

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

review-invite:write

Parámetros de consulta

idstringobligatorio

La campaña sobre la que actuar. Obligatorio.

Cuerpo de la solicitud

apiDocs.resources.review-invites.action.paramsOp

onbooleanopcional

apiDocs.resources.review-invites.action.paramsOn

Respuesta

dataobjectopcional

Errores

400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.

401La clave de API falta, es inválida, expiró o fue revocada.

403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.

404El recurso no se encontró, o no pertenece a su agencia.

422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.

429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.

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

Su clave de API

id *

Cuerpo de la solicitud*

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