Send Email

Overview

This operation sends an e-mail interaction.

URI	HTTP Method	HTTP Header	Value
/api/v2/emails	POST	Content-Type	multipart/form-data

Parameters

Parameter Name	Sample Value	Description	Required/Optional
firstName	"John"	The first name of the customer.	Required
lastName	"Doe"	The last name of the customer.	Required
tenantName	"Environment"	The tenant name.	Required
fromAddress	"jdoe@gmail.com"	The e-mail address of the customer.	Required
subject	"Help with account"	The subject line of the e-mail interaction.	Required
text	"I need help with my account"	The body of the e-mail interaction.	Required
mailbox	support@company.com	The address to which the e-mail interaction is to be delivered. Important This value takes priority over any configured mailbox in WebAPI application on the Configuration Server	Optional
userData	key1=value1	user data—can be submitted multiple times	Optional
userData	key2=value2	user data—can be submitted multiple times	Optional
files		Any files to be attached to the e-mail interaction.	Optional

Constraints

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 overrides the default value.

Other configurations

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 this value is set on the Configuration Server, the Configuration Server value will be set as the mailbox in the request to the EmailServer. If neither of these values are set, the EmailServer sets it using EmailServer defaults.

Example

Request

Content-Type: multipart/form-data; boundary="WebKitFormBoundaryE19zNvXGzXaLvS5C"
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="firstName"
 
Name
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="lastName"
 
LastName
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="fromAddress"
 
john@doe.com
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="subject"
 
Hi hello
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="text"
 
This is the text
----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="tenantName"
 
Environment
----WebKitFormBoundaryE19zNvXGzXaLvS5C

Response

HTTP 200 - success
{
  "interactionId":"0000KaA0C8XH003X"
}