Empfänger importieren

Die Methode ImportSubscribers ermöglicht es, Empfänger in die eworx Marketing Suite zu importieren.

Request Properties

Subscribers
Liste der Empfänger, die importiert werden sollen.
Typ der Eigenschaft: Liste von Subscriber

DuplicateCriteria
Der interne Name des Empfängerfeldes, das als Duplikatskriterium verwendet werden soll.
Typ der Eigenschaft: STRING

BeforeImportActions
Die Aktionen, die vor dem Importieren aller Empfänger ausgeführt werden sollen.
Typ der Eigenschaft: Liste von BeforeImportAction

PreSubscriberActions
Die Aktionen, die vor dem Importieren jedes einzelnen Empfängers ausgeführt werden sollen. Aktuell gibt es noch keine konkreten PreSubscriberActions, die hier angegegeben werden könnten.
Typ der Eigenschaft: Liste von PreSubscriberAction

PostSubscriberActions
Die Aktionen, die nach dem Importieren jedes einzelnen Empfängers ausgeführt werden sollen.
Typ der Eigenschaft: Liste von PostSubscriberAction

AfterImportActions
Die Aktionen, die nach dem Importieren aller Empfänger ausgeführt werden sollen.
Typ der Eigenschaft: Liste von AfterImportAction

SubscriberFieldsToIgnore
Die Empfängerfelder, die bei diesem Import ignoriert bzw. nicht mit importiert werden sollen.
Typ der Eigenschaft: Liste von STRING

ValidateSelectionFieldValues
Gibt an ob die im UntypedValue angegebenen Namen der Auswahlmöglichkeiten von (Mehrfach-)Auswahlfeldern auf Existenz geprüft werden sollen oder nicht.
Typ der Eigenschaft: BOOL
Optional, Standardwert: False

Beispiel Request „Empfänger importieren“

Der folgende Request importiert die Empfänger mit den definierten Daten in die eworx Marketing Suite.
Es wird im Vorhinein mit Hilfe einer BeforeImportAction anhand der E-Mail Adresse überprüft, ob in der Menge an übergebenen Empfänger Duplikate enthalten sind und diese gegebenenfalls entfernt.
Die übrigen Empfänger werden importiert. Es wird anhand der E-Mail Adresse abgeglichen, ob die Empfänger schon bestehen oder neu angelegt werden müssen.
Ist der Import abgschlossen, so wird aufgrund der übergebenen AfterImportAction ein Benachrichtigungsmail verschickt.

