Kontakte: Tags, Status und Felder
Tags hinzufügen
Fügen Sie bis zu 500 Kontakten ein oder mehrere Tags hinzu. Tags werden bei Bedarf angelegt und ignorieren Groß-/Kleinschreibung und Akzente.
https://g.sendcorex.com/v1/contactscommand: add_tagsErfordert den Scope contact:update auf Ihrem API Key.
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.tagsstring[]erforderlichDie hinzuzufügenden Tags.
"Black Friday"und"black friday"sind dasselbe Tag.z. B.
["black-friday"]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_tags",
args: {
emails: [
"ana@acme.com",
"bob@gmail.com"
],
tags: [
"black-friday"
]
}
}
]
},
{ 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_tags",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "ana@acme.com",
"ok": true,
"data": {
"changed": true
}
},
{
"id": "bob@gmail.com",
"ok": true,
"data": {
"changed": true
}
}
],
"ok_count": 2,
"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.
Alle Treffer einer Abfrage taggen
Kombinieren Sie es mit Query Contacts und $ref, um ein ganzes Segment in einem Request zu taggen, ohne die E-Mails durch Ihre App zu leiten.
Request-Body
{
"commands": [
{
"command": "query_contacts",
"id": "q",
"args": {
"where": {
"last_open_at": {
"within_days": 7
}
},
"select": [
"email"
],
"limit": 500
}
},
{
"command": "add_tags",
"args": {
"emails": {
"$ref": "q",
"path": "contacts/*/email"
},
"tags": [
"active-this-week"
]
}
}
]
}Ein Kontakt hat bis zu 50 Tags. Die Tag-Zahlen pro Konto finden Sie in Get Stats.
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.