SOAP API method Database_createFollowUp

Back to API references

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

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter 'matchcause' : Structure of type 'matchcause'
The cause that must be met
Parameter 'modifycause' : Structure of type 'modifycause'
The cause that must be met
Parameter 'createcause' : Structure of type 'createcause'
The cause that must be met
Parameter 'surveycause' : Structure of type 'surveycause'
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 'sendcause' : Structure of type 'sendcause'
The cause that must be met
Parameter 'clickcause' : Structure of type 'clickcause'
The cause that must be met
Parameter 'impressioncause' : Structure of type 'impressioncause'
The cause that must be met
Parameter 'removecause' : Structure of type 'removecause'
The cause that must be met
Parameter 'errorcause' : Structure of type 'errorcause'
The cause that must be met
Parameter 'createormodifycause' : Structure of type 'createormodifycause'
The cause that must be met
Parameter 'dateinterval' : Structure of type 'dateinterval'
The delay before the action is executed
Parameter 'smsdocumentaction' : Structure of type 'smsdocumentaction'
Parameter 'contactaction' : Structure of type 'contactaction'
Parameter 'smsaction' : Structure of type 'smsaction'
Parameter 'faxdocumentaction' : Structure of type 'faxdocumentaction'
Parameter 'modifyaction' : Structure of type 'modifyaction'
Parameter 'emaildocumentaction' : Structure of type 'emaildocumentaction'
Parameter 'removeaction' : Structure of type 'removeaction'
Parameter 'login' : Structure of type 'login'
Optional login data

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

Structure 'matchcause'
This structure matchcause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'modifycause'
This structure modifycause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'createcause'
This structure createcause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'surveycause'
This structure surveycause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'submitcause'
This structure submitcause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'webformcause'
This structure webformcause was mentioned above. This structure has the following properties:
Property 'requiredFields' : Map
Get the required fields.
Property 'requiredInterests' : Map
Retrieve the required interests
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'sendcause'
This structure sendcause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'clickcause'
This structure clickcause was mentioned above. This structure has the following properties:
Property 'filter' : string
The url filter.
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'impressioncause'
This structure impressioncause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'removecause'
This structure removecause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'errorcause'
This structure errorcause was mentioned above. This structure has the following properties:
Property 'filter' : string
Get the error filter.
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'createormodifycause'
This structure createormodifycause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered

Structure 'dateinterval'
This structure dateinterval was mentioned above. This structure has the following properties:
Property 'count' : int
The count of the dateinterval.
Property 'unit' : string
The unit of the dateinterval.

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

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 '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 '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 '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 '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 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'databasefollowup'
This structure databasefollowup was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the followup.