SOAP Mailing – Evalanche Helpcenter

The following SOAP methods are provided specifically for interaction with e-mailings.

copy

Creates a copy of the resource specified by resource_id

EvalancheResourceInformation copy (int resource_id, int category_id)

Details: copy

delete

Deletes the resource.

bool delete (int resource_id)

Details: delete

getAll

Lists all resources within a client.

ArrayOfEvalancheResourceInformation getAll (int mandator_id)

Details: getAll

getByCategory

Returns all objects of a folder.

ArrayOfEvalancheResourceInformation getByCategory (int category_id)

Details: getByCategory

getByExternalId

Outputs all direct mailing templates with a given EXTERNAL_ID.

ArrayOfEvalancheResourceInformation[] getByExternalId ( string external_id )

Details: getByExternalId

getById

Searches for a object using an ID.

EvalancheHashMap Profile::getById( int resource_id )

Details: getById

getByModificationDate

Requesting an object via modification date

EvalancheResourceInformation getByModificationDate (int start_date, int end_date, int mandator_id)

Details: getByModificationDate

getByTypeId

Retrieve all resources within this namespace with the specified resource type ID (see the getTypeIds method).

ArrayOfEvalancheResourceInformation getByTypeId (int type_id, int mandator_id)

Details: getByTypeId

getJobInformation

Get information about a running background job

getJobInformationResponse getJobInformation (string job_Id)

Details

Parameter

string job_id: Id of background job

Return value

EvalancheJobHandle: An object with following attributes:
- string id: Id of background job
- int status: The status of the background job, including the possible values.:
  - 0: Queue
  - 1: In progress
  - 2: Ready
  - 3: Temporary error (processing will be retried)
  - 4: Error
string status_description: Description of status
namespace: Namespace under which the background job was started; here, always ‚mailing‘
string method: Name of the method that started the background job
int resource_id: Id of the resource for which the background job was started.
int result_chunks: Number of result blocks found. This value is non-zero only in status 2.

Required rights

View target group and export profiles

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getJobInformation>
 <job_id>JOB_ID</job_id>
 </mail:getJobInformation>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getJobInformationResponse>
 <getJobInformationResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_DESCRIPTION</status_description>
 <namespace>NAMESPACE</namespace>
 <method>METHOD</method>
 <resource_id>RESOURCE_ID</resource_id>
 <result_chunks>RESULT_CHUNKS</result_chunks>
 </getJobInformationResult>
 </ns1:getJobInformationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getJobState

Retrieves the state of a generic background-job

EvalancheResourceInformation getJobState (str job_id)

Details: getJobState

getResourceDefaultCategory

Provides information about the default folder of objects

getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)

Details: getResourceDefaultCategory

getTypeIds

Reading the type Ids belonging to an object class

ArrayOfEvalancheResourceInformation getTypeIds ()

Details: getTypeIds

get

Returns the list of recipients:

getRecipientsProfiles ( int mailing_id, string[] attribute_names )

Returns the list of openers:

getImpressionProfiles ( int mailing_id, string[] attribute_names )

Returns the list of multiple openers:

getMultipleImpressionProfiles ( int mailing_id, string[] attribute_names )

Returns the list of clickers:

getClickProfiles ( int mailing_id, string[] attribute_names )

Returns the list of multiple clickers:

getMultipleClickProfiles ( int mailing_id, string[] attribute_names )

Returns the list of profiles that have generated a soft or hard bounce:

getBounceProfiles ( int mailing_id, string[] attribute_names )

Returns the list of profiles that have generated a hard bounce:

getHardbounceProfiles ( int mailing_id, string[] attribute_names )

Returns the list of profiles that have generated a soft bounce:

getSoftbounceProfiles ( int mailing_id, string[] attribute_names )

Returns the list of profiles that have unsubscribed from the mailing:

getUnsubscriptionProfiles ( int mailing_id, string[] attribute_names )

Returns the list of profiles that clicked on any article in the mailing:

getAllArticleImpressionProfiles ( int mailing_id, string[] attribute_names )

Returns the list of profiles that clicked any link in the mailing:

getAllLinkClickProfiles ( int mailing_id, string[] attribute_names )

Returns the list of clickers for a specific item:

getArticleImpressionProfiles ( int mailing_id, int article_id, string[] attribute_names )

Returns the list of clickers for a specific link:

getLinkClickProfiles ( int mailing_id, int link_id, string[] attribute_names )

Details

Parameters

