v1Ressourcen/Review Invites/postEmpfänger zu einer Kampagne hinzufügen
Empfänger zu einer Kampagne hinzufügen
Fügt einer Review-Invite-Kampagne einen oder mehrere Empfänger hinzu, dedupliziert gegen die Charge selbst und gegen alle bereits auf der Kampagne vorhandenen Empfänger. Warnung — dies kann einen echten Nachrichtenversand auslösen: Ist die Zielkampagne bereits gestartet und die automatische Zustellung aktiv, werden die neu hinzugefügten Empfänger sofort in die Warteschlange eingereiht und an ihre echte E-Mail-Adresse oder Telefonnummer gesendet.
post
review-invite:write/api/v1/review-invitesAnfragetext
campaignIdstringerforderlich
Die Kampagne, zu der Empfänger hinzugefügt werden sollen. Erforderlich.
recipientsarray of objecterforderlich
Die hinzuzufügenden Empfänger. Erforderlich, nicht leer.
namestringoptional
Name des Empfängers.
emailstringoptional
E-Mail-Adresse des Empfängers.
phonestringoptional
Telefonnummer des Empfängers.
sourcestringoptional
Woher dieser Empfänger stammt. Standardmäßig manual.
contactTypestring (Customer | Lead | Prospect | Contact)optional
Einer von: Customer, Lead, Prospect, Contact. Standardmäßig Customer.
channelstringoptional
Über welchen Kanal dieser Empfänger kontaktiert werden soll (z. B. email, sms), oder weglassen, um den Standard-Kanalmix der Kampagne zu verwenden.
smsConsentobjectoptional
SMS-Einwilligungsbestätigung für diese Charge. Erforderlich, damit ein Empfänger in der Charge per SMS kontaktiert werden kann — Zeilen, die ohne diese Angabe hinzugefügt werden, werden beim SMS-Versand übersprungen.
bystringoptional
Name oder Kennung der Person, die bestätigt, dass für diese Charge eine Einwilligung eingeholt wurde.
Antwort
dataobjectoptional
countnumberoptional
Anzahl der tatsächlich hinzugefügten Empfänger.
duplicatesnumberoptional
Anzahl der Zeilen innerhalb der Anfrage-Charge selbst, die eine andere Zeile in derselben Charge duplizierten.
alreadyPresentnumberoptional
Anzahl der Zeilen, die übersprungen wurden, weil diese E-Mail-Adresse oder Telefonnummer bereits auf dieser Kampagne vorhanden war.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/review-invites
Ihr API-Schlüssel
Anfragetext*
{
"data": {
"count": 1,
"duplicates": 0,
"alreadyPresent": 0
}
}