SOAP API method EmailingDocument_createFile

Back to API references

Description
This method will add an file that is linked to the document directly.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object EmailingDocument. The method only applies to the emailingdocument with this id.
Parameter 'personalize_profile' : int
Profile ID for which the object should be personalized
Parameter 'personalize_subprofile' : int
Subprofile ID for which the object should be personalized
Parameter 'personalize_timestamp' : string
The timestamp for the personalization
Parameter 'filedata' : Structure of type 'filedata'
Parameter 'metadata' : Collection of type 'metadata'
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'webdocumentfile' : Structure of type 'webdocumentfile'
Return value 'emailingdocumentfile' : Structure of type 'emailingdocumentfile'

Structure 'filedata'
This structure filedata was mentioned above. This structure has the following properties:
Property 'name' : string
The name of the data of the file.
Property 'mimetype' : string
The mimetype of the data of the file.
Property 'data' : binary
The data of the file. The data is base64 encoded.

Structure 'pair'
This structure pair was mentioned above. This structure has the following properties:
Property 'key' : string
Property 'value' : string

Structure 'metadata'
This structure metadata was mentioned above. This structure has the following properties:
Property 'pair' : Structure of type 'pair'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'webdocumentfile'
This structure webdocumentfile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the file.
Property 'mimetype' : string
The mimetype of the file.
Property 'hashcode' : string
Expose the file hashcode
Property 'data' : binary
The data of the file. The data is base64 encoded.
Property 'name' : string
The filename of the file.
Property 'size' : int
The size of the file.

Structure 'emailingdocumentfile'
This structure emailingdocumentfile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the file.
Property 'mimetype' : string
The mimetype of the file.
Property 'hashcode' : string
Expose the file hashcode
Property 'data' : binary
The data of the file. The data is base64 encoded.
Property 'name' : string
The filename of the file.
Property 'size' : int
The size of the file.