Kontakte: Listen

Listenabo festlegen

Melden Sie bis zu 500 Kontakte von einer Liste ab oder wieder an, ohne ihre anderen Listen oder den globalen Status zu ändern.

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

Erfordert den Scope contact:update auf Ihrem API Key.

i

Kontakte, die nicht Mitglied der Liste sind, bleiben unverändert und kommen mit changed: false zurück. Machen Sie sie zuerst mit Add To Lists zu Mitgliedern.

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.

  • list_idstringerforderlich

    Die Liste.

    z. B. "newsletter"

  • subscribedbooleanerforderlich

    false meldet von dieser Liste ab, true meldet wieder an.

  • 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_list_subscription",
        args: {
          emails: [
            "bob@gmail.com"
          ],
          list_id: "newsletter",
          subscribed: false
        }
      }
    ]
  },
  { 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_list_subscription",
      "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.

Listenanmeldung oder globaler Status?

  • Set List Subscription

    Die Person möchte Ihre anderen Listen weiterhin. Sie bleibt hier Mitglied, als abgemeldet markiert, und ist nur in dieser Liste nicht mehr anschreibbar.

  • Set Status

    Die Person möchte gar keine E-Mails mehr, oder die Adresse hat gebounct. Sendable wird in jeder Liste false.

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.