Skip to main content
Skip table of contents

Single OptIn (SOI): Abfrage per E-Mail

Beschreibung des Szenarios: Einholung von Zustimmungen via Mailversand aus dem CRM

Das Consent Management-Modul bietet die Option, Zustimmungen für Werbemaßnahmen per E-Mail einzuholen. Dabei wird eine E-Mail mit einem dedizierten OptIn-Link aus dem CRM an eine Person gesendet. Über diesen Link gelangt die Person auf eine Webseite, auf der sie wiederum die Informationsarten (z.B. Newsletter) auswählen kann, zu denen sie ihre Zustimmung gibt. Das Portal überträgt die Zustimmungen bzw. Ablehnung zurück ans CRM, dort werden die bereits angelegten Consent-Datensätze mit der “finalen” Antwort geupdatet (aktives Feedback).

Klickt die Person nicht auf den Link, werden die zuvor angelegten Consent-Datensätze nach einem definierten Zeitraum auf “Ablehnung” gesetzt (passives Feedback).

Vorbereitung: Anpassung der Mailvorlage

Zur Abbildung dieses Szenarios muss die versendete Mail einen Link mit einem identifizierenden Merkmal enthalten, damit die Anzeige der richtigen Optionen sowie das Update der dazugehörigen Consent-Datensätze sichergestellt werden kann. Die Consent-Datensätze werden beim Mailversand angelegt und erhalten den Status “Angefragt”. Zur Identifikation dient die externe Referenz-ID (extRefNo), über die jede OptIn-Anfrage und der zugehörige Geschäfts-/Ansprechpartner zugeordnet werden kann.

Beispiel:

Consent-PK

Ansprechpartner

Informationsart

Ext. Referenz-ID

1

Max Mustermann

Newsletter

abc12345

2

Max Mustermann

Marktforschung

abc12345

3

Max Mustermann

Zufriedenheitsumfragen

abc12345

4

Maxime Musterfrau

Newsletter

defg6789

5

Maxime Musterfrau

Marktforschung

defg6789

6

Maxime Musterfrau

Veranstaltungseinladungen

defg6789

Die versendete E-Mail basiert auf der Vorlage C0OPTIN_SUBSCRIBE, die kundenindividuell angepasst werden muss. Die externe Referenz-ID wird in das Memofeld der zugehörigen Mailaktivität geschrieben, sodass diese in der Mailvorlage mit dem Parameter {body} verwendet werden kann. Der Link, auf den der Empfänger klicken soll, könnte beispielsweise so aufgebaut sein: https://www.firma.de/optin/parameter={body}

Die E-Mail an Max Mustermann würde den Link https://www.firma.de/optin/parameter=abc12345 enthalten. Die E-Mail an Maxime Musterfrau hätte den Link https://www.firma.de/optin/parameter=defg6789.

Anhand des mitgegebenen Parameters (=Referenznummer) kann die Webseite im CRM die anzuzeigenden Optionen anfragen und nach Beantwortung durch die Person auch wieder zurückliefern. Hierfür sollten die nachfolgenden Aufrufe genutzt werden.

Schnittstellen-Aktionen

image-20240322-091518.png

Skizzierung des Ablauf zwischen Webservice, CRM und dem Mailempfänger

Abfrage der anzuzeigenden Optionen

Beim Klick auf den Link sollen auf der Webseite nur die Informationsarten zur Zustimmung angeboten werden, die durch den Anwender beim Mailversand ausgewählt wurden. Zur Anzeige der richtigen Informationen kann die Abfrage der Schnittstelle mit der externen Referenz-ID (extRefNo der Consent-Datensätze) aus dem aufgerufenen Link erfolgen.

Es werden nur Consent-Datensätze zurückgegeben, die den Status C0OPTINSTATUS_REQUESTED  oder C0OPTINSTATUS_PENDING aufweisen. Die Optionen aus der Response sollten in dem Anmeldungsformular für den Mailempfänger zum OptIn angeboten werden.

