SOAP API method CollectionFollowUp_cause

Back to API references

Description
The cause for the followup.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object CollectionFollowUp. The method only applies to the collectionfollowup 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 'sendcause' : Structure of type 'sendcause'
Return value 'errorcause' : Structure of type 'errorcause'
Return value 'createcause' : Structure of type 'createcause'
Return value 'submitcause' : Structure of type 'submitcause'
Return value 'modifycause' : Structure of type 'modifycause'
Return value 'matchcause' : Structure of type 'matchcause'
Return value 'surveycause' : Structure of type 'surveycause'
Return value 'impressioncause' : Structure of type 'impressioncause'
Return value 'removecause' : Structure of type 'removecause'
Return value 'webformcause' : Structure of type 'webformcause'
Return value 'clickcause' : Structure of type 'clickcause'
Return value 'createormodifycause' : Structure of type 'createormodifycause'

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 '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 '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 '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 '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 '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 '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 '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 '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 '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 '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 'createormodifycause'
This structure createormodifycause was mentioned above. This structure has the following properties:
Property 'condition' : string
Get the condition when the cause is triggered