Back to API references

SOAP API method EmailingDocumentSnapshot_link

Description

A single link of the emailingdocumentsnapshot.

Parameters

Name Type Description
id * int Unique identifier (id) of the object EmailingDocumentSnapshot. The method only applies to the emailingdocumentsnapshot 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
linkid * int
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
emailingdocumentsnapshotlink Structure of type 'emailingdocumentsnapshotlink'

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