SOAP API method EmailingDestination_registerClick

Back to API references

Description
Register the click of this destination.

Parameters
Parameter 'id' : string
Unique identifier (id) of the object EmailingDestination. The method only applies to the emailingdestination with this id.
Parameter 'ip' : string
The remote IP address
Parameter 'useragent' : string
The value of the user-agent header
Parameter 'referer' : string
The value of the referer
Parameter 'link' : Structure of type 'link'
The link that was clicked
Parameter 'emailingdocumentsnapshotlink' : Structure of type 'emailingdocumentsnapshotlink'
The link that was clicked
Parameter 'timestamp' : timestamp
Optional timestamp when click was registered
Parameter 'sequence' : integer
Link sequence number
Parameter 'header' : string
The full header
Parameter 'login' : Structure of type 'login'
Optional login data

Structure 'link'
This structure link was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the link.
Property 'url' : string
The url or destination of the link.
Property 'title' : string
The title of the link.

Structure 'emailingdocumentsnapshotlink'
This structure emailingdocumentsnapshotlink was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the link.
Property 'url' : string
The url or destination of the link.
Property 'title' : string
The title of the link.

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