Synupv1
Schlüssel erstellen
v1Ressourcen/Review Invites/getEmpfänger suchen

Empfänger suchen

Sucht Empfänger nach Name, E-Mail-Adresse oder Telefonnummer über die Review-Invite-Kampagnen Ihrer Agentur hinweg.

get/api/v1/review-invites
review-invite:read
Query-Parameter
querystringerforderlich
Suchtext, abgeglichen gegen Name, E-Mail-Adresse und Telefonnummer. Erforderlich.
limitintegeroptional
Maximale Anzahl zurückzugebender Ergebnisse, 1–100. Standardmäßig 25.
Antwort
dataobjectoptional
recipientsarray of objectoptional
Die passenden Empfänger.
idstringoptional
Eindeutige Kennung des Empfängers.
namestringoptional
Der Name des Empfängers, oder leer, falls nicht angegeben.
emailstringoptional
Die E-Mail-Adresse des Empfängers, oder leer, falls nicht angegeben.
phonestringoptional
Die Telefonnummer des Empfängers, oder leer, falls nicht angegeben.
sourcestringoptional
Woher dieser Empfänger stammt, z. B. manual, csv, crm.
contactTypestringoptional
Einer von: Customer, Lead, Prospect, Contact.
statusstringoptional
Aktueller Zustellstatus für diesen Empfänger.
campaignIdstringoptional
ID der Kampagne, zu der dieser Empfänger gehört.
campaignNamestringoptional
Name der Kampagne, zu der dieser Empfänger gehört.
locationIdstringoptional
ID des Standorts, für den die Kampagne gilt, oder null.
locationLabelstringoptional
Anzeigename dieses Standorts, oder leer, wenn er nicht aufgelöst werden kann.
alreadyMessagedbooleanoptional
Ob diesem Empfänger bereits eine Nachricht gesendet wurde. Sobald true, können E-Mail-Adresse und Telefonnummer nicht mehr geändert werden.
countnumberoptional
Gesamtzahl der zur Suche passenden Empfänger.
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.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/review-invites
Ihr API-Schlüssel
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
  }
}