SOAP API method EmailingDocument_createAttachment
Description
Add an attachment to 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 |
filedata | Structure of type 'filedata' | |
pdfdocument | Structure of type 'pdfdocument' | |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
emailingdocumentattachment | Structure of type 'emailingdocumentattachment' |
Structure 'filedata'
Name | Type | Description |
---|---|---|
name | string | The name of the data of the file. |
mimetype | string | The mimetype of the data of the file. |
data | binary | The data of the file. The data is base64 encoded. |
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 '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 'emailingdocumentattachment'
Name | Type | Description |
---|---|---|
type | string | The type of the attachment. |
id | int | The ID of the file. |
mimetype | string | The mimetype of the file. |
hashcode | string | Expose the file hashcode |
data | binary | The data of the file. The data is base64 encoded. |
name | string | The filename of the file. |
size | int | The size of the file. |