Kontakte: Tags, Status und Felder
Status festlegen
Ändern Sie den globalen Status von bis zu 500 Kontakten: in allen Listen gleichzeitig abmelden, sperren oder wieder anmelden.
https://g.sendcorex.com/v1/contactscommand: set_statusErfordert den Scope contact:update auf Ihrem API Key.
Der Status ist global. Ein Kontakt, der nicht subscribed ist, kann in keiner Liste angeschrieben werden, auch wenn er dort noch angemeldet ist. Um nur eine Liste zu verlassen, verwenden Sie Set List Subscription.
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.statusstringerforderlichsubscribed,unsubscribed,bounced,complainedoderblocked.z. B.
"unsubscribed"reasonstringoptionalWarum sich der Status geändert hat. Wird in
status_reasongespeichert.z. B.
"asked by email"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_status",
args: {
emails: [
"bob@gmail.com"
],
status: "unsubscribed",
reason: "asked by email"
}
}
]
},
{ 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_status",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "bob@gmail.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.
Status
subscribedKann E-Mails der Listen erhalten, für die er angemeldet ist.
unsubscribedHat gebeten, keine E-Mails mehr zu erhalten.
bouncedDie Adresse nimmt keine E-Mails an.
complainedHat eine Ihrer E-Mails als Spam markiert.
blockedVon Ihnen gesperrt. Für Adressen, die Sie nie anschreiben möchten.
Jemanden, der sich abgemeldet oder beschwert hat, wieder auf subscribed zu setzen, sollte nur auf dessen Wunsch geschehen.
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.