v1Recursos/Review Invites

Review Invites

Pesquise e gerencie os destinatários das suas campanhas de convite para avaliação.

Pesquisa destinatários por nome, e-mail ou telefone nas campanhas de convite para avaliação da sua agência.

Pesquisar destinatários

get/api/v1/review-invites

review-invite:read

Parâmetros de consulta

querystringobrigatório

Texto de pesquisa, correspondido com nome, e-mail e telefone. Obrigatório.

limitintegeropcional

Máximo de resultados a retornar, 1–100. O padrão é 25.

Resposta

dataobjectopcional

recipientsarray of objectopcional

Os destinatários correspondentes.

idstringopcional

Identificador único do destinatário.

namestringopcional

O nome do destinatário, ou vazio se não informado.

emailstringopcional

O endereço de e-mail do destinatário, ou vazio se não informado.

phonestringopcional

O número de telefone do destinatário, ou vazio se não informado.

sourcestringopcional

De onde este destinatário veio, ex.: manual, csv, crm.

contactTypestringopcional

Um de: Customer, Lead, Prospect, Contact.

statusstringopcional

Status de entrega atual para este destinatário.

campaignIdstringopcional

ID da campanha à qual este destinatário pertence.

campaignNamestringopcional

Nome da campanha à qual este destinatário pertence.

locationIdstringopcional

ID do local para o qual a campanha é, ou null.

locationLabelstringopcional

Nome de exibição desse local, ou vazio quando não pode ser resolvido.

alreadyMessagedbooleanopcional

Se uma mensagem já foi enviada a este destinatário. Uma vez true, seu e-mail e telefone não podem mais ser alterados.

countnumberopcional

Número total de destinatários correspondentes à pesquisa.

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.

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

get/api/v1/review-invites

Sua chave de API

query *

limit

{
  "data": {
    "recipients": [
      {
        "id": "cm_recip_1",
        "name": "Jordan Lee",
        "email": "jordan@example.com",
        "phone": "",
        "source": "manual",
        "contactType": "Customer",
        "status": "pending",
        "campaignId": "cm_campaign_1",
        "campaignName": "Spring Checkup Follow-up",
        "locationId": "cm_loc_1",
        "locationLabel": "Acme Dental — Downtown · Austin",
        "alreadyMessaged": false
      }
    ],
    "count": 1
  }
}

v1Recursos/Review Invites/postAdicionar destinatários a uma campanha

Adiciona um ou mais destinatários a uma campanha de convite para avaliação, desduplicados contra o próprio lote e contra todos os já presentes na campanha. Atenção — isto pode disparar um envio real de mensagem: se a campanha de destino já estiver lançada com envio automático ativado, os destinatários recém-adicionados são enfileirados e enviados imediatamente, para seu endereço de e-mail ou número de telefone reais.

Adicionar destinatários a uma campanha

post/api/v1/review-invites

review-invite:write

Corpo da solicitação

campaignIdstringobrigatório

A campanha à qual adicionar destinatários. Obrigatório.

recipientsarray of objectobrigatório

Os destinatários a adicionar. Obrigatório, não pode ser vazio.

namestringopcional

Nome do destinatário.

emailstringopcional

Endereço de e-mail do destinatário.

phonestringopcional

Número de telefone do destinatário.

sourcestringopcional

De onde este destinatário veio. O padrão é manual.

contactTypestring (Customer | Lead | Prospect | Contact)opcional

Um de: Customer, Lead, Prospect, Contact. O padrão é Customer.

channelstringopcional

Em qual canal contatar este destinatário (ex.: email, sms), ou omita para usar a combinação padrão da campanha.

smsConsentobjectopcional

Atestação de consentimento de SMS para este lote. Obrigatória para que qualquer destinatário do lote possa ser contatado por SMS — linhas adicionadas sem ela são ignoradas para envio por SMS.

bystringopcional

Nome ou identificador da pessoa que atesta que o consentimento foi obtido para este lote.

Resposta

dataobjectopcional

countnumberopcional

Número de destinatários efetivamente adicionados.

duplicatesnumberopcional

Número de linhas no próprio lote da solicitação que duplicaram outra linha do mesmo lote.

alreadyPresentnumberopcional

Número de linhas ignoradas porque esse e-mail ou telefone já estava nesta campanha.

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

Sua chave de API

Corpo da solicitação*

{
  "data": {
    "count": 1,
    "duplicates": 0,
    "alreadyPresent": 0
  }
}

v1Recursos/Review Invites/postAtualizar um destinatário

Corrige o nome, e-mail, telefone ou tipo de contato de um destinatário. E-mail e telefone ficam congelados após uma mensagem ter sido enviada a esse destinatário — alterar qualquer um deles depois de um envio retorna um 409, já que confirmações de entrega e respostas estão vinculadas ao endereço realmente usado.

Atualizar um destinatário

post/api/v1/review-invites/update

review-invite:write

Corpo da solicitação

recipientIdstringobrigatório

O destinatário a ser atualizado. Obrigatório.

namestringopcional

Novo nome.

emailstringopcional

Novo endereço de e-mail. Rejeitado com um 409 se este destinatário já recebeu uma mensagem.

phonestringopcional

Novo número de telefone. Rejeitado com um 409 se este destinatário já recebeu uma mensagem.

contactTypestring (Customer | Lead | Prospect | Contact)opcional

Novo tipo de contato: Customer, Lead, Prospect ou Contact.

Resposta

dataobjectopcional

idstringopcional

Identificador único do destinatário.

namestringopcional

O nome do destinatário, ou vazio se não informado.

emailstringopcional

O endereço de e-mail do destinatário, ou vazio se não informado.

phonestringopcional

O número de telefone do destinatário, ou vazio se não informado.

contactTypestringopcional

