Erstellen einer Kampagne

Die Methode CreateCampaign ermöglicht es, eine Kampagne mit Basisinformationen zu erstellen.

Um diese Methode benutzen zu können, müssen folgende Properties des Campaign-Objekts angegeben werden: Name, SenderAddress, SenderName, Subject. Wenn mehr als eine Vorlage in dem zu benutzenden Mandanten existiert, muss auch TemplateGuid gesetzt werden.

Bei dem EmailCampaign-Property ist es ausreichend, den Namen des Themenbereiches anzugeben

Request Properties

Campaign
Die zu erstellende Kampagne. Hier werden alle Informationen zugewiesen, die die zu erstellende Kampagne haben soll.
Typ der Eigenschaft: Campaign

Beispiel Request "Kampagne erstellen"

Der folgende Request erstellt eine neue Kampagne mit den gegebenen Basisinformationen.

JSON

//https://sys.mailworx.info/Services/JSON/ServiceAgent.svc/CreateCampaign
{
  "request": {
    "Language": "DE",
    "SecurityContext": {
      "Account": "account",
      "Username": "username",
      "Password": "**********",
      "Source": "application name"
    },
    "Campaign": {
      "TemplateGuid": "70a0b8af-f946-4663-a8c9-46bc699b2263",
      "Name": "APICampaign",
      "SenderAddress": "sender@provider.com",
      "SenderName": "Sender",
      "Subject": "SubjectOfCampaign", 
      "CampaignTopic": {
        "Name": "Test"
      },
      "ShowUnsubscribe": true,
      "ShowForward": false
    }
  }
}

XML

<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:CreateCampaign>
      <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:Campaign>
          <ser:TemplateGuid>70a0b8af-f946-4663-a8c9-46bc699b2263</ser:TemplateGuid>
          <ser:Name>APICampaign</ser:Name>
          <ser:SenderAddress>sender@provider.com</ser:SenderAddress>
          <ser:SenderName>Sender</ser:SenderName>
          <ser:Subject>SubjectOfCampaign</ser:Subject>
          <ser:ShowUnsubscribe>1</ser:ShowUnsubscribe>
          <ser:ShowForward>0</ser:ShowForward>
          <ser:AllowCopy>1</ser:AllowCopy>
          <ser:CampaignTopic>
            <ser:Name>Test</ser:Name>
          </ser:CampaignTopic>
        </ser:Campaign>
      </ser:request>
    </ser:CreateCampaign>
  </soap:Body>
</soap:Envelope>

Response Objekt

Guid
Die Guid der neu erstellten Kampagne.
Typ der Eigenschaft: GUID

Newsletter Anmeldung

Tipps, Tricks und viele weitere nützliche Informationen direkt in Ihre Mailbox. Jetzt mailworx Newsletter abonnieren!