Verwenden Sie die Bulk Contact Importer API

ActiveCampaign Tarife
Starter
Plus
Pro
Enterprise

Mit ActiveCampaign können Sie die Bulk Contact Importer API verwenden, um eine große Anzahl von Kontakten mit nur einem API-Aufruf in Ihr Konto hochzuladen.

Hinweise

Mit ActiveCampaign können Sie die Bulk Contact Importer API verwenden, um eine große Anzahl von Kontakten mit nur einem API-Aufruf in Ihr Konto hochzuladen.

Hinweise

  • Die Bulk Contact Importer API ist für alle ActiveCampaign-Tarife verfügbar
  • Diese Funktion ist für fortgeschrittene Benutzer gedacht, die mit der API vertraut sind und sie problemlos zum Importieren von Kontakten verwenden können
  • Diese Vorgänge umfassen:

Über die Bulk Contact Importer API

Der Bulk-Kontakt-Importer wurde entwickelt, um Vorgänge an großen Mengen von Kontakten auf einmal durchzuführen. Diese Vorgänge umfassen:

  • Neue Kontakte anlegen
  • Vorhandene Kontakte aktualisieren
  • Felder an Kontakten einstellen
  • Kontakte markieren
  • Stattdessen sollten die Kontaktaktualisierungen in größeren Stapeln gesammelt und als Gruppe importiert werden.

Hinweis

Der Bulk Contact Importer ist nicht dafür ausgelegt, häufige Vorgänge mit einer kleinen Anzahl von Kontakten zu unterstützen oder Aktualisierungen in Echtzeit mit einer externen Datenbank zu synchronisieren. Stattdessen sollten die Kontaktaktualisierungen in größeren Stapeln gesammelt und als Gruppe importiert werden. Kontakte können in Stapeln von bis zu 250 Elementen importiert werden.

Wenn Sie 10 oder weniger Kontakte auf einmal hochladen möchten, verwenden Sie bitte die Kontaktfunktion unserer ActiveCampaign API V3.

Tarifbegrenzung

Der Bulk-Importer-Prozess ist für das Hochladen größerer Listen von Kontakten optimiert. Die Ausführung häufiger Anfragen, die eine kleine Anzahl von Kontakten betreffen, erfordert einen erheblichen Overhead und kann die Leistung des Importers’beeinträchtigen. Aus diesem Grund erzwingen wir die folgenden Ratenbeschränkungen für die Bulk Contact Importer API:

  • Für Anfragen, die einen einzelnen Kontakt enthalten, gibt es ein Limit von 20 Anfragen pro Minute
  • Für Anfragen, die mehrere Kontakte enthalten, gibt es ein Limit von 100 Anfragen pro Minute

Wir empfehlen, dass alle Benutzer versuchen, Updates in möglichst großen Gruppen zu bündeln, bevor sie einen Import starten.

Begrenzung der Nutzlastgröße

Die Größe der Nutzlast einer einzelnen bulk_import-Anfrage muss weniger als 400000 Bytes betragen.

Übersprungene Kontakte

Kontakte müssen alle folgenden Kriterien erfüllen, damit sie mit dieser API erstellt oder aktualisiert werden können:

  • Die importierten Kontakte dürfen Ihr Kontolimit nicht überschreiten
  • Der Kontakt muss eine E-Mail-Adresse haben

Wenn die Kontakte nicht alle diese Anforderungen erfüllen, werden sie vom Importeur übersprungen.

  • Die E-Mail-Adresse der Kontaktperson’darf nicht in einer Ausschlussliste stehen.
  • Die E-Mail des Kontakts’darf nicht auf einer Liste mit abgelehnten E-Mail-Adressen stehen.
  • Der Kontakt darf sich nicht von einer Liste abgemeldet haben, zu der der Import ihn hinzufügen würde

Wenn die Kontakte nicht alle diese Anforderungen erfüllen, werden sie vom Importeur übersprungen.

API-Dokumentation

POST https://youraccountname.api-us1.com/api/3/import/bulk_import

Struktur anfordern

