Synupv1
Crear clave
v1Recursos/Review Invites/postAgregar destinatarios a una campaña

Agregar destinatarios a una campaña

Agrega uno o más destinatarios a una campaña de invitación a reseñas, deduplicados tanto dentro del propio lote como frente a todos los que ya están en la campaña. Advertencia — esto puede desencadenar un envío real de mensajes: si la campaña de destino ya está lanzada con el envío automático activado, los destinatarios recién agregados se encolan y se les envía de inmediato, a su dirección de correo electrónico o número de teléfono real.

post/api/v1/review-invites
review-invite:write
Cuerpo de la solicitud
campaignIdstringobligatorio
La campaña a la que agregar destinatarios. Obligatorio.
recipientsarray of objectobligatorio
Los destinatarios a agregar. Obligatorio, no vacío.
namestringopcional
Nombre del destinatario.
emailstringopcional
Dirección de correo electrónico del destinatario.
phonestringopcional
Número de teléfono del destinatario.
sourcestringopcional
De dónde proviene este destinatario. El valor predeterminado es manual.
contactTypestring (Customer | Lead | Prospect | Contact)opcional
Uno de: Customer, Lead, Prospect, Contact. El valor predeterminado es Customer.
channelstringopcional
Por qué canal enviar el mensaje a este destinatario (p. ej. email, sms), u omítalo para usar la combinación predeterminada de la campaña.
smsConsentobjectopcional
Declaración de consentimiento SMS para este lote. Obligatoria para que se pueda enviar un SMS a cualquier destinatario del lote — las filas agregadas sin ella se omiten para el envío por SMS.
bystringopcional
Nombre o identificador de la persona que declara que se obtuvo el consentimiento para este lote.
Respuesta
dataobjectopcional
countnumberopcional
Número de destinatarios realmente agregados.
duplicatesnumberopcional
Número de filas del propio lote de la solicitud que duplicaban otra fila del mismo lote.
alreadyPresentnumberopcional
Número de filas que se omitieron porque ese correo electrónico o teléfono ya estaba en esta campaña.
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.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/review-invites
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "count": 1,
    "duplicates": 0,
    "alreadyPresent": 0
  }
}