v1Recursos/Review Invites/postCriar uma campanha

Criar uma campanha

Cria uma nova campanha de convite para avaliação como rascunho. locationId é obrigatório; o restante pode ser definido agora ou depois com o endpoint de atualização. Use o endpoint de ação para publicá-la depois de configurada — isso sozinho não envia nada.

post/api/v1/review-invites/campaigns

review-invite:write

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.

post/api/v1/review-invites/campaigns

Sua chave de API

{
  "data": {
    "id": "cm_campaign_1",
    "agencyId": "cm_agency_1",
    "locationId": "cm_loc_1",
    "clientLocationId": "cm_loc_1",
    "name": "Spring Checkup Follow-up",
    "campaignType": "email_sms",
    "channels": "EMAIL",
    "status": "draft",
    "fromEmail": null,
    "replyToEmail": null,
    "emailSubject": null,
    "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-20T09:00:00.000Z",
    "createdByUserId": null,
    "createdByType": "user",
    "archived": false
  }
}