Um de: Customer, Lead, Prospect, Contact.

statusstringopcional

Status de entrega atual para este destinatário.

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.

409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).

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/update

Sua chave de API

Corpo da solicitação*

{
  "data": {
    "id": "cm_recip_1",
    "name": "Jordan Lee",
    "email": "jordan@example.com",
    "phone": null,
    "contactType": "Customer",
    "status": "pending"
  }
}

v1Recursos/Review Invites/getListar campanhas

Lista as campanhas de convite para avaliação de um local, mais recentes primeiro.

Listar campanhas

get/api/v1/review-invites/campaigns

review-invite:read

Parâmetros de consulta

locationIdstringobrigatório

O local cujas campanhas serão listadas. Obrigatório.

pageintegeropcional

Número da página, começando em 0. O padrão é 0.

statusstring (all | draft | launched | stopped | archived)opcional

Filtrar por status. O padrão é all.

Resposta

dataobjectopcional

campaignsarray of unknownopcional

As campanhas correspondentes.

totalnumberopcional

Número total de campanhas correspondentes aos filtros.

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.

get/api/v1/review-invites/campaigns

Sua chave de API

locationId *

page

status

{
  "data": {
    "rows": [
      {
        "id": "cm_campaign_1",
        "name": "Spring Checkup Follow-up",
        "type": "email_sms",
        "collectMode": "directory",
        "status": "draft",
        "archived": false,
        "locationLabel": "Acme Dental — Downtown · Austin",
        "emailsSent": 0,
        "smsSent": 0,
        "repliesCount": 0,
        "clickRate": null,
        "followUpSent": 0,
        "autoSend": true,
        "yelpCompliant": true,
        "staticUrl": null
      }
    ],
    "total": 1
  }
}

v1Recursos/Review Invites/postCriar 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.

Criar uma campanha

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

v1Recursos/Review Invites/getObter uma campanha

Retorna uma única campanha pelo seu id.

Obter uma campanha

get/api/v1/review-invites/campaigns/{id}

review-invite:read

Parâmetros de consulta

idstringobrigatório

O id da campanha. Obrigatório.

Resposta

dataobjectopcional

Erros

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.

get/api/v1/review-invites/campaigns/{id}

Sua chave de API

id *

{
  "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": "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-20T09:00:00.000Z",
    "createdByUserId": null,
    "createdByType": "user",
    "archived": false
  }
}

v1Recursos/Review Invites/patchAtualizar 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.

Atualizar uma campanha

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

v1Recursos/Review Invites/postExecutar 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.

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

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

v1Recursos/Review Invites/getListar modelos de mensagem

Lista os modelos de mensagem de convite para avaliação salvos pela agência — conteúdo de e-mail/SMS reutilizável para campanhas.

Listar modelos de mensagem

get/api/v1/review-invites/templates

review-invite:read

Resposta

dataarray of unknownopcional

Erros

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.

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

get/api/v1/review-invites/templates

Sua chave de API

{
  "data": [
    {
      "id": "cm_tmpl_1",
      "name": "Standard follow-up",
      "description": "Default post-visit email template",
      "content": null,
      "assignedLocationIds": [],
      "createdAt": "2026-01-15T09:00:00.000Z"
    }
  ]
}

v1Recursos/Review Invites/postCriar um modelo de mensagem

Cria um modelo de mensagem de convite para avaliação reutilizável. content é o formato JSON de texto rico que o editor do criador de campanhas produz.

Criar um modelo de mensagem

post/api/v1/review-invites/templates

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.

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

post/api/v1/review-invites/templates

Sua chave de API

{
  "data": {
    "id": "cm_tmpl_1",
    "agencyId": "cm_agency_1",
    "name": "Standard follow-up",
    "description": "Default post-visit email template",
    "content": null,
    "assignedLocationIds": [],
    "createdAt": "2026-01-15T09:00:00.000Z",
    "updatedAt": "2026-01-15T09:00:00.000Z"
  }
}

v1Recursos/Review Invites/patchAtualizar um modelo de mensagem

Edita um modelo. Envie apenas os campos que deseja alterar.

Atualizar um modelo de mensagem

patch/api/v1/review-invites/templates/{id}

review-invite:write

Parâmetros de consulta

idstringobrigatório

O modelo a ser atualizado. Obrigatório.

Corpo da solicitação

namestringopcional

O nome de exibição do modelo.

descriptionstringopcional

Uma breve descrição de quando usar este modelo.

contentobjectopcional

O conteúdo do modelo, no formato JSON de texto rico do criador de campanhas.

assignedLocationIdsarray of stringopcional

Ids de local para os quais este modelo é sugerido. Omita para disponibilizá-lo em toda a agência.

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/templates/{id}

Sua chave de API

id *

Corpo da solicitação

{
  "data": {
    "id": "cm_tmpl_1",
    "agencyId": "cm_agency_1",
    "name": "Standard follow-up",
    "description": "Default post-visit email template (updated)",
    "content": null,
    "assignedLocationIds": [
      "cm_loc_1"
    ],
    "createdAt": "2026-01-15T09:00:00.000Z",
    "updatedAt": "2026-01-16T09:00:00.000Z"
  }
}

v1Recursos/Review Invites/deleteExcluir um modelo de mensagem

Exclui um modelo permanentemente. Isso não afeta campanhas que já usam seu conteúdo — apenas remove o modelo reutilizável.

Excluir um modelo de mensagem

delete/api/v1/review-invites/templates/{id}

review-invite:write

Parâmetros de consulta

idstringobrigatório

O modelo a ser excluído. Obrigatório.

Resposta

dataobjectopcional

deletedbooleanopcional

Erros

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.

delete/api/v1/review-invites/templates/{id}

Sua chave de API

id *

{
  "data": {
    "ok": true
  }
}