Back to API references

SOAP API method Account_createEmailing

Description

This method can be used to create processedEmailings (mailings that are sent right away) and scheduled e-mailings (mailings that are scheduled to be sent later). It is also possible to use this method for making splitrun mailings. A splitrun mailing has a number of testgroups and the final document that is sent is determined based on the results of the testgroups that were sent earlier.

Parameters

Name Type Description
profile int ID of the profile
subprofile int ID of the subprofile
database int ID of the database
view int ID of the view
collection int ID of the collection
miniview int ID of the miniview
emailingdocument Structure of type 'emailingdocument' The document to send
splitrunsettings Structure of type 'splitrunsettings' The settings for the splitrun emailing
emailingsettings * Structure of type 'emailingsettings' The settings of the mailing
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
processedemailing Structure of type 'processedemailing'
scheduledemailing Structure of type 'scheduledemailing'

Structure 'emailingdocument'

Name Type Description
convertedid int The converted ID.
headers string The additional headers.
subject string The subject of the emailingdocument.
fromaddress EmailAddress The fromaddress of the emailingdocument.
fromaddressstatus string Get the status of the from address. When a from address is okay to do
bccaddress EmailAddress The bccaddress of this emailingdocument.
replytoaddress EmailAddress The reply-to address of the emailingdocument.
textversion string The textversion of the emailingdocument.
useinlinestyles string Should stylesheets in the document be merged into inline styles? This is usefull
temporary boolean Is this document set as a temporary document. The document will be removed when there are no
priority_indicator string Getting the priority header for emails who use this document
unsubscribe_header string Should the list-unsubscribe header be sent with the mailing.
size int Get the size of the document.
charset string Gets the charset that should be used when showing/sending this document
htmlEscaping string Check if the document is escaping HTML code
smartyVersion integer What smarty version is used to render this document
id int The ID of the document.
templateID int The template ID of the document
name string The name of the document.
description string The description of the document.
archived boolean Is this an archived document?.
created timestamp The date and time when the document was created.
modified timestamp The date and time when the document was last modified.
language string The language of the document.
timezone string Get the time zone of the document. If the timezone is not set, it returns

Structure 'splitrunsettings'

Name Type Description
condition string Get the condition
testgroups SplitRunTestGroupArray Get the testgroups

Structure 'emailingsettings'

Name Type Description
contenttype string The contenttype of the emailingsettings.
embeddedimages boolean Should the images be embedded?.
messagesperminute int Update the max number of messages per minute
cacheexternalimages boolean Should the external images be cached?
registerimpressions boolean Should the impressions be registered?.
registerclicks string Should the clicks be registered?.
registererrors boolean Should the errors be registered?.
registerabuses boolean Should the abuses be registered?.
starttime timestamp The starttime of the mailing.
dateinterval DateInterval The interval for the mailing.
iterations int The iterations of the settings.
description string The description of the mailing.
processedmissediterations boolean The processed missed iterations.
personalized boolean Should the mailing be personalized?.
test boolean Is this a test mailing?.
nodoubles boolean Should the double addresses be skipped?.
isscheduled boolean Is the mailing a scheduled mailing?
extradocumentproperties Map Get the extra document properties of this mailing. This doen't contain the
priority int The priority settings of the mailing.

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'processedemailing'

Name Type Description
embedded boolean Are the images embeded?
contenttype string The contenttype of the mailing.
registerclicks string Will the clicks be registered?.
registerimpressions boolean Will the impressions be registered?.
registererrors boolean Will the errors be registered?.
registerabuses boolean Will the abuses be registered?.
followupsenabled boolean Are the followups still activated?.
clickcount int The total number of clicks.
impressioncount int The total number of impressions.
errorcount int The total number of errors.
abusecount int The total number of abuses that were registered
destinationcount int The total number of destinations.
emailingtype string Get the emailing type
id int Get the ID of the mailing.
timestamp timestamp The timestamp when the mailing was sent.
description string The description of the mailing.
personalized boolean Was this mailing personalized?.
nodoubles boolean Should the mailing be send to double mailaddresses?.
individual boolean Was this mailing sent to an individual?.
test boolean Was this mailing a test?
type string The type of the mailing.
messagesperminute int The max number of messages that are sent withing one minute
archived boolean The mailing is archived.
priority int Priority of the mailing. Higher value indicates higher priority.

Structure 'scheduledemailing'

Name Type Description
embedded boolean Are the external images cached?
contenttype string The contenttype of the mailing.
registerclicks string Will the clicks be registered?.
registerimpressions boolean Will the impressions be registered?.
registererrors boolean Will the errors be registered?.
registerabuses boolean Will the abuses be registered?.
condition string Get the condition
emailingtype string Get the emailing type
schedule string iCalender schedule string that controls when the event runs. If this property is set, the interval and iterations settings can be ignored.
description string The description of the scheduled mailing
test boolean Was this a test mailing?.
personalized boolean Was this mailing personalized?.
nodoubles boolean Was the target contains doubles?.
messagesperminute int The max number of messages that are sent withing one minute
priority int Priority of the mailing. Higher value indicated higher priority.
nextstarttime timestamp The next time when this scheduled event will run.
schedulediterations int The number of iterations that are still remaining.
processediterations int The number of iterations that were already processed.
previousstarttime string The starttime of the most recent iteration.
prevstarttime timestamp The starttime of the most recent iteration.
processmissediterations boolean Will the missed iterations be processed anyway?.
id int The ID of the scheduledevent.