Back to API references

SOAP API method EmailingDocument_block

Description

A single block of the document.

Parameters

Name Type Description
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
identifier * string
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
webdocumentimageblock Structure of type 'webdocumentimageblock'
emailingdocumentimageblock Structure of type 'emailingdocumentimageblock'
webdocumenttextblock Structure of type 'webdocumenttextblock'
emailingdocumenttextblock Structure of type 'emailingdocumenttextblock'
emailingdocumentloopblock Structure of type 'emailingdocumentloopblock'
webdocumentloopblock Structure of type 'webdocumentloopblock'

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

Name Type Description
id string The ID of the block.
name string The name of the block.
iteration int The iteration of the parent block.
condition string Get the javascript condition used to determine if the block is shown in the document

Structure 'emailingdocumentimageblock'

Name Type Description
id string The ID of the block.
name string The name of the block.
iteration int The iteration of the parent block.
condition string Get the javascript condition used to determine if the block is shown in the document

Structure 'webdocumenttextblock'

Name Type Description
content string The content of this textblock.
id string The ID of the block.
name string The name of the block.
iteration int The iteration of the parent block.
condition string Get the javascript condition used to determine if the block is shown in the document

Structure 'emailingdocumenttextblock'

Name Type Description
content string The content of this textblock.
id string The ID of the block.
name string The name of the block.
iteration int The iteration of the parent block.
condition string Get the javascript condition used to determine if the block is shown in the document

Structure 'emailingdocumentloopblock'

Name Type Description
iterations int The number of iterations of the loopblock.
id string The ID of the block.
name string The name of the block.
iteration int The iteration of the parent block.
condition string Get the javascript condition used to determine if the block is shown in the document

Structure 'webdocumentloopblock'

Name Type Description
iterations int The number of iterations of the loopblock.
id string The ID of the block.
name string The name of the block.
iteration int The iteration of the parent block.
condition string Get the javascript condition used to determine if the block is shown in the document