Kontakte: Tags, Status und Felder
Felder setzen
Schreiben Sie dieselben Werte für benutzerdefinierte Felder auf bis zu 500 Kontakte. Die Werte werden in den Typ des jeweiligen Felds umgewandelt.
https://g.sendcorex.com/v1/contactscommand: set_fieldsErfordert den Scope contact:update auf Ihrem API Key.
Jeder Schlüssel muss ein mit Define Field angelegtes Feld sein. Ein unbekannter Schlüssel lässt den ganzen Befehl fehlschlagen, bevor ein Kontakt verändert wird.
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.fieldsobjecterforderlich{ key: value }. Nicht gesendete Schlüssel bleiben unverändert.z. B.
{ "plan": "business", "age": 32 }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: "set_fields",
args: {
emails: [
"ana@acme.com"
],
fields: {
plan: "business",
age: 32
}
}
}
]
},
{ 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": "set_fields",
"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.changedfalsebedeutet, dass der Kontakt schon so war und nichts geschrieben wurde.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.
Unterschiedliche Werte pro Kontakt
Set Fields schreibt auf jede E-Mail dieselben Werte. Wenn jeder Kontakt eigene Werte hat, senden Sie sie als Zeilen an Update Contacts (oder Upsert Contacts), mit fields in jeder Zeile.
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.