int mailing_id: Id of the direct mailing for which the recipient data is to be requested
int article_id: ( only at getArticleImpressionProfiles): Id of the article for which the clickers are to be returned
int link_id: ( only at (getLinkClickProfiles): Id of the link for which the clickers should be returned
string[] attribute_names: List of pool attribute names to be returned in the result

Return value

EvalancheJobResult: Information on the background job, analogous to the export of all profiles in a pool or under Working with Background Jobs

Required rights

Viewing eMailing and Exporting Profiles

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getRecipientsProfiles>
 <mailing_id>MAILING_ID</mailing_id>
 <attribute_names>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </attribute_names>
 </mail:getRecipientsProfiles>
 </soapenv:Body>
</soapenv:Envelope></soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getRecipientsProfilesResponse>
 <getRecipientsProfilesResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_DESCRIPTION</status_description>
 <namespace>NAMESPACE</namespace>
 <method>METHOD</method>
 <resource_id>RESOURCE_ID</resource_id>
 <result_chunks>RESULT_CHUNKS</result_chunks>
 </getRecipientsProfilesResult>
 </ns1:getRecipientsProfilesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getContentContainerData

Read the ContentContainer of an eMailing

EvalancheHashMap getContentContainerData (int mailing_id)

Details

Parameters

int resource_id: ID of the eMailing

Return value

EvalancheHashMap: EvalancheHashMap mit den Daten des eMailings

Required rights

Container anzeigen

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<mail:getContentContainerData>
<resource_id>MAILING_ID</resource_id>
</mail:getContentContainerData>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailing">
<SOAP-ENV:Body>
<ns1:getContentContainerDataResponse>
<getContentContainerDataResult>
<items>
<item>
<key>CONTAINER_FIELD_NAME</key>
<value>CONTAINER_FIELD_CONTENT</value>
</item>
</items>
</getContentContainerDataResult>
</ns1:getContentContainerDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setContentContainerData

Update the ContentContainer of an eMailings

EvalancheResourceInformation setContentContainerData (int mailing_id, EvalancheHashMap data)

Details

Parameter

int resource_id: ID of the eMailing
EvalancheHashMap data: EvalancheHashMap with the data of the container

Return value

EvalancheResourceInformation: EvalancheHashMap with the data of the eMailing

Required rights

update Container

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<mail:setContentContainerData>
<resource_id>MAILING_ID</resource_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>CONTAINER_FIELD_NAME</key>
<value>CONTAINER_FIELD_CONTENT</value>
</item>
</items>
</data>
</mail:setContentContainerData>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailing">
<SOAP-ENV:Body>
<ns1:setContentContainerDataResponse>
<setContentContainerDataResult>
<url>MAILING_URL</url>
<type_id>MAILING_TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTOMER_ID</customer_id>
<id>MAILING_ID</id>
<name>MAILING_NAME</name>
</setContentContainerDataResult>
</ns1:setContentContainerDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getDetails

Query details of a shipment

EvalancheMailingInformation getDetails( int mailing_id )

Details

Parameters

int mailing_id: Id of dispatch

Return value

EvalancheMailingInformation: Object (SOAP) or array with the following attributes:
int timestamp: Timestamp of the mailing
int recipients: Number of recipients
bool sent: true, when the mailing has been sent in full
string preview_url: URL to the preview of the dispatch
string report_url: URL to the statistics page of the dispatch
string admin_url: URL to the administration page of the dispatch
string subject: Standard subject line of the dispatch
int targetgroup_id: Id of the target group to which the mailing was sent
int send_start_time: Unix timestamp of the dispatch start
int send_end time: Unix timestamp of the dispatch end

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getDetails>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getDetails>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getDetailsResponse>
 <getDetailsResult>
 <timestamp>TIMESTAMP</timestamp>
 <recipients>RECIPIENTS</recipients>
 <sent>true/false</sent>
 <preview_url xsi:nil="true"/>
 <report_url>REPORT_URL</report_url>
 <admin_url>OBJECT_URL</admin_url>
 <subject>SUBJECT</subject>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <send_start_time>TIMESTAMP_START_TIME</send_start_time>
 <send_end_time>TIMESTAMP_END_TIME</send_end_time>
 <url>EXTERNAL_REPORT_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR_ID</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </getDetailsResult>
 </ns1:getDetailsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getImpressions

Query openings / impressions of a shipment

EvalancheMailingImpression[] getImpressions( int mailing_id, int start_timestamp = 0, int end_timestamp = 0 )

Details

Parameters

int mailing_id: Id of dispatch
int start_timestamp = 0: UTC Unix Timestamp, from which time on tracking data should be considered
int end_timestamp = 0: UTC Unix timestamp, up to and including which time tracking data should be considered

Return value

EvalancheMailingImpression[]: List of objects with the following attributes:
- int id: Unique Id of the tracking data record
- int profile_id: Id of the user who performed the action
- int timestamp: UTC Unix timestamp of the action

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getImpressions>
 <mailing_id>MAILING_ID</mailing_id>
 <start_timestamp>START_TIMESTAMP</start_timestamp>
 <end_timestamp>END_TIMESTAMP</end_timestamp>
 </mail:getImpressions>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getImpressionsResponse>
 <getImpressionsResult>
 <item>
 <id>IMPRESSION_ID</id>
 <profile_id>PROFILE_ID</profile_id>
 <timestamp>IMPRESSION_TIMESTAMP</timestamp>
 </item>
[...]
 </getImpressionsResult>
 </ns1:getImpressionsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getClicks

Query clicks of a dispatch

EvalancheMailingClick[] getClicks( int mailing_id, int start_timestamp = 0, int end_timestamp = 0 )

Details

Parameters

int mailing_id: Id of dispatch
int start_timestamp = 0: UTC Unix Timestamp, from which time on tracking data should be considered
int end_timestamp = 0: UTC Unix timestamp, up to and including which time tracking data should be considered

Return value

- EvalancheMailingClick[]: List of objects with the following attributes:
  - - int id: Unique Id of the tracking data record
    - int profile_id: Id of the user who performed the action
    - int timestamp: UTC Unix timestamp of the action
    - int link_id: Id of the link for which a click was recorded. If the value -1 is returned here, the parent_id observable
    - int link_type_id: Format of the resource in which the user performed the action.
      The following values are possible:
      0: Unknown
      1: Online view of a newsletter
      2: PDF view of an article or newsletter
      3: Text view of the newsletter
      4: Web/Mobile view of the newsletter
      5: Landingpage of an article
      6: Click on Landingpage link
      7: LeadPage opening
      11: XSL-FO view of an article or newsletter
      12: Display of the RSS feed of a newsletter
      19: Newsletter opening
      20: External link
      21: Display of the ATOM feed of a newsletter
      22: Call up read aloud service for an article or a newsletter
      23: Reading of articles or newsletter data by the reading service
      24: Calling the reading service for a newsletter Podcast
      25: Reading of podcast data by the reading service
      40: Article shared in Facebook
      41: Article shared in Google Bookmarks
      42: Article shared in MySpace
      43: Article shared in del.icio.us
      44: Article shared on Twitter
      45: Article shared on Xing
      46: Article shared on LinkedIn
      47: Article shared on Google+
      50: Click on article shared on Facebook
      51: Click on article shared on Google Bookmarks
      52: Click on article shared on MySpace
      53: Click on article shared on del.icio.us
      54: Click on shared article in Twitter
      55: Click on shared article in Xing
      59: Click on shared article in LinkedId
      60: Click on shared article in Google+
    - int parent_id: Id of the resource where the link was clicked, either the mailing id or the article reference id.

Explanation of ``link_id'' and ``parent_id'':

The link_id only has a value greater than or equal to 0 if it is a "normal" link. Clicks on e.g. landing page links, PDF generation, voice, etc. always have a link_id link_id equal to -1.

In this case, the parent_id must be used for closer examination:

If the parent_id is equal to the passed mailing_id, the click took place in the mailing or the mailing was presented in the format of link_type_id. This may have been a click on read aloud or PDF generation in the mailing itself, for example.
If the parent_id is not equal to the passed mailing_id, the click referred to the article reference with the id equal to the parent_id, e.g. by clicking on a sharing link of the article.

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getClicks>
 <mailing_id>MAILING_ID</mailing_id>
 <start_timestamp>START_TIMESTAMP</start_timestamp>
 <end_timestamp>END_TIMESTAMP</end_timestamp>
 </mail:getClicks>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getClicksResponse>
 <getClicksResult>
 <item>
 <id>TRACKING_ID</id>
 <profile_id>PROFILE_ID</profile_id>
 <timestamp>TRACKING_TIMESTAMP</timestamp>
 <link_id>LINK_ID</link_id>
 <link_type_id>LINK_TYPE_ID</link_type_id>
 <parent_id>PARENT_ID</parent_id>
 </item>
[...]
 </getClicksResult>
 </ns1:getClicksResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getStatistics

Query cumulative statistics for a shipment

EvalancheMailingStatistics getStatistics( int mailing_id )

Details

Parameters

int mailing_id: Id of dispatch

Return value

EvalancheMailingStatistics: Object (SOAP) or array with the following attributes:
int addressees: number of addressees
int recipients: Number of recipients
int duplicates: Number of profiles ignored by the duplicate check
int blacklisted: Number of profiles ignored by blacklisting
int robinsonlisted: Number of profiles ignored by the Robinson list
int hardbounces: Number of hardbounces
int softbounces: Number of soft bounces
int unsubscribes: Number of logouts
int impressions: Number of openings
int unique_impressions: Number of openers
int clicks: Number of clicks
int unique_clicks: Number of unique clicks
EvalancheMediaStatistics media: Object (SOAP) or array with the following attributes:
- string name: Name of the medium
- int clicks: Number of clicks
- int unique_clicks: Number of clickers
EvalancheArticleStatistics articles: Object (SOAP) or array with the following attributes:
- int id: Id of the article
- string name: Name of the article
- int clicks: Number of clicks
- int unique_clicks: Number of clickers
EvalancheLinkStatistics left: Object (SOAP) or array with the following attributes:
- int id: Id of the link
- string name: URL of the link
- int clicks: Number of clicks
- int unique_clicks: Number of clickers
- string url: URL of the link

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getStatistics>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getStatisticsResponse>
 <getStatisticsResult>
 <addressees>ADRESS_COUNT</addressees>
 <recipients>RECIPIENTS_COUNT</recipients>
 <duplicates>DUPLICATES_COUNT</duplicates>
 <blacklisted>BLACKLISTED_COUNT</blacklisted>
 <robinsonlisted>ROBINSONLISTED_COUNT</robinsonlisted>
 <hardbounces>HARDBOUNCE_COUNT</hardbounces>
 <softbounces>SOFTBOUNCE_COUNT</softbounces>
 <unsubscribes>UNSUBSCRIPTIONS_COUNT</unsubscribes>
 <impressions>IMPRESSIONS_COUNT</impressions>
 <unique_impressions>UNIQUE_IMPRESSIONS_COUNT</unique_impressions>
 <clicks>CLICKS_COUNT</clicks>
 <unique_clicks>UNIQUE_CLICKS_COUNT</unique_clicks>
 <media>
 <item>
 <name>MEDIA_NAME</name>
 <clicks>MEDIA_CLICKS</clicks>
 <unique_clicks>MEDIA_UNIQUE_CLICKS</unique_clicks>
 </item>
[...]
 </media>
 <articles>
 <item>
 <id>ARTICLE_UNIQUE_ID</id>
 <name>ARTICLE_NAME</name>
 <clicks>ARTICLE_CLICKS</clicks>
 <unique_clicks>ARTICLE_UNIQUE_CLICKS</unique_clicks>
 </item>
[...]
 </articles>
 <links>
 <item>
 <id>LINK_ID</id>
 <name>LINK_NAME</name>
 <clicks>LINK_CLICKS</clicks>
 <unique_clicks>LINK_UNIQUE_CLICKS</unique_clicks>
 <url>LINK_URL</url>
 </item>
[...]
 </links>
 </getStatisticsResult>
 </ns1:getStatisticsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getArticleStatistics

Query detailed article statistics of a shipment

ArticleStats[] getArticleStatistics( int mailing_id )

Details

Parameters

int mailing_id: Id of dispatch

Return value

ArticleStats[]: List of objects with the following attributes:
- int id: Id of the article
- int reference_id: Id of the article reference (link between article and dispatch)
- string name: Name of the article
- ArticleFormatStats overall: Statistics of the article on all output formats
- ArticleFormatStats landingpage: Statistics of the Landinpage clicks of the article
- ArticleFormatStats print: Statistics of PDF/Print clicks of the article
- ArticleFormatStats voice: Statistics of the voice clicks of the article
- ArticleFormatStats social_sharing: Statistics of the Share to Social clicks of the article
- Objects of type ArticleFormatStats have the following attributes:
  - int clicks: Number of clicks on the corresponding format of the article
  - int unique_clicks: Number of unique clicks on the corresponding format of the article
  - float clickrate: Click rate of the corresponding format of the article
  - float clickrate_relative: Relative click rate of the corresponding format of the article
  - float multiple_clickrate: Multiple click rate of the corresponding format of the article
  - float multiple_clickrate_relative: Relative multiple click rate of the corresponding format of the article
- ArticleLinkStats[] left: List of objects with the following attributes:
  - int id: Link Id
  - string url: Link Url
  - string name: Name of the link
  - int clicks: Number of clicks on this link
  - int unique_clicks: Number of unique clicks on this link

Required rights

none

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getArticleStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getArticleStatistics>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getArticleStatisticsResponse>
 <getArticleStatisticsResult>
 <item>
 <id>23838448</id>
 <reference_id>8617177</reference_id>
 <name>Die wunderbare Kraft der Sonnenblume</name>
 <overall>
 <clicks>OVERALL_CLICKS</clicks>
 <unique_clicks>OVERALL_UNIQUE_CLICKS</unique_clicks>
 <clickrate>OVERALL_CLICKRATE</clickrate>
 <clickrate_relative>OVERALL_CLICKRATE_RELATIVE</clickrate_relative>
 <multiple_clickrate>OVERALL_CLICKRATE_MULTIPLE</multiple_clickrate>
 <multiple_clickrate_relative>OVERALL_MULTIPLE_CLICKRATE_RELATIVE</multiple_clickrate_relative>
 </overall>
 <landingpage>
[...]
 </landingpage>
 <print>
[...]
 </print>
 <voice>
[...]
 </voice>
 <social_sharing>
[...]
 </social_sharing>
 <links/>
 </item>
 </getArticleStatisticsResult>
 </ns1:getArticleStatisticsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getStatus

Reading the status of the recipient profiles

EvalancheProfileMailingStatus[] getStatus( int mailing_id, int timeframe, string[] profile_attributes )

Details

Parameters

int mailing_id: Id of dispatch
int timeframe: seconds from now in the past, from which status changes should be queried.
string[] profile_attributes: List of profile attributes which are to be returned in the result. If an empty array is passed, no profile data is returned

Return value

EvalancheProfileMailingStatus[]: List of objects (SOAP) or arrays with the following attributes:
- int profile_id: Id of the profile
- int newsletter_id: Id of dispatch
- int last_status_change: Unix timestamp of the time of the last status change for the profile concerned
- int status: Dispatch status of the profile in question
- string preview_url: Personalized mailing preview
- string profile_data: Array with the attribute names as key and the attribute value as value

Required rights

Show eMailing

The dispatch status means:

0 = Queue
1 = dispatch successful
2 = Hardbounce
3 = soft bounce

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getStatus>
 <mailing_id>MAILING_ID</mailing_id>
 <timeframe>TIMEFRAME_IN_SECONDS</timeframe>
 <profile_attributes>
 <!--Zero or more repetitions:-->
 <item>PROFILE_ATTRIBUTE</item>
 </profile_attributes>
 </mail:getStatus>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getStatusResponse>
 <getStatusResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <newsletter_id>MAILING_ID</newsletter_id>
 <last_status_change>TIMESTAMP_LAST_STATUS_CHANGED</last_status_change>
 <status>STATUS</status>
 <preview_url>INDIVIDUAL_PREVIEW_URL</preview_url>
 <profile_data>
 <items>
 <item>
 <key>PROFILE_ATTRIBUTE_NAME</key>
 <value>PROFILE_ATTRIBTUE_VALUE</value>
 </item>
[...]
 </items>
 </profile_data>
 </item>
 </getStatusResult>
 </ns1:getStatusResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getSubjects

Reading the subject lines of a mailing

EvalancheMailingSubject getSubjects( int mailing_id )

Details

Parameters

int mailing_id: Id of the mailing

Return value

EvalancheMailingSubject[]: List of objects with the following attributes:
- int targetgroup_id: Id of the target group for the subject line. The ID 0 represents the standard subject line
- The subject line Timestamp of the mailing

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSubjects>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getSubjects>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getSubjectsResponse>
 <getSubjectsResult>
 <item>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <subjectline>SUBJECT</subjectline>
 </item>
[...]
 </getSubjectsResult>
 </ns1:getSubjectsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setSubjects

Set subject lines of a mailing

bool setSubjects ( int mailing_id, EvalancheMailingSubject[] subjects )

Details

Parameters

int mailing_id: Id of the mailing
EvalancheMailingSubject[] subjects: Analogous to the return value, read out under subject lines of a mailing. A configuration with the target group Id 0 is mandatory.

Return value

bool: true in case of success

Required rights

Change eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setSubjects>
 <mailing_id>MAILING_ID</mailing_id>
 <subjects>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <subjectline>SUBJECT_VALUE</subjectline>
 </item>
[...]
 </subjects>
 </mail:setSubjects>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:setSubjectsResponse>
 <setSubjectsResult>true</setSubjectsResult>
 </ns1:setSubjectsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getClientStatistics

Reading the client statistics of a mailing

bool getClientStatistics ( int mailing_id )

Details

Parameters

int mailing_id: Id of the mailing

Return value

ClientStatistics: Object (SOAP) or array with the following attributes:
- mail_clients: Array with the following attributes:
  - item: Array with the following attributes:
    - string description: Description of the e-mail client
    - int count: Number of profiles tracked with this email client

browsers: Array with the following attributes:
- item: Array with the following attributes:
  - string description: Description of the browser
  - int count: Number of profiles tracked with this browser

devices: Array with the following attributes:
- item: Array with the following attributes:
  - string description: Description of the terminal device
  - int count: Number of profiles tracked with this device

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getClientStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getClientStatistics>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getClientStatisticsResponse>
 <getClientStatisticsResult>
 <mail_clients>
 <item>
 <description>MAIL_CLIENT_DESCRIPTION</description>
 <count>COUNT</count>
 </item>
[...]
 </mail_clients>
 <browsers>
 <item>
 <description>BROWSER_DESCRIPTION</description>
 <version>BROWSER_VERSION</version>
 <count>COUNT</count>
 </item>
[...]
 </browsers>
 <devices>
 <item>
 <description>DEVICE_DESCRIPTION</description>
 <count>COUNT</count>
 </item>
[...]
 </devices>
 </getClientStatisticsResult>
 </ns1:getClientStatisticsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getConfiguration

Reading the configuration of a direct mailing

EvalancheMailingConfiguration getConfiguration( int mailing_id )

Details

Parameters

int mailing_id: Id of the mailing

Return value

EvalancheMailingConfiguration Object with the following attributes:
- string external_trackingcode: Value of the field External tracking code
- string campaign_id: Value of the field Campaign Id
- string externalxml_url: Value of the field URL to external XML
- string salutation_female: Value of the field Individualised form of address: Ms
- string salutation_male: Value of the field Individualized salutation: Mr
- string salutation_company: Value of the field Individualized salutation: Company
- string salutation_family: Value of the field Individualized form of address: Family
- string salutation_other: Value of the field Individualized salutation: Not specified
- string sender_email: Value of the field Return address
- string sender_name: Value of the field Sender
- string reply_email: Value of the field Reply to
- string reply_name: Value of the field reply to
- string grant_url: Value of the field Confirmation URL for entries
- string revoke_url: Value of the field Confirmation URL in case of a cancellation
- string inputfield_0: Value of the field INPUT FIELD 0
- string inputfield_1: Value of the field INPUT FIELD 1
- string inputfield_2: Value of the field INPUTFIELD 2
- string inputfield_3: Value of the field INPUTFIELD 3
- string inputfield_4: Value of the field INPUTFIELD 4
- string inputfield_5: Value of the field INPUT FIELD 5
- string inputfield_6: Value of the field INPUTFIELD 6
- string inputfield_7: Value of the field INPUTFIELD 7
- string inputfield_8: Value of the field INPUTFIELD 8
- string inputfield_9: Value of the field INPUT FIELD 9
- string textarea_0: Value of the field TEXTAREA 0
- string textarea_1: Value of the field TEXTAREA 1
- string textarea_2: Value of the field TEXTAREA 2
- string textarea_3: Value of the field TEXTAREA 3
- string textarea_4: Value of the field TEXTAREA 4
- string textarea_5: Value of the field TEXTAREA 5
- string textarea_6: Value of the field TEXTAREA 6
- string textarea_7: Value of the field TEXTAREA 7
- string textarea_8: Value of the field TEXTAREA 8
- string textarea_9: Value of the field TEXTAREA 9
- string htmlarea_0: Value of the field HTMLAREA 0 - Valid XHTML is mandatory!
- string htmlarea_1: Value of the field HTMLAREA 1 - Valid XHTML is mandatory!
- string htmlarea_2: Value of the field HTMLAREA 2 - Valid XHTML is mandatory!
- string htmlarea_3: Value of the field HTMLAREA 3 - Valid XHTML is mandatory!
- string htmlarea_4: Value of the field HTMLAREA 4 - Valid XHTML is mandatory!
- string htmlarea_5: Value of the field HTMLAREA 5 - Valid XHTML is mandatory!
- string htmlarea_6: Value of the field HTMLAREA 6 - Valid XHTML is mandatory!
- string htmlarea_7: Value of the field HTMLAREA 7 - Valid XHTML is mandatory!
- string htmlarea_8: Value of the field HTMLAREA 8 - Valid XHTML is mandatory!
- string htmlarea_9: Value of the field HTMLAREA 9 - Valid XHTML is mandatory!

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getConfiguration>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getConfiguration>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getConfigurationResponse>
 <getConfigurationResult>
 <external_trackingcode/>
 <campaign_id/>
 <externalxml_url/>
 <salutation_female/>
 <salutation_male/>
 <salutation_company/>
 <salutation_family/>
 <salutation_other/>
 <sender_email/>
 <sender_name/>
 <reply_name/>
 <reply_email/>
 <grant_url/>
 <revoke_url/>
 <inputfield_0/>
 <inputfield_1/>
 <inputfield_2/>
 <inputfield_3/>
 <inputfield_4/>
 <inputfield_5/>
 <inputfield_6/>
 <inputfield_7/>
 <inputfield_8/>
 <inputfield_9/>
 <textarea_0/>
 <textarea_1/>
 <textarea_2/>
 <textarea_3/>
 <textarea_4/>
 <textarea_5/>
 <textarea_6/>
 <textarea_7/>
 <textarea_8/>
 <textarea_9/>
 <htmlarea_0/>
 <htmlarea_1/>
 <htmlarea_2/>
 <htmlarea_3/>
 <htmlarea_4/>
 <htmlarea_5/>
 <htmlarea_6/>
 <htmlarea_7/>
 <htmlarea_8/>
 <htmlarea_9/>
 </getConfigurationResult>
 </ns1:getConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setConfiguration

Set configuration of a direct mailing

bool setConfiguration( int mailing_id, EvalancheMailingConfiguration configuration )

Details

Parameters

int mailing_id: Id of the mailing
EvalancheMailingConfiguration: Read object analogous to return value under Configuration of a direct mailing

Return value

bool: true in case of success

Required rights

Change eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setConfiguration>
 <mailing_id>22852985</mailing_id>
 <configuration>
 <!--You may enter the following 44 items in any order-->
 <external_trackingcode>EXTERNAL_TRACKINGCODE</external_trackingcode>
 <campaign_id>CAMPAIGN_ID</campaign_id>
 <externalxml_url>EXTERNALXML_URL</externalxml_url>
 <salutation_female>SALUTATION_FEMALE</salutation_female>
 <salutation_male>SALUTATION_MALE</salutation_male>
 <salutation_company>SALUTATION_COMPANY</salutation_company>
 <salutation_family>SALUTATION_FAMILY</salutation_family>
 <salutation_other>SALUTATION_OTHER</salutation_other>
 <sender_email>SENDER_EMAIL</sender_email>
 <sender_name>SENDER_NAME</sender_name>
 <reply_name>REPLY_NAME</reply_name>
 <reply_email>REPLY_EMAIL</reply_email>
 <grant_url>GRANT_REDIRECT_URL</grant_url>
 <revoke_url>REVOKE_REDIRECT_URL</revoke_url>
 <inputfield_0>?</inputfield_0>
 <inputfield_1>?</inputfield_1>
 <inputfield_2>?</inputfield_2>
 <inputfield_3>?</inputfield_3>
 <inputfield_4>?</inputfield_4>
 <inputfield_5>?</inputfield_5>
 <inputfield_6>?</inputfield_6>
 <inputfield_7>?</inputfield_7>
 <inputfield_8>?</inputfield_8>
 <inputfield_9>?</inputfield_9>
 <textarea_0>?</textarea_0>
 <textarea_1>?</textarea_1>
 <textarea_2>?</textarea_2>
 <textarea_3>?</textarea_3>
 <textarea_4>?</textarea_4>
 <textarea_5>?</textarea_5>
 <textarea_6>?</textarea_6>
 <textarea_7>?</textarea_7>
 <textarea_8>?</textarea_8>
 <textarea_9>?</textarea_9>
 <htmlarea_0>?</htmlarea_0>
 <htmlarea_1>?</htmlarea_1>
 <htmlarea_2>?</htmlarea_2>
 <htmlarea_3>?</htmlarea_3>
 <htmlarea_4>?</htmlarea_4>
 <htmlarea_5>?</htmlarea_5>
 <htmlarea_6>?</htmlarea_6>
 <htmlarea_7>?</htmlarea_7>
 <htmlarea_8>?</htmlarea_8>
 <htmlarea_9>?</htmlarea_9>
 </configuration>
 <overwrite>?</overwrite>
 </mail:setConfiguration>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:setConfigurationResponse>
 <setConfigurationResult>
 <external_trackingcode>EXTERNAL_TRACKINGCODE</external_trackingcode>
 <campaign_id>CAMPAIGN_ID</campaign_id>
 <externalxml_url>EXTERNALXML_URL</externalxml_url>
 <salutation_female>SALUTATION_FEMALE</salutation_female>
 <salutation_male>SALUTATION_MALE</salutation_male>
 <salutation_company>SALUTATION_COMPANY</salutation_company>
 <salutation_family>SALUTATION_FAMILY</salutation_family>
 <salutation_other>SALUTATION_OTHER</salutation_other>
 <sender_email>SENDER_EMAIL</sender_email>
 <sender_name>SENDER_NAME</sender_name>
 <reply_name>REPLY_NAME</reply_name>
 <reply_email>REPLY_EMAIL</reply_email>
 <grant_url>GRANT_REDIRECT_URL</grant_url>
 <revoke_url>REVOKE_REDIRECT_URL</revoke_url>
 <inputfield_0>?</inputfield_0>
 <inputfield_1>?</inputfield_1>
 <inputfield_2>?</inputfield_2>
 <inputfield_3>?</inputfield_3>
 <inputfield_4>?</inputfield_4>
 <inputfield_5>?</inputfield_5>
 <inputfield_6>?</inputfield_6>
 <inputfield_7>?</inputfield_7>
 <inputfield_8>?</inputfield_8>
 <inputfield_9>?</inputfield_9>
 <textarea_0>?</textarea_0>
 <textarea_1>?</textarea_1>
 <textarea_2>?</textarea_2>
 <textarea_3>?</textarea_3>
 <textarea_4>?</textarea_4>
 <textarea_5>?</textarea_5>
 <textarea_6>?</textarea_6>
 <textarea_7>?</textarea_7>
 <textarea_8>?</textarea_8>
 <textarea_9>?</textarea_9>
 <htmlarea_0>?</htmlarea_0>
 <htmlarea_1>?</htmlarea_1>
 <htmlarea_2>?</htmlarea_2>
 <htmlarea_3>?</htmlarea_3>
 <htmlarea_4>?</htmlarea_4>
 <htmlarea_5>?</htmlarea_5>
 <htmlarea_6>?</htmlarea_6>
 <htmlarea_7>?</htmlarea_7>
 <htmlarea_8>?</htmlarea_8>
 <htmlarea_9>?</htmlarea_9>
 </setConfigurationResult>
 </ns1:setConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getSendableDrafts

Read out mailing drafts ready for dispatch

EvalancheResourceInformation[] getSendableDrafts( boo-bool unsent )

Details

Parameters

bool unsent: If true is transferred, only drafts that have not yet been sent are returned

Return value

EvalancheResourceInformation[]: List of objects analogous to the method getById (retrieve information about an object using object Id)

Required rights

none

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSendableDrafts>
 <unsent>0/1</unsent>
 </mail:getSendableDrafts>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getSendableDraftsResponse>
 <getSendableDraftsResult>
 <item>
 <url>SENDABLE_MAILING_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </item>
[...]
 </getSendableDraftsResult>
 </ns1:getSendableDraftsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getSendableDraftsByMandatorId

Read out mailing drafts ready for dispatch from a client

EvalancheResourceInformation[] getSendableDraftsByMandatorId( int mandator_id, bool unsent )

Details

Parameters

int mandator_id: The Id of the client from which drafts are to be searched bool unsent: If true is transferred, only drafts that have not yet been sent are returned

Return value

EvalancheResourceInformation[]: List of objects analogous to the method getById (Query information about an object using object Id)

Required rights

none

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSendableDraftsByMandatorId>
 <mandator_id>MANDATOR_ID</mandator_id>
 <unsent>0/1</unsent>
 </mail:getSendableDraftsByMandatorId>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getSendableDraftsByMandatorIdResponse>
 <getSendableDraftsByMandatorIdResult>
 <item>
 <url>SENDABLE_MAILING_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </item>
[...]
 </getSendableDraftsByMandatorIdResult>
 </ns1:getSendableDraftsByMandatorIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

createDraft

Creating a direct mailing from a template

EvalancheResourceInformation createDraft( string name, int template_id, int category_id )

Details

Parameters

string name: Name of the direct mailing to be created
int template_id: Id of the template to be used
int category_id: Id of the folder in which the direct mailing is to be created
int type_id (optional): Id of the eMailing-Type
- 66 - regular eMailing - Default
- 69 - Event eMailing
- 76 - Trigger eMailing

Return value

EvalancheResourceInformation: Object analogous to the method getById (retrieve information about an object using object Id)

Required rights

Create an e-mail

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:createDraft>
 <name>MAILING_NAME</name>
 <template_id>TEMPLATE_ID</template_id>
 <category_id>CATEGORY_ID</category_id>
<!-- optional parameter type_id -->
<type_id>TYPE_ID</type_id>
 </mail:createDraft>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:createDraftResponse>
 <createDraftResult>
 <url>MAILING_URL</url>
 <type_id>MAILING_TYPE_URL</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR_ID</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </createDraftResult>
 </ns1:createDraftResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getArticles

Reading articles from a mailing

MailingArticle[] getArticles( int mailing_id )

Details

Parameters

int mailing_id: Id of the mailing from which the articles are to be read

Return value

MailingArticles[]: List of objects with the following attributes:
- int id: Id of the article reference (connection between actual article and mailing)
- int article_id: Id of the article object
- int targetgroup_id: Id of the target group, for which the article is to be displayed exclusively
- int sortpos: Position of the article within its slot starting at 0
- int slot: Number of the slot in which the article is located starting with 0
- int html_preset_id: Id of the assigned article template for the eMail (HTML) display. The ID 0 means that the corresponding standard article template is used
- int landingpage_preset_id: Id of the assigned article template for the landing page display. The ID 0 means that the corresponding standard article template is used
- int text_preset_id: Id of the assigned article template for the text display. Id 0 means that the corresponding standard article template is used
- int pdf_preset_id: Id of the assigned article template for the PDF display. The ID 0 means that the corresponding standard article template is used
- int mobile_preset_id: Id of the assigned article template for the mobile or web presentation. The ID 0 means that the corresponding standard article template is used

Required rights

Show eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getArticles>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getArticles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getArticlesResponse>
 <getArticlesResult>
 <item>
 <id>UNIQUE_ARTICLE_ID</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
 </getArticlesResult>
 </ns1:getArticlesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

removeAllArticles

Remove all articles from a mailing

bool removeAllArticles( int mailing_id )

Details

Parameters

int mailing_id: Id of the mailing from which the articles are to be removed. The article objects as such are not changed

Return value

bool: In case of success true

Required rights

Change eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:removeAllArticles>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:removeAllArticles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:removeAllArticlesResponse>
 <removeAllArticlesResult>true</removeAllArticlesResult>
 </ns1:removeAllArticlesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

removeArticles

Remove certain articles from a mailing

MailingArticle[] removeArticles( int mailing_id, int[] reference_ids )

Details

Parameters

int mailing_id: Id of the mailing from which the articles are to be removed. The article objects as such are not changed
int[] reference_ids: List of article reference IDs of the articles to be removed. The IDs can be removed using the method getArticles are determined ( MailingArticle:id )

Return value

MailingArticles[] Read out list of objects analogous to the return value for the article of a mailing - after removing the specified articles. true

Required rights

Change eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:removeArticles>
 <mailing_id>MAILING_ID</mailing_id>
 <reference_ids>
 <!--Zero or more repetitions:-->
 <item>UNIQUE_ARTICLE_ID</item>
 </reference_ids>
 </mail:removeArticles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:removeArticlesResponse>
 <removeArticlesResult>
<!-- list of articles still used in mailing -->
 <item>
 <id>UNIQUE_ARTICLE_ID</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
[...]
 </removeArticlesResult>
 </ns1:removeArticlesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

addArticles

Add articles to a mailing and update existing articles

MailingArticle[] addArticles( int mailing_id, MailingArticle[] articles )

Details

Parameters

int mailing_id: Id of the mailing in which the articles are to be updated or inserted
MailingArticles[] articles: Read a list of objects in the same way as the return value for the article in a direct mailing. Whether an update or new creation is carried out is determined by the attribute MailingArticle:id of an article is controlled. If a valid article reference Id is passed here, the corresponding article is updated. If 0 the article is inserted.

Return value

Read out list of objects analogous to the return value of an article in a mailing - after inserting or updating the article

Required rights

Change eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:addArticles>
 <mailing_id>MAILING_ID</mailing_id>
 <articles>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 10 items in any order-->
 <id>0</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
 </articles>
 </mail:addArticles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:addArticlesResponse>
 <addArticlesResult>
 <item>
 <id>UNIQUE_ARTICLE_ID</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
 </addArticlesResult>
 </ns1:addArticlesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

sendToTargetgroup

Sending a mailing to a target group

EvalancheMailingInformation sendToTargetgroup( int mailing_id, int targetgroup_id, int send_time, int speed )

Details

Parameters

int mailing_id: Id of the mailing draft to be sent
int targetgroup_id: Id of the target group
int send_time: Unix timestamp of the dispatch time (UTC). If this is in the past, the dispatch starts immediately
int speed: Sending speed in mails/hour. If this value is 0, no throttling is applied

Return value

EvalancheMailingInformation: Object analogous to the method getDetails (Query details of a dispatch)

Required rights

Manage eMailing

Use

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing"> <soapenv
:Header/> <soapenv
:Body> <mail:
sendToTargetgroup> <mailing_id>MAILING_ID</mailing_id>
<targetgroup_id>TARGETGROUP_ID</targetgroup_id>
<send_time>TIMESTAMP_SEND_TIME</send_time>
<speed>SENDSPEED</speed> </mail:

sendToTargetgroup> </soapenv
:Body> </soapenv
:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:sendToTargetgroupResponse>
 <sendToTargetgroupResult>
 <timestamp>TIMESTAMP</timestamp>
 <recipients>RECIPIENTS</recipients>
 <sent>SENT</sent>
 <preview_url xsi:nil="true"/>
 <report_url>REPORT_URL</report_url>
 <admin_url>OBJECT_URL</admin_url>
 <subject>SUBJECT</subject>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <send_start_time>SEND_START_TIME</send_start_time>
 <send_end_time>SEND_END_TIME</send_end_time>
 <url>PREVIEW_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR_ID</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </sendToTargetgroupResult>
 </ns1:sendToTargetgroupResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

sendToProfiles

Send a mailing to individual profiles (trigger mailing is recommended)

int[] sendToProfiles( int mailing_id, int[] profile_ids )

Details

Parameters

int mailing_id: Id of the mailing int[] profile_ids: List of Profile Ids

Return value

int[]: List with the IDs of the profiles to which the dispatch was successful

Required rights

Manage eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:sendToProfiles>
 <mailing_id>MAILING_ID</mailing_id>
 <profile_ids>
 <!--Zero or more repetitions:-->
 <item>PROFILE_ID</item>
 </profile_ids>
 </mail:sendToProfiles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:sendToProfilesResponse>
 <sendToProfilesResult>
 <item>PROFILE_ID</item>
 </sendToProfilesResult>
 </ns1:sendToProfilesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveGlobalModuleConfiguration

Retrieves global module configurations

retrieveGlobalModuleConfigurationResponse retrieveGlobalModuleConfiguration (int resource_id)

Details

Parameters

int resource_id: ID of mailing

Return value

object: retrieveGlobalModuleConfigurationResponse
- string: retrieveGlobalModuleConfigurationResult

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:retrieveGlobalModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  </mail:retrieveGlobalModuleConfiguration>
  </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
  <SOAP-ENV:Body>
  <retrieveGlobalModuleConfigurationResult>{"modules":[]}</retrieveGlobalModuleConfigurationResult>
  </ns1:retrieveGlobalModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveModuleConfiguration

Retrieves module configurations

retrieveModuleConfigurationResponse retrieveModuleConfiguration (int resource_id)

Details

Parameters

int resource_id: ID of mailing

Return value

object: retrieveModuleConfigurationResponse
- string: retrieveModuleConfigurationResult

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:retrieveModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  </mail:retrieveModuleConfiguration>
  </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
  <SOAP-ENV:Body>
  <ns1:retrieveModuleConfigurationResponse>
  <retrieveModuleConfigurationResult>{"dropareas":[]}</retrieveModuleConfigurationResult>
  </ns1:retrieveModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveModuleTypes

Retrieves module types

retrieveModuleTypesResponse retrieveModuleTypes (int resource_id)

Details

Parameters

int resource_id: ID of mailing

Return value

object: retrieveModuleTypesResponse
- string: retrieveModuleTypesResult

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:retrieveModuleTypes>
  <resource_id>MAILING_ID</resource_id>
  </mail:retrieveModuleTypes>
  </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
  <SOAP-ENV:Body>
  <ns1:retrieveModuleTypesResponse>
  <retrieveModuleTypesResult>{"module_types":[],"categories":[]}</retrieveModuleTypesResult>
  </ns1:retrieveModuleTypesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getContentGenerationVariables

Get AI variables for content generation in an emailing

EvalancheHashMap getContentGenerationVariables (int mailing_id)

Details

Parameter

int resource_id: ID of emailing

Return value

Name: name of AI variable
Default_Value: default value of AI variable
Label: label of AI variable
Help_Text:: help text AI variable

Required rights

Change emailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header />
 <soapenv:Body>
 <mail:getContentGenerationVariables>
 <resource_id>RESOURCE_ID</resource_id>
 </mail:getContentGenerationVariables>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getContentGenerationVariablesResponse>
 <getContentGenerationVariablesResult>
 <item>
 <name>NAME</name>
 <default_value>DEFAULT_VALUE</default_value>
 <label>LABEL</label>
 <help_text>HELPTEXT</help_text>
 </item> 
 <item>
 …
 </item>
 </getContentGenerationVariablesResult>
 </ns1:getContentGenerationVariablesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getResultCursor

Returns the cursor for the current result set

getResultCursorResponse getResultCursor (string job_Id)

Details

Parameter

string job_id: Id of background job

Return value

string getResultCursorResult: return value of the method as string

Required rights

View pool and export profiles

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getResultCursor>
 <job_id>JOB_ID</job_id>
 </mail:getResultCursor>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getResultCursorResponse>
 <getResultCursorResult>
 <CursorResult>CURSORRESULT</CursorResult>
 </getResultCursorResult>
 </ns1:getResultCursorResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

isAlive

Tests whether the API is available and the credentials used are valid. The `random_message` property of the result is completely irrelevant, since the values are randomly taken from http://whatthecommit.com.

isAliveResponse isAlive ()

Details: isAlive

move

Moves the object to another folder

EvalancheResourceInformation move (int resource_id, int category_id)

Details: move

rename

Gives the object a different name

EvalancheResourceInformation rename (int resource_id, string name)

Details: rename

runContentGeneration

generates AI content for an emailing

EvalancheHashMap runContentGenerationData (int mailing_id)

Details

Parameter

int resource_id: ID of eMailing

Return value

id: job id of AI generation
status: status id of AI generation
status_description: status description of AI generation

Required rights

Change eMailing

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem4.com/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<mail:runContentGeneration>
<resource_id>MAILING_ID</resource_id>
<variables>
<items>
</items>
</variables>
</mail:runContentGeneration>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem4.com/soap.php/soap/mailing">
<SOAP-ENV:Body>
<ns1:runContentGenerationResponse>
<runContentGenerationResult>
<id>JOB_ID</id>
<status>STATUS</status>
<status_description>STATUS_DESCRIPTION</status_description>
</runContentGenerationResult>
</ns1:runContentGenerationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setResultCursor

Sets the cursor for the result set returned by the next call to getResults

boolean setResultCursor (string job_Id, int cursor)

Details

Parameter

string job_id: Id of background job

Return value

boolean setSubjectsResult: boolean return value of the method

Required rights

View pool and export profiles

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setResultCursor>
 <job_id>JOB_ID</job_id>
 <cursor>CURSOR</cursor>
 </mail:setResultCursor>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:setResultCursorResponse>
 <setResultCursorResult>
 <CursorResult>CURSORRESULT</CursorResult>
 </setResultCursorResult>
 </ns1:setResultCursorResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

updateGlobalModuleConfiguration

Update global module configurations

updateGlobalModuleConfigurationResponse updateGlobalModuleConfiguration (int resource_id, string global_module_content)

Details

Parameters

int resource_id: ID of mailing
string global_module_content: Content of global module

Return value

object: updateGlobalModuleConfigurationResponse
- bool: updateGlobalModuleConfigurationResult returns true if successful

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:updateGlobalModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  <global_module_content>CONTENT</global_module_content>
  </mail:updateGlobalModuleConfiguration>
  </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
  <SOAP-ENV:Body>
  <ns1:updateGlobalModuleConfigurationResponse>
  <updateGlobalModuleConfigurationResult>true</updateGlobalModuleConfigurationResult>
  </ns1:updateGlobalModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateModuleConfiguration

Update module configuration

updateModuleConfigurationResponse updateModuleConfiguration (int resource_id, string module_content)

Details

Parameters

int resource_id: ID of mailing
string global_module_content: Content of module

Return value

object: updateModuleConfigurationResponse
- bool: updateModuleConfigurationResult returns true if successful

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:updateModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  <module_content>CONTENT</module_content>
  </mail:updateModuleConfiguration>
  </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
  <SOAP-ENV:Body>
  <ns1:updateModuleConfigurationResponse>
  <updateModuleConfigurationResult>true</updateModuleConfigurationResult>
  </ns1:updateModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateModuleTypes

Update module type memory

updateModuleTypesResponse updateModuleTypes (int resource_id, string module_type_content)

Details

Parameters

int resource_id: ID of mailing
string module_type_content: Content of module type memory

Return value

object: updateModuleTypesResponse
- bool: updateModuleTypesResult returns true if successful

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:updateModuleTypes>
  <resource_id>MAILING_ID</resource_id>
  <module_type_content>?</module_type_content>
  </mail:updateModuleTypes>
  </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
  <SOAP-ENV:Body>
  <ns1:updateModuleTypesResponse>
  <updateModuleTypesResult>true</updateModuleTypesResult>
  </ns1:updateModuleTypesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Working with background jobs

Exports of target groups and pools are executed as asynchronous background jobs due to their processing time and data volume. The results are delivered in chunks of 1,000 profiles each. The result remains available for 28 days. An example PHP script for exporting all profiles from a pool might look like this:


<?php

[...]

$job_info = $client->getByPool($pool_id, array('PROFILEID', 'FIRSTNAME', 'NAME', 'EMAIL', 'P1341395547'));
var_dump($job_info);

while($job_info->status < 2 || $job_info->status == 3) { // Check status while the job is queued, in progress, or in a temporary error state.
        $job_info = $client->getJobInformation($job_info->id);
        var_dump($job_info);
        sleep(5);
}

if($job_info->status == 2) { // Job ist erledigt
        $result = $client->getResults($job_info->id); // retrieve the first result set
        var_dump($result);

        while($result->chunks_left > 0) { // retrieve further result sets, if available
                $result = $client->getResults($job_info->id);
                var_dump($result);
        }
} else {
        // The job could not be executed successfully
}

Standard API (SOAP)

copy

delete

getAll

getByCategory

getByExternalId

getById

getByModificationDate

getByTypeId

getJobInformation

Parameter

Return value

Required rights

Use

See also:

getJobState

getResourceDefaultCategory

getTypeIds

get

Parameters

Return value

Required rights

Use

See also:

getContentContainerData

Parameters

Return value

Required rights

Use

setContentContainerData

Parameter

Return value

Required rights

Use

getDetails

Parameters

Return value

Required rights

Use

getImpressions

Parameters

Return value

Required rights

Use

getClicks

Parameters

Return value

Explanation of ``link_id'' and ``parent_id'':

Required rights

Use

getStatistics

Parameters

Return value

Required rights

Use

getArticleStatistics

Parameters

Return value

Required rights

Use

getStatus

Parameters

Return value

Required rights

The dispatch status means:

Use

getSubjects

Parameters

Return value

Required rights

Use

setSubjects

Parameters

Return value

Required rights

Use

getClientStatistics

Parameters

Return value

Required rights