Back to API references

SOAP API method Collection_createFollowUp

Description

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

Parameters

Name Type Description
id * int Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
webformcause Structure of type 'webformcause' The cause that must be met
impressioncause Structure of type 'impressioncause' The cause that must be met
errorcause Structure of type 'errorcause' The cause that must be met
createcause Structure of type 'createcause' The cause that must be met
submitcause Structure of type 'submitcause' The cause that must be met
matchcause Structure of type 'matchcause' The cause that must be met
sendcause Structure of type 'sendcause' The cause that must be met
createormodifycause Structure of type 'createormodifycause' The cause that must be met
modifycause Structure of type 'modifycause' The cause that must be met
removecause Structure of type 'removecause' The cause that must be met
surveycause Structure of type 'surveycause' The cause that must be met
clickcause Structure of type 'clickcause' The cause that must be met
dateinterval * Structure of type 'dateinterval' The delay before the action is executed
modifyaction Structure of type 'modifyaction' The action
removeaction Structure of type 'removeaction' The action
contactaction Structure of type 'contactaction' The action
createaction Structure of type 'createaction' The action
smsdocumentaction Structure of type 'smsdocumentaction' The action
faxdocumentaction Structure of type 'faxdocumentaction' The action
smsaction Structure of type 'smsaction' The action
emaildocumentaction Structure of type 'emaildocumentaction' The action
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
collectionfollowup Structure of type 'collectionfollowup'

Structure 'webformcause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'impressioncause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'errorcause'

Name Type Description
filter string Get the error filter.
condition string Get the condition when the cause is triggered

Structure 'createcause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'submitcause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'matchcause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'sendcause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'createormodifycause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'modifycause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'removecause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'surveycause'

Name Type Description
condition string Get the condition when the cause is triggered

Structure 'clickcause'

Name Type Description
filter string The url filter.
condition string Get the condition when the cause is triggered

Structure 'dateinterval'

Name Type Description
count int The count of the dateinterval.
unit string The unit of the dateinterval.

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

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

Name Type Description
id int The ID of the followup.