SOAP API method PdfDocument_setProperty

Back to API references

Description
can be used for personalizing the document. The properties are defined in the template, and can be given a value on the document level

Parameters
Parameter 'id' : int
Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument 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 'emailingtemplateproperty' : Structure of type 'emailingtemplateproperty'
Parameter 'pdftemplateproperty' : Structure of type 'pdftemplateproperty'
Parameter 'name' : int
Parameter 'name' : string
Parameter 'value' : string
Parameter 'login' : Structure of type 'login'
Optional login data

Structure 'emailingtemplateproperty'
This structure emailingtemplateproperty was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the property.
Property 'name' : string
The name of the property.
Property 'type' : string
The type of the property.
Property 'defaultValue' : string
The default value of the property

Structure 'pdftemplateproperty'
This structure pdftemplateproperty was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the property.
Property 'name' : string
The name of the property.
Property 'type' : string
The type of the property.
Property 'defaultValue' : string
The default value of the property

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