Send a Simulated Email

📘
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": "[email protected]"
  },
  "to": [
    {
      "name": "to",
      "email": "[email protected]"
    }
  ]
}

Body Response - Schema

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

The Request Body

Parameter	Type	Description	Required
id	string	Email's message ID. = 1 characters <= 255 characters	yes
message_id	string	Email's message ID. = 1 characters <= 255 characters	yes
thread_id	string	Thread's ID = 1 characters <= 255 characters	yes
interaction_id	string	The interaction ID. = 1 characters <= 255 characters	yes

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

Parameter	Type	Description	Required
code	string	n/a	yes
message	string	n/a	yes
description	string	n/a	no
fields	array[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.