SOAP API methode EmailingDocument_createFollowUp

Terug naar de indexpagina

Beschrijving
The follow up action is executed when the cause is met.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object EmailingDocument. The method only applies to the emailingdocument with this id.
Parameter 'personalize_profile' : int
Profile ID for which the object should be personalized
Parameter 'personalize_subprofile' : int
Subprofile ID for which the object should be personalized
Parameter 'personalize_timestamp' : string
The timestamp for the personalization
Parameter 'surveycause' : Structure of type 'surveycause'
The cause that must be met
Parameter 'matchcause' : Structure of type 'matchcause'
The cause that must be met
Parameter 'clickcause' : Structure of type 'clickcause'
The cause that must be met
Parameter 'createcause' : Structure of type 'createcause'
The cause that must be met
Parameter 'impressioncause' : Structure of type 'impressioncause'
The cause that must be met
Parameter 'createormodifycause' : Structure of type 'createormodifycause'
The cause that must be met
Parameter 'removecause' : Structure of type 'removecause'
The cause that must be met
Parameter 'sendcause' : Structure of type 'sendcause'
The cause that must be met
Parameter 'modifycause' : Structure of type 'modifycause'
The cause that must be met
Parameter 'submitcause' : Structure of type 'submitcause'
The cause that must be met
Parameter 'webformcause' : Structure of type 'webformcause'
The cause that must be met
Parameter 'errorcause' : Structure of type 'errorcause'
The cause that must be met
Parameter 'dateinterval' : Structure of type 'dateinterval'
The delay before the action is executed
Parameter 'modifyaction' : Structure of type 'modifyaction'
The action
Parameter 'contactaction' : Structure of type 'contactaction'
The action
Parameter 'smsaction' : Structure of type 'smsaction'
The action
Parameter 'removeaction' : Structure of type 'removeaction'
The action
Parameter 'emaildocumentaction' : Structure of type 'emaildocumentaction'
The action
Parameter 'createaction' : Structure of type 'createaction'
The action
Parameter 'faxdocumentaction' : Structure of type 'faxdocumentaction'
The action
Parameter 'smsdocumentaction' : Structure of type 'smsdocumentaction'
The action
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'documentfollowup' : Structure of type 'documentfollowup'

Structuur 'surveycause'
De structuur 'surveycause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'matchcause'
De structuur 'matchcause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'clickcause'
De structuur 'clickcause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'filter' : string
The url filter.
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'createcause'
De structuur 'createcause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'impressioncause'
De structuur 'impressioncause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'createormodifycause'
De structuur 'createormodifycause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'removecause'
De structuur 'removecause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'sendcause'
De structuur 'sendcause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'modifycause'
De structuur 'modifycause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'submitcause'
De structuur 'submitcause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'webformcause'
De structuur 'webformcause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'errorcause'
De structuur 'errorcause' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'filter' : string
Get the error filter.
Eigenschap 'condition' : string
Get the condition when the cause is triggered

Structuur 'dateinterval'
De structuur 'dateinterval' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'count' : int
The count of the dateinterval.
Eigenschap 'unit' : string
The unit of the dateinterval.

Structuur 'modifyaction'
De structuur 'modifyaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'destination' : string
Method to change the destination for the modifyaction.
Eigenschap 'fields' : Map
The name of the fields or interests that are going to be modified.
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'contactaction'
De structuur 'contactaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'type' : string
The type of the contactaction.
Eigenschap 'message' : string
The message of the contactaction.
Eigenschap 'user' : User
The role of the contactaction
Eigenschap 'important' : boolean
The important setting of the contactaction.
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'smsaction'
De structuur 'smsaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'message' : string
The sms message.
Eigenschap 'destination' : string
The destination setting.
Eigenschap 'from' : string
The from sms address.
Eigenschap 'settings' : SmsMailingSettings
Get the sms settings used if a sms is send
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'removeaction'
De structuur 'removeaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'destination' : string
The destination of the modifyaction.
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'emaildocumentaction'
De structuur 'emaildocumentaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'document' : EmailingDocument
The document of the emaildocumentaction.
Eigenschap 'destination' : string
Get the destination setting.
Eigenschap 'emailingSettings' : EmailingSettings
Get the emailing settings used if a document is send
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'createaction'
De structuur 'createaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'collection' : string
Get the collection the action needs to create a subprofile in
Eigenschap 'fields' : Map
Get the fields that are going to be modified to non-default values.
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'faxdocumentaction'
De structuur 'faxdocumentaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'document' : PdfDocument
The document of the faxdocumentaction.
Eigenschap 'destination' : string
Get the destination setting.
Eigenschap 'faxSettings' : FaxMailingSettings
Get the emailing settings used if a document is send
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'smsdocumentaction'
De structuur 'smsdocumentaction' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'document' : SmsDocument
The document of the smsdocumentaction.
Eigenschap 'destination' : string
Get the destination setting.
Eigenschap 'smsSettings' : SmsMailingSettings
Get the emailing settings used if a document is send
Eigenschap 'condition' : string
Get the javascript condition used to determine if the followup action shoud be executed

Structuur 'login'
De structuur 'login' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'username' : string
The username of the login attempt
Eigenschap 'account' : string
The account name of the login attempt
Eigenschap 'password' : string
The password for the login attempt

Structuur 'documentfollowup'
De structuur 'documentfollowup' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'id' : int
The ID of the followup.