Jump to: navigation, search

Email API Version 2

Updated in

POST /genesys/2/email/{serviceName}
HTTP Header Value
  • multipart/form-data
  • application/x-www-form-urlencoded (starting in
Parameter Name Sample Value Description Required/Optional Comments
firstName "John" first name of the customer Required
lastName "Doe" last name of the customer Required
fromAddress "jdoe@gmail.com" email address of the customer Required
subject "Help with account" email subject


text "I need help with my account" email body as plain text


mailbox "support@company.com" the address to which the email is to be delivered Optional This value takes priority over any configured "mailbox" in the WebAPI application on Config Server
userData key1=value1 User data — can be submitted multiple times Optional
userData key2=value2 User data — can be submitted multiple times Optional
files files to be attached to the email
Use the multipart/form-data Content-Type if you need to attach files. With the application/x-www-form-urlencoded Content-Type, this parameter is ignored.
Constraints Default Value Configuration Parameter Comments
Max no. of files 10 Options / email / max_files
Max size of content 10MB Options / email / max_size
File Types pdf,doc,txt,jpg,png,gif,bmp,zip Options / email / file_types If the parameter "file_types" is configured, it completely overrides the default value
Configuration Parameter Comments
Options / email / mailbox The address to which the email is to be delivered. If no value is set in the incoming request and if this value is set on Config Server then the Config Server value will be set to the mailbox value from the request to Email Server. If neither of these values is set, then Email Server uses its default value.
Options / email / tenant Tenant name which has been assigned to email servers


Content-Type: multipart/form-data; 
Content-Disposition: form-data; name="firstName"
Content-Disposition: form-data; name="lastName"
Content-Disposition: form-data; name="fromAddress"
Content-Disposition: form-data; name="subject"
Hi hello
Content-Disposition: form-data; name="text"
This is the text


HTTP 200 - success
  "statusCode": 0,
HTTP 200 - failure (server down, network failure, etc. Try again)
  "statusCode": 1
This page was last edited on April 27, 2018, at 10:02.


Comment on this article:

blog comments powered by Disqus