Back to API references

SOAP API method EmailingDocumentTextBlock_templateBlock

Description

The template block of this block.

Parameters

Name Type Description
id * string Unique identifier (id) of the object EmailingDocumentTextBlock. The method only applies to the emailingdocumenttextblock with this id.
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
emailingtemplateimageblock Structure of type 'emailingtemplateimageblock'
webtemplateimageblock Structure of type 'webtemplateimageblock'
webtemplatetextblock Structure of type 'webtemplatetextblock'
emailingtemplatetextblock Structure of type 'emailingtemplatetextblock'
emailingtemplateloopblock Structure of type 'emailingtemplateloopblock'
webtemplateloopblock Structure of type 'webtemplateloopblock'

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

Name Type Description
width int The width of the imageblock.
height int The height of the imageblock.
maxwidth int The maxwidth of the imageblock.
maxheight int The maxheight of the imageblock.
minwidth int The minwidth of the imageblock.
minheight int The minheight of the imageblock.
id string The ID of the block.
name string The name of the block.
begin string The HTML code that is displayed in front of the block, when the block exists.
end string The HTML code that is displayed at the end of the block, when the block exists.

Structure 'webtemplateimageblock'

Name Type Description
width int The width of the imageblock.
height int The height of the imageblock.
maxwidth int The maxwidth of the imageblock.
maxheight int The maxheight of the imageblock.
minwidth int The minwidth of the imageblock.
minheight int The minheight of the imageblock.
id string The ID of the block.
name string The name of the block.
begin string The HTML code that is displayed in front of the block, when the block exists.
end string The HTML code that is displayed at the end of the block, when the block exists.

Structure 'webtemplatetextblock'

Name Type Description
id string The ID of the block.
name string The name of the block.
begin string The HTML code that is displayed in front of the block, when the block exists.
end string The HTML code that is displayed at the end of the block, when the block exists.

Structure 'emailingtemplatetextblock'

Name Type Description
id string The ID of the block.
name string The name of the block.
begin string The HTML code that is displayed in front of the block, when the block exists.
end string The HTML code that is displayed at the end of the block, when the block exists.

Structure 'emailingtemplateloopblock'

Name Type Description
miniterations int The minimum number of iterations.
maxiterations int The maximum number of iterations.
id string The ID of the block.
name string The name of the block.
begin string The HTML code that is displayed in front of the block, when the block exists.
end string The HTML code that is displayed at the end of the block, when the block exists.

Structure 'webtemplateloopblock'

Name Type Description
miniterations int The minimum number of iterations.
maxiterations int The maximum number of iterations.
id string The ID of the block.
name string The name of the block.
begin string The HTML code that is displayed in front of the block, when the block exists.
end string The HTML code that is displayed at the end of the block, when the block exists.