Synupv1
Criar chave
v1Recursos/Review Invites/postAdicionar destinatários a uma campanha

Adicionar 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.

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