Synupv1
Crear clave
v1Recursos/Review Invites/getBuscar destinatarios

Buscar destinatarios

Busca destinatarios por nombre, correo electrónico o teléfono en las campañas de invitación a reseñas de su agencia.

get/api/v1/review-invites
review-invite:read
Parámetros de consulta
querystringobligatorio
Texto de búsqueda, comparado con el nombre, el correo electrónico y el teléfono. Obligatorio.
limitintegeropcional
Máximo de resultados a devolver, de 1 a 100. El valor predeterminado es 25.
Respuesta
dataobjectopcional
recipientsarray of objectopcional
Los destinatarios que coinciden.
idstringopcional
Identificador único del destinatario.
namestringopcional
El nombre del destinatario, o vacío si no se indicó.
emailstringopcional
La dirección de correo electrónico del destinatario, o vacío si no se indicó.
phonestringopcional
El número de teléfono del destinatario, o vacío si no se indicó.
sourcestringopcional
De dónde proviene este destinatario, p. ej. manual, csv, crm.
contactTypestringopcional
Uno de: Customer, Lead, Prospect, Contact.
statusstringopcional
Estado de entrega actual de este destinatario.
campaignIdstringopcional
ID de la campaña a la que pertenece este destinatario.
campaignNamestringopcional
Nombre de la campaña a la que pertenece este destinatario.
locationIdstringopcional
ID de la ubicación para la que es la campaña, o null.
locationLabelstringopcional
Nombre visible de esa ubicación, o vacío cuando no se puede resolver.
alreadyMessagedbooleanopcional
Si ya se le ha enviado un mensaje a este destinatario. Una vez que es true, su correo electrónico y teléfono ya no se pueden cambiar.
countnumberopcional
Número total de destinatarios que coinciden con la búsqueda.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/review-invites
Su clave 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
  }
}