SOAP API methode EmailingDocument_setTellafriendDocument
Beschrijving
A document may contain a link to a tell-a-friend form. When this tell-a-friend form is submitted, the tell-a-friend document that is returned by this method will be sent. This is used for mailings that contain tell-a-friend links. The tell-a-friend document is normally almost identical to the original document, but it also contains a header in which is told that the document was requested by a friend.
Parameters
Naam | Type | Beschrijving |
---|---|---|
id * | int | Unique identifier (id) of the object EmailingDocument. The method only applies to the emailingdocument 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 |
emailingdocument | Structure of type 'emailingdocument' | |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* verplichte parameters |
Structuur 'emailingdocument'
Naam | Type | Beschrijving |
---|---|---|
convertedid | int | The converted ID. |
headers | string | The additional headers. |
subject | string | The subject of the emailingdocument. |
fromaddress | EmailAddress | The fromaddress of the emailingdocument. |
fromaddressstatus | string | Get the status of the from address. When a from address is okay to do |
bccaddress | EmailAddress | The bccaddress of this emailingdocument. |
replytoaddress | EmailAddress | The reply-to address of the emailingdocument. |
textversion | string | The textversion of the emailingdocument. |
useinlinestyles | string | Should stylesheets in the document be merged into inline styles? This is usefull |
temporary | boolean | Is this document set as a temporary document. The document will be removed when there are no |
priority_indicator | string | Getting the priority header for emails who use this document |
unsubscribe_header | string | Should the list-unsubscribe header be sent with the mailing. |
size | int | Get the size of the document. |
charset | string | Gets the charset that should be used when showing/sending this document |
htmlEscaping | string | Check if the document is escaping HTML code |
smartyVersion | integer | What smarty version is used to render this document |
id | int | The ID of the document. |
templateID | int | The template ID of the document |
name | string | The name of the document. |
description | string | The description of the document. |
archived | boolean | Is this an archived document?. |
created | timestamp | The date and time when the document was created. |
modified | timestamp | The date and time when the document was last modified. |
language | string | The language of the document. |
timezone | string | Get the time zone of the document. If the timezone is not set, it returns |
Structuur 'login'
Naam | Type | Beschrijving |
---|---|---|
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 |