Send a Simulated Email

To a contact center agent.

Log in to see full request history

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

simulated-emails:write

Body Request - Example

{ "subject": "Hello", "content": "how are you today", "from": { "name": "from", "email": "from@email.com" }, "to": [ { "name": "to", "email": "to@email.com" } ] }

Body Response - Schema

200 (success - sends an email message to an agent)

The Request Body

ParameterTypeDescriptionRequired
idstringEmail's message ID.
> = 1 characters
<= 255 characters
yes
message_idstringEmail's message ID.
> = 1 characters
<= 255 characters
yes
thread_idstringThread's ID
> = 1 characters
<= 255 characters
yes
interaction_idstringThe interaction ID.
> = 1 characters
<= 255 characters
yes

400 (bad request), 401 (unauthorized), 403 (forbidden), 500 (internal server error)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Body Params
string
required

Email subject. >= 1 characters <= 1000 characters

string
required

the email's content

to
array
required

email send to >= 1 items <= 1000 items. Subdivides into: name (string; email friendly name >= 1 characters <= 200 characters); email (string; email address >= 1 characters <= 200 characters)

to*
Responses

Language
Credentials
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json