JSON
{
"Kontakte": [
{
"email": "someone@somewhere.com",
"first_name": "Jane",
"last_name": "Doe",
"phone": "123-456-7890",
"customer_acct_name": "ActiveCampaign",
"tags": [
"dictumst aliquam augue quam sollicitudin rutrum",
],
"fields": [
{"id": 1, "value": "foo"},
{"id": 2, "value": "foo||bar||baz"}
],
"subscribe": [{"listid": 1}, {"listid": 2}],
"unsubscribe": [{"listid": 3}],
}
],
"callback":
}

Antwort
200 OK
{
"Success":1,
"queued_contacts":1,
"batchId":"0641fbdd-f62f-4c2c-ba02-3a83d5d11ac9",
"message": "Contact import queued"
}

400 Bad Request
{
"Success":0,
"message": "JSON payload did not pass validation. Bitte fixieren Sie failureReasons und versuchen Sie es erneut. The import was not queued for processing.",
"failureReasons":["Payload must contain a 'contacts' field"]
}


Körper-Parameter

kontakte* Array (Objekt)

Ein Array von Objekten, das Informationen über einen einzelnen Kontakt enthält. Es können bis zu 250 Kontakte in einer einzigen Anfrage enthalten sein. Jeder Kontakt kann die folgenden Felder enthalten:

  • email* (string)
    Die E-Mail des Kontakts.
  • first_name (string)
    Der Vorname des Kontakts.
  • last_name (string)
    Der Nachname des Kontakts.
  • phone (string)
    Die Telefonnummer des Kontakts.
  • customer_acct_name (string)
    Der Name des Kontos des Kontakts.
  • tags array (string)
    Jede Zeichenkette im Array wird als einzelnes Tag zum Kontakt hinzugefügt. Es werden neue Tags erstellt, wenn sie nicht bereits vorhanden sind.
  • fields array (object)
    Eine Liste der benutzerdefinierten Felder, die auf den Kontakt angewendet werden sollen. Jedes Feld muss zwei Felder enthalten: Jeder Kontakt kann bis zu N benutzerdefinierte Felder haben.
  • id* (Zahl)
    Die ID des benutzerdefinierten Feldes. Benutzerdefinierte Felder müssen über die ID referenziert werden, die ActiveCampaign ihnen zuweist. Sie können die ID-Nummer für ein benutzerdefiniertes Feld abrufen, indem Sie den API-Aufruf "List all custom fields" verwenden.
  • value* (string)
    Der Wert des benutzerdefinierten Feldes. Bei mehrwertigen Feldern können mehrere Werte aufgefüllt werden, indem die verschiedenen Werte durch das Doppelstrichzeichen (“” ) getrennt werden.
  • subscribe array (object)
    Ein Array von Listen, bei denen der Kontakt abonniert werden soll. Kontakte können nicht in Listen eingetragen werden, von denen sie sich zuvor abgemeldet haben. Jedes Listenobjekt enthält ein einzelnes Feld.
  • Jedes Listenobjekt enthält ein einzelnes Feld.
    listid* (Zahl)Die ID der Liste, aus der der Kontakt abgemeldet werden soll. Listen müssen über die ID referenziert werden, die ActiveCampaign ihnen zuweist.

    Sie können die Listen-ID finden, indem Sie auf die Liste in Ihrem ActiveCampaign-Konto klicken und dann die URL-Leiste anzeigen. Sie wird etwa so aussehen: /app/contacts/?listid=19&status=1

    Sie können die ID-Nummer für eine Liste auch mit dem API-Aufruf "Retrieve all lists" abrufen.
  • unsubscribe array (object)
    Ein Array von Listen, in die der Kontakt abgemeldet werden soll. Jedes Listenobjekt enthält ein einzelnes Feld.
    listid* (Zahl)Die ID der Liste, aus der der Kontakt abgemeldet werden soll. Listen müssen über die ID referenziert werden, die ActiveCampaign ihnen zuweist.

    Sie können die Listen-ID finden, indem Sie auf die Liste in Ihrer ActiveCampaign klicken und dann die URL-Leiste anzeigen. Sie wird etwa so aussehen: /app/contacts/?listid=19&status=1

    Sie können die ID-Nummer für eine Liste auch mit dem API-Aufruf "Retrieve all lists" abrufen.

