Email & PDF exposé templates

Resource type: templates

This API call can be used to query email and PDF exposé templates from enterprise. The transmission of the body of a PDF exposé template is currently not available due to technical reasons.

Parameters:

• type
  Template type to be queried (mail, pdf)
• list
  (optional, boolean) Flag, whether a shorter list of all email templates should be returned. This list consists of the ID, the title and the subject. Acts exclusively on email templates.
• mailtemplateids
  (optional, array) Contains specific template IDs to which further information is to be returned.
• category
  email category of the template. Without the parameter all categories are returned. Possible values: Vorlage, Aktivitaeten_Bericht, Interessenten_Nachweis, ExposePDFMitInteressent_Vorlage, appointmentConfirmation, cancelation, adressCompletion, contactShipping

Example:

...
"actions":[
    {
        "actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "resourceid":"",
        "identifier":"",
        "resourcetype":"templates",
        "parameters":{
			"type":"pdf"
        }
    }
]
...

Response (mail):

• id
  ID of the email template
• title
  Title / name of the email template
• subject
  Subject of the email template (can be empty)
• body
  Body of the email template (can be empty). Not returned if parameter "list:true" is set.
• ishtml
  Flag, if this is an HTML template. Not returned if parameter "list:true" is set.

Response (pdf):

• identifier
  ID of the PDF exposé template
• title
  Title / name of the PDF exposé template