v1Recursos/Review Invites/patchActualizar una campaña
Actualizar una campaña
Edita la configuración de una campaña. Indique solo los campos que desea cambiar. Para cambiar el estado del ciclo de vida (publish, stop, clone, archive, unarchive) use el endpoint de acción en lugar de establecer status directamente aquí.
patch
review-invite:write/api/v1/review-invites/campaigns/{id}Parámetros de consulta
idstringobligatorio
La campaña a actualizar. Obligatorio.
Cuerpo de la solicitud
namestringopcional
El nombre visible de la campaña.
locationIdstringopcional
La ubicación para la que esta campaña envía invitaciones. Obligatorio al crear.
campaignTypestringopcional
La combinación de canales, p. ej. email, sms, email_sms.
channelsstringopcional
Por qué canales envía la campaña: EMAIL, SMS o SMS_AND_EMAIL. Los requisitos de correo electrónico (dirección de origen, dominio de envío verificado) solo aplican cuando se incluye EMAIL; una campaña solo de SMS necesita en su lugar un número verificado por el operador para su ubicación.
fromEmailstringopcional
La dirección de correo electrónico "de" con la que se envía. Requiere un dominio de envío verificado para poder enviar realmente.
replyToEmailstringopcional
La dirección de correo electrónico de respuesta.
emailSubjectstringopcional
El asunto del correo electrónico.
emailBodyobjectopcional
El cuerpo del correo electrónico, como el JSON de texto enriquecido que produce el editor del creador de campañas.
emailHtmlstringopcional
Alternativa HTML renderizada del cuerpo del correo electrónico.
smsBodystringopcional
El texto del mensaje SMS.
smsReviewSitestringopcional
A qué sitio de reseñas apunta el enlace del SMS.
reviewSitesobjectopcional
El o los sitios de reseñas ofrecidos a los clientes satisfechos, en el formato JSON del creador de campañas.
screeningEnabledbooleanopcional
Si se debe filtrar a los clientes por calificación en estrellas antes de dirigirlos a un sitio de reseñas público.
landingTitlestringopcional
Título mostrado en la página de destino de la campaña.
landingContentstringopcional
Contenido del cuerpo mostrado en la página de destino de la campaña.
hideAddressbooleanopcional
Ocultar la dirección del negocio en la página de destino.
hideBusinessNamebooleanopcional
Ocultar el nombre del negocio en la página de destino.
hideImagebooleanopcional
Ocultar la imagen del negocio en la página de destino.
followupsobjectopcional
Calendario de recordatorios de seguimiento, en el formato JSON del creador de campañas.
stopFollowupOnClickbooleanopcional
Dejar de enviar seguimientos en cuanto el destinatario haga clic en el enlace.
scheduleAtstringopcional
Fecha y hora ISO para la que se debe programar el lanzamiento de la campaña. Déjelo vacío para enviar de inmediato al publicar.
timezonestringopcional
Zona horaria IANA para la programación, p. ej. America/New_York.
autoSendbooleanopcional
Si los nuevos destinatarios reciben el envío automáticamente una vez que la campaña está lanzada.
staticUrlstringopcional
Un slug de URL estático/QR de solicitud de reseña para esta campaña, si se usa en lugar de o junto con el envío por correo electrónico/SMS.
thankYouEnabledbooleanopcional
Si se debe mostrar un seguimiento de agradecimiento después de una reseña positiva.
thankYouSubjectstringopcional
Asunto del correo electrónico de agradecimiento.
thankYouBodystringopcional
Cuerpo del correo electrónico de agradecimiento.
thankYouDelayHoursnumberopcional
Horas de espera antes de enviar el seguimiento de agradecimiento.
funnelThresholdnumberopcional
Umbral de calificación en estrellas que dirige a quien responde al sitio de reseñas público o a feedback privado.
funnelStyleobjectopcional
Estilo de presentación del embudo, en el formato JSON del creador de campañas.
lowRankContentstringopcional
Contenido mostrado a quienes responden con una calificación por debajo de funnelThreshold.
hideFeedbackBoxbooleanopcional
Ocultar el cuadro de feedback de texto libre en la página de destino.
collectModestringopcional
Cómo se recopila el feedback en la página de destino.
ratingMechanismobjectopcional
La configuración del widget de estrellas/calificación, en el formato JSON del creador de campañas.
askNamebooleanopcional
Pedir al destinatario su nombre.
askFeedbackbooleanopcional
Pedir al destinatario feedback de texto libre.
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
patch/api/v1/review-invites/campaigns/{id}
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 (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
}
}