Rückrufe

Der Massenkontakt-Endpunkt verfügt über eine Callback-Funktion, um Benutzer zu benachrichtigen, wenn ein Import abgeschlossen ist. Fügen Sie die folgenden Informationen in eine Kontaktimportanfrage ein, um diese Funktion zu nutzen:

JSON
{
"Kontakte": [ ... include contacts here ... ],
"callback": {
"url": "www.your_web_server.com",
"requestType": "POST",
"detailed_results": "true",
"params": [
{"key":"", "value":""}
]
"headers": [
{"key":"", "value":""}
]
}
}

 

  • url (string)
    Der URL-Endpunkt, an den der Importeur eine Anfrage stellt, sobald der Import abgeschlossen ist.
  • requestType (string)
    Kann entweder auf "GET" oder "POST" gesetzt werden. Legt den Typ der HTTP-Anfrage fest, die an den angegebenen Endpunkt gesendet wird.
  • detailed_results (string)
    Wenn der Parameter requestType auf "true" und der Parameter auf "POST" gesetzt ist, enthält der Callback die Anzahl der erfolgreichen und fehlgeschlagenen Anfragen sowie ein Array mit Fehlermeldungen für jeden fehlgeschlagenen Kontakt.
  • params (array)
    Eine Liste von Parametern, die in die Rückrufanforderung aufzunehmen sind. Fügen Sie jeden Parameter in Form eines Schlüssel-Wert-Paares hinzu. Bei einer GET-Anfrage wird jeder Parameter in einem Query-String an das Ende der URL angehängt. Bei einer POST-Anforderung werden die Parameter in den Körper der Anforderung aufgenommen.
  • kopfzeilen (Array)
  • Eine Liste von Kopfzeilen, die in die Callback-Anforderung aufgenommen werden sollen. Fügen Sie jeden Header in Form eines Schlüssel-Wert-Paares hinzu.

Beispiele

Empfangen einer Benachrichtigung

{
"Kontakte": [ ... include contacts here ... ],
"callback": {
"url": "www.yourwebsite.com/the/api/to/hit",
"requestType": "GET",
"params": [
{"key": "msg", "value": "hello"}
]
"headers": [
{"key":"", "value":""}
]
}
}

 

Params werden im Falle einer “GET” Anfrage als Abfrageparameter an die URL angehängt. Kopfzeilen werden auf die Anfrage angewendet, bevor sie gesendet wird. Dieser Endpunkt akzeptiert beliebige Zeichenkettenwerte für Schlüssel und Werte für Params und Header.

Ergebnis:

GET www.yourwebsite.com/the/api/to/hit?msg=hello

Senden einer Nachricht

{
"Kontakte": [ ... include contacts here ... ],
"callback": {
"requestType": "POST",
"params": [
{"key": "msg", "value": "Import completed"}
]
"headers": [
{"key": "Authorization", "value": "Bearer 4u1h_t0k3N"}
]
}
}


Ergebnis:

GET www.yourwebsite.com/the/api/to/hit

JSON
[
{"key": "msg", "value": "Import completed"}
]


Importergebnisse mit Fehlermeldungen

{
"Kontakte": [ ... include contacts here ... ],
"callback": {
"requestType": "POST",
"detailed_results": "true",
"headers": [
{"key":"", "value":""}
]
}
}


Wenn der Parameter “detailed_results” auf "True" gesetzt ist, enthält der Callback:

  • Ein JSON-Objekt mit den angegebenen Parametern
  • Drei weitere Felder in der Antwort, die bei der Überwachung und Fehlersuche helfen können

Ergebnis:

GET www.yourwebsite.com/the/api/to/hit

JSON
{
"Erfolg":1,
"Misserfolge":0,
"failure_reasons":[]
}

Haben Sie weitere Fragen? Anforderung einreichen

Start free trial