Sollte keine Datensätze gefunden werden, wird eine leere Liste zurückgegeben. In diesem Fall sollte die Person auf eine andere Seite (z.B. ein öffentliches Anmeldungsformular) weitergeleitet werden.

Die dazugehörige Methode in der Skriptbibliothek lautet SCOptinUtils.callGetOptInsByReferenceNo .

REQUEST

GET /v1/optins/flows/{extRefNo}

CODE
none
RESPONSE
CODE
{
    "optIns": [
        {
            "pk": "1s9dh7g1hgd4117mOpIn",
            "type": "C0INFOTYPE_NEWSLETTER",
            "status": "C0OPTINSTATUS_REQUESTED",
            "extRefNo": "999c02ad-dff9-4540-9af8-b3c6e8ca6e63"
        },
        {
            "pk": "9pmpq1hgd4117eOpIn",
            "type": "C0INFOTYPE_PRODUCTINFO",
            "status": "C0OPTINSTATUS_REQUESTED",
            "extRefNo": "999c02ad-dff9-4540-9af8-b3c6e8ca6e63"
        },
        {
            "pk": "fvvvvvuevpqlk1hgd4117uOpIn",
            "type": "C0INFOTYPE_SURVEYS",
            "status": "C0OPTINSTATUS_REQUESTED",
            "extRefNo": "999c02ad-dff9-4540-9af8-b3c6e8ca6e63"
        }
    ],
    "properties": {
        "contactId": "example@example.com",
        "pk": "pk123",
        "adBlocked": false
    }
}

Übermittlung der aktualisierten Consent-Informationen an das CRM

Sobald der Empfänger auf der Webseite seine Zustimmung für ein oder mehrere Informationsarten gesetzt hat, wird die Auswahl der Zustimmungen bzw. Ablehnungen für jeden Typ zurückgesendet. Optional können hier auch weitere Informationen (wie z.B. Herkunft) mitgegeben werden.

REQUEST

PUT /v1/optins/flows/{extRefNo}

CODE
[
    {
        "type": "C0INFOTYPE_NEWSLETTER",
        "approval": "Zus_C0Approval"
    },
    {
        "type": "C0INFOTYPE_PRODUCTINFO",
        "approval": "Zus_C0Approval"      
    },
    {
        "type": "C0INFOTYPE_SURVEYS",
        "approval": "Abl_C0Approval"
    }
]
RESPONSE
CODE
{
    "extRefNo": "999c02ad-dff9-4540-9af8-b3c6e8ca6e63",
    "optIns": [
        {
            "pk": "1s9dh7g1hgd4117mOpIn",
            "type": "C0INFOTYPE_NEWSLETTER",
            "status": "C0OPTINSTATUS_CURRENT",
            "approval": "Zus_C0Approval",
            "extRefNo": "999c02ad-dff9-4540-9af8-b3c6e8ca6e63"
        },
        {
            "pk": "9pmpq1hgd4117eOpIn",
            "type": "C0INFOTYPE_PRODUCTINFO",
            "status": "C0OPTINSTATUS_CURRENT",
            "approval": "Zus_C0Approval",
            "extRefNo": "999c02ad-dff9-4540-9af8-b3c6e8ca6e63"
        },
        {
            "pk": "fvvvvvuevpqlk1hgd4117uOpIn",
            "type": "C0INFOTYPE_SURVEYS",
            "status": "C0OPTINSTATUS_CURRENT",
            "approval": "Abl_C0Approval",
            "extRefNo": "999c02ad-dff9-4540-9af8-b3c6e8ca6e63"
        }
    ],
    "result": {
        "status": "Success",
        "code": 200
    }
}

Fehlerfälle

  • 521 - Keine Datensätze für extRefNo gefunden

  • 522 - Ungenügend Daten übergeben

  • 525 - Fehler beim Mailversand

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.