v1Recursos/Review Invites/postExecutar uma ação de ciclo de vida da campanha

Executar uma ação de ciclo de vida da campanha

Executa uma ação de ciclo de vida em uma campanha. publish a lança — se autoSend estiver ativado, isso começa a enviar e-mails ou SMS reais imediatamente, e é condicionado por canal: uma campanha que inclui EMAIL precisa de um domínio de envio verificado para o cliente, e uma que inclui SMS precisa de um número verificado pela operadora para o local. Se alguma dessas condições falhar, um 422 explicativo é retornado; provisionar um domínio ou número de telefone é uma etapa exclusiva da interface, não algo que esta API possa fazer por você. stop interrompe uma campanha ativa. clone a duplica como um novo rascunho. autoSend ativa ou desativa o envio automático para novos destinatários — envie on. archive arquiva uma campanha interrompida; em uma ainda ativa isso é um no-op, não um erro — a resposta é {id, skipped: true} em vez da campanha completa, então verifique skipped em vez de assumir que data é sempre uma Campaign. unarchive restaura uma campanha arquivada.

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

review-invite:write

Parâmetros de consulta

idstringobrigatório

A campanha sobre a qual agir. Obrigatório.

Corpo da solicitação

apiDocs.resources.review-invites.action.paramsOp

onbooleanopcional

apiDocs.resources.review-invites.action.paramsOn

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.

422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.

429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.

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

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