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.

POSThttps://g.sendcorex.com/v1/contactscommand: set_status
i

Erfordert den Scope contact:update auf Ihrem API Key.

i

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[]optional

    Bis zu 500 E-Mails. Groß-/Kleinschreibung und umgebende Leerzeichen werden ignoriert, doppelte E-Mails zählen einmal.

  • emailstringoptional

    Eine einzelne E-Mail. Verwenden Sie dies oder emails.

  • statusstringerforderlich

    subscribed, unsubscribed, bounced, complained oder blocked.

    z. B. "unsubscribed"

  • reasonstringoptional

    Warum sich der Status geändert hat. Wird in status_reason gespeichert.

    z. B. "asked by email"

  • return_contactsbooleanoptional

    Fü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[].id

    Die gesendete E-Mail, so wie Sie sie gesendet haben.

  • items[].ok

    true, wenn diese E-Mail erfolgreich war. Bei false enthält der Eintrag code und message.

  • items[].data.changed

    false bedeutet, dass der Kontakt schon so war und nichts geschrieben wurde.

  • items[].data.contact

    Der vollständige Kontakt nach der Änderung. Nur mit return_contacts: true.

  • ok_count / failed_count

    Wie viele E-Mails erfolgreich waren und wie viele fehlgeschlagen sind.

Status

  • subscribed

    Kann E-Mails der Listen erhalten, für die er angemeldet ist.

  • unsubscribed

    Hat gebeten, keine E-Mails mehr zu erhalten.

  • bounced

    Die Adresse nimmt keine E-Mails an.

  • complained

    Hat eine Ihrer E-Mails als Spam markiert.

  • blocked

    Von 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.

  • 401INVALID_API_KEY

    Der API Key existiert nicht, wurde widerrufen oder im Dashboard deaktiviert.

  • 429RATE_LIMITED

    Mehr als 15 Requests/s oder 15 gleichzeitig für dieselbe IP + API Key. Warten Sie die Sekunden aus Retry-After ab.

  • CMDMISSING_SCOPE

    Dem API Key fehlt der Scope, den dieser Befehl braucht. Die anderen Befehle im Request laufen trotzdem.

  • CMDINVALID_ARGS

    Ein Pflichtargument fehlt oder ist ungültig: E-Mail, Feldwert, Enum-Option, where-Schlüssel, Listen-ID …

  • CMDNOT_FOUND

    Der Kontakt, die Liste, das Feld oder das Segment existiert nicht.

  • CMDINTERNAL

    Serverfehler. Details werden nur ins Server-Log geschrieben.