SMTP API

This API is only for transactional emails.
Version 1.2



Create group

Groups make it easy to categorize messages with common characteristics. Putting messages into groups enables their advanced filtration and statistics.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
name My Group Group name body string(100)
description My Group Description null Group description body string
Request Example:
{
    "name": "My Group"
}
Example Request URL:
https://smtpapi.clevermonitor.com/v1.2/group
Response Parameters:
Name Data Type Reference Description
code string(100) Group code
name string(100) Group name
description string Group description
create_time ISO8601 Timestamp of creation
Response Messages:
Code Status Example Body
200 OK
{
    "code": "my-group",
    "name": "My Group",
    "description": null,
    "create_time": "2017-03-30T06:53:51+00:00"
}

Overview of groups


Example Request URL:
https://smtpapi.clevermonitor.com/v1.2/group/?count=100&offset=0
Response Parameters:
Name Data Type Reference Description
[n]: code string(100) Group code
[n]: name string(100) Group name
[n]: description string Group description
[n]: create_time ISO8601 Timestamp of creation
Response Messages:
Code Status Example Body
200 OK
[
    {
        "code": "my-group",
        "name": "My Group",
        "description": null,
        "create_time": "2017-03-30T06:53:51+00:00"
    }
]

Delete group

Deletes selected group and allows to move the messages it contains to another existing group. If the parameter "move" is null, the messages will be moved to the main (root) group.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
code my-group Group code path string(100)
move my-second-group null (Main Group) Move messages to other group body string(100)
Request Example:
{
    "move": "my-second-group"
}
Example Request URL:
https://smtpapi.clevermonitor.com/v1.2/group/my-group
Response Parameters:
Name Data Type Reference Description
code string(100) Group code
Response Messages:
Code Status Example Body
200 OK
{
    "code": "my-group"
}

Copyright © CleverMonitor, 2017