SOAP API method DocumentFollowUp_action

Description

The action that is executed after the delay.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object DocumentFollowUp. The method only applies to the documentfollowup 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
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
* required parameters

Return values

Name	Type	Description
modifyaction	Structure of type 'modifyaction'
contactaction	Structure of type 'contactaction'
smsaction	Structure of type 'smsaction'
removeaction	Structure of type 'removeaction'
emaildocumentaction	Structure of type 'emaildocumentaction'
createaction	Structure of type 'createaction'
faxdocumentaction	Structure of type 'faxdocumentaction'
smsdocumentaction	Structure of type 'smsdocumentaction'

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 'modifyaction'

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

Structure 'contactaction'

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

Structure 'smsaction'

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

Structure 'removeaction'

Name	Type	Description
destination	string	The destination of the removeaction.
condition	string	Get the javascript condition used to determine if the followup action shoud be executed

Structure 'emaildocumentaction'

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

Structure 'createaction'

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

Structure 'faxdocumentaction'

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

Structure 'smsdocumentaction'

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