Kontakte: Listen
Zu Listen hinzufügen
Fügen Sie bis zu 500 bestehende Kontakte angemeldet zu einer oder mehreren Listen hinzu.
https://g.sendcorex.com/v1/contactscommand: add_to_listsErfordert den Scope contact:update auf Ihrem API Key.
Jede Liste muss existieren. Fehlt eine, schlägt der ganze Befehl mit NOT_FOUND fehl, bevor ein Kontakt verändert wird. Nicht existierende Kontakte schlagen in ihrem eigenen Eintrag fehl.
Argumente
emailsstring[]optionalBis zu 500 E-Mails. Groß-/Kleinschreibung und umgebende Leerzeichen werden ignoriert, doppelte E-Mails zählen einmal.
emailstringoptionalEine einzelne E-Mail. Verwenden Sie dies oder
emails.list_idsstring[]erforderlichDie Listen, denen beigetreten wird.
z. B.
["customers", "newsletter"]list_idstringoptionalEine einzelne Liste. Verwenden Sie dies oder
list_ids.return_contactsbooleanoptionalFügt jedem Eintrag den vollständigen Kontakt nach der Änderung hinzu.
Schnellstart
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "add_to_lists",
args: {
emails: [
"ana@acme.com"
],
list_ids: [
"customers",
"newsletter"
]
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Antwort
{
"type": "SUCCESS",
"results": [
{
"command": "add_to_lists",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "ana@acme.com",
"ok": true,
"data": {
"changed": true
}
}
],
"ok_count": 1,
"failed_count": 0
}
}
]
}Antwortfelder
items[].idDie gesendete E-Mail, so wie Sie sie gesendet haben.
items[].oktrue, wenn diese E-Mail erfolgreich war. Beifalseenthält der Eintragcodeundmessage.items[].data.changedfalse, wenn der Kontakt bereits in all diesen Listen war.items[].data.contactDer vollständige Kontakt nach der Änderung. Nur mit
return_contacts: true.ok_count / failed_countWie viele E-Mails erfolgreich waren und wie viele fehlgeschlagen sind.
Neue Kontakte
Add To Lists funktioniert nur mit bestehenden Kontakten. Um in einem Schritt anzulegen und hinzuzufügen, verwenden Sie Upsert Contacts mit list_id.
Fehler
Fehler auf HTTP-Ebene liefern type, code und message. Mit CMD markierte Fehler kommen im Befehlsergebnis zurück, mit HTTP 200.
- 401
INVALID_API_KEYDer API Key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.
- 429
RATE_LIMITEDMehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API Key. Warten Sie die Sekunden aus Retry-After ab.
- CMD
MISSING_SCOPEDem API Key fehlt der Scope, den dieser Befehl braucht. Die anderen Befehle im Request laufen trotzdem.
- CMD
INVALID_ARGSEin Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …
- CMD
NOT_FOUNDDer Kontakt, die Liste, das Feld oder das Segment existiert nicht.
- CMD
INTERNALServerfehler. Details werden nur ins Server-Log geschrieben.