Synupv1
Criar chave
v1Recursos/Review Invites/getPesquisar destinatários

Pesquisar destinatários

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

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