SOAP API methode EmailingDocument_createEmailing
Beschrijving
This method will sent the emailing.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
| id * | int | Unique identifier (id) of the object EmailingDocument. The method only applies to the emailingdocument with this id. |
| personalize_profile | int | Profile ID for which the object should be personalized |
| personalize_subprofile | int | Subprofile ID for which the object should be personalized |
| personalize_timestamp | string | The timestamp for the personalization |
| 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 |
| 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 |
| * verplichte parameters | ||
Resultaat
| Naam | Type | Beschrijving |
|---|---|---|
| processedemailing | Structure of type 'processedemailing' | |
| scheduledemailing | Structure of type 'scheduledemailing' |
Structuur 'emailingsettings'
| Naam | Type | Beschrijving |
|---|---|---|
| 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. |
Structuur 'login'
| Naam | Type | Beschrijving |
|---|---|---|
| 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 |
Structuur 'processedemailing'
| Naam | Type | Beschrijving |
|---|---|---|
| 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. |
Structuur 'scheduledemailing'
| Naam | Type | Beschrijving |
|---|---|---|
| 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. |