SOAP API method PdfDocument_copy
Description
Copy the document and return a newly created document
Parameters
Name | Type | Description |
---|---|---|
id * | int | Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument 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 |
name * | string | Name of the new document |
webtemplate | Structure of type 'webtemplate' | template to copy the document to |
emailingtemplate | Structure of type 'emailingtemplate' | template to copy the document to |
pdftemplate | Structure of type 'pdftemplate' | template to copy the document to |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
pdfdocument | Structure of type 'pdfdocument' | |
webdocument | Structure of type 'webdocument' | |
emailingdocument | Structure of type 'emailingdocument' | |
smsdocument | Structure of type 'smsdocument' |
Structure 'webtemplate'
Name | Type | Description |
---|---|---|
charset | string | The charset of the htmltemplate. |
htmlEscaping | string | Check if the template is escaping HTML code |
smartyVersion | integer | What smarty version is used to render this template |
upgradeSmartyVersion | integer | Upgrade smartyversion 2 to 3 |
id | int | The ID of the template. |
name | string | The name of the template. |
description | string | The description of the template. |
archived | boolean | The template is archived. |
created | timestamp | When the template was created. |
modified | timestamp | When the template was last modified. |
language | string | The language of the template. |
timezone | string | Get the timezone of the template |
Structure 'emailingtemplate'
Name | Type | Description |
---|---|---|
convertedid | int | The converted ID of the emailingtemplate. |
headers | string | The additional headers of the emailingtemplate. |
textversion | string | The textversion of the template. |
useinlinestyles | string | Should stylesheets in document based on the template be merged into inline |
priority_indicator | string | Getting the priority header for emails who use this template |
unsubscribe_header | string | Should the list-unsubscribe header be sent with the mailing. |
fromaddress | EmailAddress | The fromaddress of the emailingtemplate. |
bccaddress | EmailAddress | The default bcc address of this emailing template. |
replytoaddress | EmailAddress | The default reply-to address of the emailing template. |
charset | string | The charset of the htmltemplate. |
htmlEscaping | string | Check if the template is escaping HTML code |
smartyVersion | integer | What smarty version is used to render this template |
upgradeSmartyVersion | integer | Upgrade smartyversion 2 to 3 |
id | int | The ID of the template. |
name | string | The name of the template. |
description | string | The description of the template. |
archived | boolean | The template is archived. |
created | timestamp | When the template was created. |
modified | timestamp | When the template was last modified. |
language | string | The language of the template. |
timezone | string | Get the timezone of the template |
Structure 'pdftemplate'
Name | Type | Description |
---|---|---|
hashcode | string | Hashcode of the template |
source | binary | The source of the template. The data is base64 encoded. |
pagecount | int | The number of pages of the template. |
size | int | The size of the template. |
id | int | The ID of the template. |
name | string | The name of the template. |
description | string | The description of the template. |
archived | boolean | The template is archived. |
created | timestamp | When the template was created. |
modified | timestamp | When the template was last modified. |
language | string | The language of the template. |
timezone | string | Get the timezone of the template |
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 'pdfdocument'
Name | Type | Description |
---|---|---|
status | string | Status of the document. |
pagecount | int | The number of pages in the document. |
size | int | The size of the document. |
faxheader | string | The headerline above the fax. |
temporary | boolean | Is this document set as a temporary document. The document will be removed when there are no |
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 |
Structure 'webdocument'
Name | Type | Description |
---|---|---|
loginrequired | boolean | The page is only available for logged in profiles or subprofiles. |
enabled | boolean | Page enabled. |
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 |
Structure 'emailingdocument'
Name | Type | Description |
---|---|---|
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 |
Structure 'smsdocument'
Name | Type | Description |
---|---|---|
from | string | The from address of the sms document. |
message | string | The message of the sms. |
temporary | boolean | Is this document set as a temporary document. The document will be removed when there are no |
size | int | Get the size of the document. |
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 |