//https://mailworx.marketingsuite.info/Services/JSON/ServiceAgent.svc/ImportSubscribers
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "****",
      "Source": "application name"
    },
    "Subscribers": [
      {
        "Language": "DE",
        "OptIn": "true",
        "DOIStatus": 1,
        "Fields": [
          {
            "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
            "InternalName": "firstname",
            "UntypedValue": "Max"
          },
          {
            "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
            "InternalName": "lastname",
            "UntypedValue": "Mustermann"
          },
          {
            "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
            "InternalName": "email",
            "UntypedValue": "max.mustermann@mailworx.info"
          }
          // Sample Selection field
          //,{
          //  "__type": "SelectionField:#Eworx.Mailworx.ServiceInterfaces",
          //  "InternalName": "interessen",
          //  "UntypedValue": "interessen_reisen,interessen_lesen"
          //}
        ]
      },
      {
        "Language": "DE",
        "OptIn": "true",
        "DOIStatus": 1,
        "Fields": [
          {
            "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
          "InternalName": "firstname",
          "UntypedValue": "Max"
          },
          {
            "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
            "InternalName": "lastname",
            "UntypedValue": "Duplikat"
          },
          {
            "__type": "TextField:#Eworx.Mailworx.ServiceInterfaces",
            "InternalName": "email",
            "UntypedValue": "max.mustermann@mailworx.info"
          }
          // Sample Selection field
          //,{
          //  "__type": "SelectionField:#Eworx.Mailworx.ServiceInterfaces",
          //  "InternalName": "interessen",
          //  "UntypedValue": "interessen_kochen"
          //}
        ]
      }
    ],
    "DuplicateCriteria": "email",
    "ValidateSelectionFieldValues": true,
    "BeforeImportActions": [{
      "__type": "RemoveDuplicatesAction:#Eworx.Mailworx.ServiceInterfaces.Subscribers.SubscriberImport",
      "DuplicateProperty": "email",
      "IsMetaInfo": "false"
    }],
    "AfterImportActions": [{
      "__type": "SendNotificationAction:#Eworx.Mailworx.ServiceInterfaces.Subscribers.SubscriberImport",
      "FromEmail": "service@mailworx.info",
      "FromName": "mailworx Import",
      "RecipientEmail": "customer@mailworx.info",
      "RecipientName": "mailworx Customer",
      "Subject": "Import completed",
      "Body": "Your import was successfully completed."
    }]
  }
}

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
               xmlns:ser="http://www.mailworx.at/interfaces/serviceagent/"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Header/>
  <soap:Body>
    <ser:ImportSubscribers>
      <ser:request>
        <ser:Language>DE</ser:Language>
        <ser:SecurityContext>
          <ser:Account>account</ser:Account>
          <ser:Username>username</ser:Username>
          <ser:Password>*****</ser:Password>
          <ser:Source>application name</ser:Source>
        </ser:SecurityContext>
        <ser:Subscribers>
          <ser:Subscriber>
            <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
            <ser:Language>DE</ser:Language>
            <ser:OptIn>true</ser:OptIn>
            <ser:DOIStatus>DocumentedExternally</ser:DOIStatus>
            <ser:Fields>
              <ser:Field xsi:type="ser:TextField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>firstname</ser:InternalName>
                <ser:UntypedValue>Max</ser:UntypedValue>
              </ser:Field>
              <ser:Field xsi:type="ser:TextField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>lastname</ser:InternalName>
                <ser:UntypedValue>Mustermann</ser:UntypedValue>
              </ser:Field>
              <ser:Field xsi:type="ser:TextField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>email</ser:InternalName>
                <ser:UntypedValue>max.mustermann@mailworx.info</ser:UntypedValue>
              </ser:Field>
              <!-- Sample selection field -->
              <!--
              <ser:Field xsi:type="ser:SelectionField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>interessen</ser:InternalName>
                <ser:UntypedValue>interessen_reisen,interessen_lesen</ser:UntypedValue>
              </ser:Field>
              -->
            </ser:Fields>
          </ser:Subscriber>
          <ser:Subscriber>
            <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
            <ser:Language>DE</ser:Language>
            <ser:OptIn>true</ser:OptIn>
            <ser:DOIStatus>DocumentedExternally</ser:DOIStatus>
            <ser:Fields>
              <ser:Field xsi:type="ser:TextField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>firstname</ser:InternalName>
                <ser:UntypedValue>Max</ser:UntypedValue>
              </ser:Field>
              <ser:Field xsi:type="ser:TextField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>lastname</ser:InternalName>
                <ser:UntypedValue>Duplikat</ser:UntypedValue>
              </ser:Field>
              <ser:Field xsi:type="ser:TextField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>email</ser:InternalName>
                <ser:UntypedValue>max.mustermann@mailworx.info</ser:UntypedValue>
              </ser:Field>
              <!-- Sample selection field -->
              <!--
              <ser:Field xsi:type="ser:SelectionField">
                <ser:Guid>00000000-0000-0000-0000-000000000000</ser:Guid>
                <ser:InternalName>interessen</ser:InternalName>
                <ser:UntypedValue>interessen_reisen,interessen_lesen</ser:UntypedValue>
              </ser:Field>
              -->
            </ser:Fields>
          </ser:Subscriber>
        </ser:Subscribers>
        <ser:DuplicateCriteria>email</ser:DuplicateCriteria>
        <ser:ValidateSelectionFieldValues>true</ser:ValidateSelectionFieldValues>
        <ser:BeforeImportActions>
          <ser:BeforeImportAction xsi:type="ser:RemoveDuplicatesAction">
            <ser:DuplicateProperty>email</ser:DuplicateProperty>
            <ser:IsMetaInfo>false</ser:IsMetaInfo>
          </ser:BeforeImportAction>
        </ser:BeforeImportActions>
        <ser:AfterImportActions>
          <ser:AfterImportAction xsi:type="ser:SendNotificationAction">
            <ser:FromEmail>service@mailworx.info</ser:FromEmail>
            <ser:FromName>mailworx Import</ser:FromName>
            <ser:RecipientEmail>customer@mailworx.info</ser:RecipientEmail>
            <ser:RecipientName>mailworx Customer</ser:RecipientName>
            <ser:Subject>Import completed</ser:Subject>
            <ser:Body>Your import was successfully completed.</ser:Body>
          </ser:AfterImportAction>
        </ser:AfterImportActions>
      </ser:request>
    </ser:ImportSubscribers>
  </soap:Body>
</soap:Envelope>

Response Objekt

Imported
Die Anzahl der neu importierten Empfänger.
Typ der Eigenschaft: INT

Updated
Die Anzahl der bereits bestehenden Empfänger, die aktualisiert wurden.
Typ der Eigenschaft: INT

Duplicates
Die Anzahl der Empfänger, die als Duplikate erkannt wurden.
Typ der Eigenschaft: INT

Errors
Die Anzahl der Empfänger, bei denen ein Fehler aufgetreten ist.
Typ der Eigenschaft: INT

ImportActionErrors
Anzahl der Empfänger mit Fehlern bei der AfterImportAction SendTriggerMailAction
Typ der Eigenschaft: INT

FeedbackData
Eine Liste mit den Informationen, welche Aktionen für die einzelnen Empfänger durchgeführt wurden bzw. Details zu den Fehlern, die aufgetreten sind.
Typ der Eigenschaft: Liste von SubscriberResponseEntry