SOAP API method reference

Description

The action that is executed after the delay.

Parameters

Parameter 'id' : int: Unique identifier (id) of the object DocumentFollowUp. The method only applies to the documentfollowup 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 'login' : Structure of type 'login': Optional login data

Return values

Return value 'modifyaction' : Structure of type 'modifyaction'
Return value 'contactaction' : Structure of type 'contactaction'
Return value 'smsaction' : Structure of type 'smsaction'
Return value 'removeaction' : Structure of type 'removeaction'
Return value 'emaildocumentaction' : Structure of type 'emaildocumentaction'
Return value 'createaction' : Structure of type 'createaction'
Return value 'faxdocumentaction' : Structure of type 'faxdocumentaction'
Return value 'smsdocumentaction' : Structure of type 'smsdocumentaction'

Structure 'login'

This structure login was mentioned above. This structure has the following properties:

Structure 'modifyaction'

This structure modifyaction was mentioned above. This structure has the following properties:

Property 'destination' : string: Method to change the destination for the modifyaction.
Property 'fields' : Map: The name of the fields or interests that are going to be modified.
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

Structure 'contactaction'

This structure contactaction was mentioned above. This structure has the following properties:

Property 'type' : string: The type of the contactaction.
Property 'message' : string: The message of the contactaction.
Property 'user' : User: The role of the contactaction
Property 'important' : boolean: The important setting of the contactaction.
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

Structure 'smsaction'

This structure smsaction was mentioned above. This structure has the following properties:

Property 'message' : string: The sms message.
Property 'destination' : string: The destination setting.
Property 'from' : string: The from sms address.
Property 'settings' : SmsMailingSettings: Get the sms settings used if a sms is send
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

Structure 'removeaction'

This structure removeaction was mentioned above. This structure has the following properties:

Property 'destination' : string: The destination of the modifyaction.
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

Structure 'emaildocumentaction'

This structure emaildocumentaction was mentioned above. This structure has the following properties:

Property 'document' : EmailingDocument: The document of the emaildocumentaction.
Property 'destination' : string: Get the destination setting.
Property 'emailingSettings' : EmailingSettings: Get the emailing settings used if a document is send
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

Structure 'createaction'

This structure createaction was mentioned above. This structure has the following properties:

Property 'collection' : string: Get the collection the action needs to create a subprofile in
Property 'fields' : Map: Get the fields that are going to be modified to non-default values.
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

Structure 'faxdocumentaction'

This structure faxdocumentaction was mentioned above. This structure has the following properties:

Property 'document' : PdfDocument: The document of the faxdocumentaction.
Property 'destination' : string: Get the destination setting.
Property 'faxSettings' : FaxMailingSettings: Get the emailing settings used if a document is send
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

Structure 'smsdocumentaction'

This structure smsdocumentaction was mentioned above. This structure has the following properties:

Property 'document' : SmsDocument: The document of the smsdocumentaction.
Property 'destination' : string: Get the destination setting.
Property 'smsSettings' : SmsMailingSettings: Get the emailing settings used if a document is send
Property 'condition' : string: Get the javascript condition used to determine if the followup action shoud be executed

SOAP API method DocumentFollowUp_action