Back to API references

SOAP API method DocumentFollowUp_cause

Description

The cause for the followup.

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
surveycause Structure of type 'surveycause'
matchcause Structure of type 'matchcause'
clickcause Structure of type 'clickcause'
createcause Structure of type 'createcause'
impressioncause Structure of type 'impressioncause'
createormodifycause Structure of type 'createormodifycause'
removecause Structure of type 'removecause'
sendcause Structure of type 'sendcause'
modifycause Structure of type 'modifycause'
submitcause Structure of type 'submitcause'
webformcause Structure of type 'webformcause'
errorcause Structure of type 'errorcause'

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

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

Name Type Description
filter string The url 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 'impressioncause'

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

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

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

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