Synupv1
Criar chave
v1Recursos/Review Invites/patchAtualizar uma campanha

Atualizar uma campanha

Edita a configuração de uma campanha. Envie apenas os campos que deseja alterar. Para mudar o status do ciclo de vida (publish, stop, clone, archive, unarchive) use o endpoint de ação em vez de definir status diretamente aqui.

patch/api/v1/review-invites/campaigns/{id}
review-invite:write
Parâmetros de consulta
idstringobrigatório
A campanha a ser atualizada. Obrigatório.
Corpo da solicitação
namestringopcional
O nome de exibição da campanha.
locationIdstringopcional
O local para o qual esta campanha envia convites. Obrigatório na criação.
campaignTypestringopcional
A combinação de canais, ex.: email, sms, email_sms.
channelsstringopcional
Em quais canais a campanha envia: EMAIL, SMS ou SMS_AND_EMAIL. Os requisitos de e-mail (endereço de origem, domínio de envio verificado) só se aplicam quando EMAIL está incluído; uma campanha somente de SMS precisa, em vez disso, de um número verificado pela operadora para seu local.
fromEmailstringopcional
O endereço de e-mail de envio ("from"). Requer um domínio de envio verificado para realmente enviar.
replyToEmailstringopcional
O endereço de e-mail de resposta.
emailSubjectstringopcional
O assunto do e-mail.
emailBodyobjectopcional
O corpo do e-mail, no formato JSON de texto rico que o editor do criador de campanhas produz.
emailHtmlstringopcional
Alternativa HTML renderizada do corpo do e-mail.
smsBodystringopcional
O texto da mensagem de SMS.
smsReviewSitestringopcional
Para qual site de avaliação o link do SMS aponta.
reviewSitesobjectopcional
O(s) site(s) de avaliação oferecido(s) a clientes satisfeitos, no formato JSON do criador de campanhas.
screeningEnabledbooleanopcional
Se deve triar clientes pela classificação em estrelas antes de direcioná-los a um site de avaliação público.
landingTitlestringopcional
Título exibido na página de destino da campanha.
landingContentstringopcional
Conteúdo do corpo exibido na página de destino da campanha.
hideAddressbooleanopcional
Ocultar o endereço do negócio na página de destino.
hideBusinessNamebooleanopcional
Ocultar o nome do negócio na página de destino.
hideImagebooleanopcional
Ocultar a imagem do negócio na página de destino.
followupsobjectopcional
Cronograma de lembretes de acompanhamento, no formato JSON do criador de campanhas.
stopFollowupOnClickbooleanopcional
Parar de enviar acompanhamentos assim que o destinatário clicar no link.
scheduleAtstringopcional
Data/hora ISO para a qual agendar o lançamento da campanha. Deixe vazio para enviar imediatamente ao publicar.
timezonestringopcional
Fuso horário IANA para o agendamento, ex.: America/New_York.
autoSendbooleanopcional
Se novos destinatários recebem envio automático assim que a campanha é lançada.
staticUrlstringopcional
Um slug de URL estático/QR de solicitação de avaliação para esta campanha, se usado em vez de ou junto com envio por e-mail/SMS.
thankYouEnabledbooleanopcional
Se deve mostrar um acompanhamento de agradecimento após uma avaliação positiva.
thankYouSubjectstringopcional
Assunto do e-mail de agradecimento.
thankYouBodystringopcional
Corpo do e-mail de agradecimento.
thankYouDelayHoursnumberopcional
Horas de espera antes de enviar o acompanhamento de agradecimento.
funnelThresholdnumberopcional
Limite de classificação em estrelas que direciona quem responde ao site de avaliação público ou a feedback privado.
funnelStyleobjectopcional
Estilo de apresentação do funil, no formato JSON do criador de campanhas.
lowRankContentstringopcional
Conteúdo exibido a quem responde com classificação abaixo de funnelThreshold.
hideFeedbackBoxbooleanopcional
Ocultar o campo de feedback em texto livre na página de destino.
collectModestringopcional
Como o feedback é coletado na página de destino.
ratingMechanismobjectopcional
A configuração do widget de estrelas/classificação, no formato JSON do criador de campanhas.
askNamebooleanopcional
Pedir o nome de quem responde.
askFeedbackbooleanopcional
Pedir feedback em texto livre de quem responde.
Resposta
dataobjectopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
patch/api/v1/review-invites/campaigns/{id}
Sua chave de API
id *
Corpo da solicitação
{
  "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
  }
}