Summary
Send Email
Description
Email a message.
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| from |
string |
yes |
Email address to send from. |
| to |
array |
yes |
List of email addresses (recipients). |
| subject |
string |
yes |
Subject of email. |
| text |
string |
yes |
Body of email. |
Copied to Clipboard
{
"from": "example@itential.com",
"to": [
"example@itential.com"
],
"subject": "Successful Device Deployment",
"text": "Your device successfully deployed with the following details..."
}
Copied to Clipboard
{
"type": "object",
"properties": {
"from": {
"title": "from",
"type": "string",
"examples": [
"example@itential.com"
]
},
"to": {
"title": "to",
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"example@itential.com"
]
]
},
"subject": {
"title": "subject",
"type": "string",
"examples": [
"Successful Device Deployment"
]
},
"text": {
"title": "text",
"type": "string",
"examples": [
"Your device successfully deployed with the following details..."
]
}
},
"required": [
"from",
"to",
"subject",
"text"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Response from email notify. |
Copied to Clipboard
{
"accepted": [
"example@itential.com",
"example@itential.com",
"example@itential.com",
"example@itential.com",
"example@itential.com"
],
"rejected": [
"example@itential.com",
"example@itential.com",
"example@itential.com"
]
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"accepted": {
"type": "array",
"items": {
"type": "string",
"examples": [
"example@itential.com"
]
}
},
"rejected": {
"type": "array",
"items": {
"type": "string",
"examples": [
"example@itential.com"
]
}
}
}
}
