Back to API references

SOAP API method EmailingDestination_registerClick

Description

Register the click of this destination.

Parameters

Name Type Description
id * string Unique identifier (id) of the object EmailingDestination. The method only applies to the emailingdestination with this id.
ip * string The remote IP address
useragent * string The value of the user-agent header
referer * string The value of the referer
link Structure of type 'link' The link that was clicked
emailingdocumentsnapshotlink Structure of type 'emailingdocumentsnapshotlink' The link that was clicked
timestamp timestamp Optional timestamp when click was registered
sequence integer Link sequence number
header string The full header
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Structure 'link'

Name Type Description
id int The ID of the link.
url string The url or destination of the link.
title string The title of the link.

Structure 'emailingdocumentsnapshotlink'

Name Type Description
id int The ID of the link.
url string The url or destination of the link.
title string The title of the link.

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