SetEmailTemplates

The SetEmailTemplates call allows you to configure one or more E-mail templates and one or more texts for the templates in various languages.

This call is available since SOAP version 109.

SetEmailTemplates Input

Field Type Occurrence Meaning Available since
CallItemsLimit Integer Optional Call items limit for own server 112
Templates ObjectOptional 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Attachment
Integer Optional Attachment 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
AttachmentDocument
Integer Optional Attachment 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents
ObjectOptional Contents 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents.
PlentySoapObject_SetEmailTemplatesTemplateContent.
ItemList
String Optional ItemList (plain text) 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents.
PlentySoapObject_SetEmailTemplatesTemplateContent.
ItemListHTML
String Optional ItemList (with HTML) 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents.
PlentySoapObject_SetEmailTemplatesTemplateContent.
Lang
String Required Language 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents.
PlentySoapObject_SetEmailTemplatesTemplateContent.
MailBody
String Optional Body of the E-mail (plain text) 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents.
PlentySoapObject_SetEmailTemplatesTemplateContent.
MailBodyHTML
String Optional Body of the E-mail (with HTML) 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents.
PlentySoapObject_SetEmailTemplatesTemplateContent.
MailTitle
String Optional Title of the E-mail 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Contents.
PlentySoapObject_SetEmailTemplatesTemplateContent.
SendAsHTML
Boolean Optional Use the HTML versions 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
ID
Integer Required E-mail template id 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Name
String Optional Name 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
ReplyTo
String Optional Reply to 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
ResponsibleID
Integer Optional ID of the responsible user 109
Templates.
PlentySoapObject_SetEmailTemplatesTemplate.
Type
Integer Optional Type of the template 109

SetEmailTemplates Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

SetEmailTemplates Output

Field Type Occurrence Meaning Available since
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112

SetEmailTemplates Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

Identification Keys

(The dynamicValue stands for any parameter values that could be outputted.)

Key Value
Name dynamicValue

Identification Output schema

The box below lists all identification fields that could be outputted in the call response (version 112). The dynamicValue stands for any parameter values that could be outputted. To learn more about an individual field or its type, click its name in the box.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 - - - The E-mail template was successfully saved.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
810 Limit 50 Too many email templates in request The request contains too many email templates. Max 50 email templates allowed.
800 Lang Missing parameter Required parameter was not entered
800 ID Missing parameter Missing parameter, ID Required parameter was not entered

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<ErrorMessages>
<item> </item>
<item>
<Value>Missing parameter</Value>
</item>
<item>
<Value>Missing parameter</Value>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben