Version 1.1

deprecated

Distribution Lists


Create a distribution list

The maximum number of created subscribers is 1.000 per request.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
name Example null List Name body string(100)
note Text null Description body string(100)
parent_id 783bd393-2d70-b263-10fe-23eee3a8cb48 null Parent List ID body string(38)
reactivate true false Reactivate a subscriber? body boolean
emails empty Emails body array
emails: email 'john.doe@example.com' or '82eaba02-1c49-48d1-942d-7eb32a3722d7' null Email or Email ID body string(100)
emails: first_name John null First Name body string(50)
emails: last_name Doe null Last Name body string(50)
emails: vip true false VIP Subscriber body boolean
emails: preferred_com 2 1 Preferred Communication body reference: preferred_com
emails: tags empty Subscriber Tags body array
emails: tags: tag null Subscriber Tag body string(50)
Request Example:
{
    "name": "Distribution Group",
    "note": "Description",
    "parent_id": "5ff42ca6-1965-49ed-97d0-b2b568c88bfd",
    "emails": [
        {
            "email": "john.doe@example.com",
            "first_name": "John",
            "last_name": "Doe",
            "vip": true
        }
    ]
}
Example Request URL:
https://api.clevermonitor.com/v1.1/lists
Response Parameters:
Name Data Type Reference Description
name string(100) List Name
list_id string(38) List ID
subscribers array Subscribers Array
subscribers: processed integer Processed Count
subscribers: assign_new integer Count of new assign of subscribers
subscribers: assign_exist integer Count of exists assign of subscribers
subscribers: subscribers_new integer Count of new subscribers
subscribers: subscribers_inactive integer Count of inactive subscribers
subscribers: subscribers_reactivate integer Count of reactivate subscribers
subscribers: errors integer Count of errors
subscribers: procesed_emails array Array of processed emails
subscribers: processed_emails: subscriber_status integer(3) record_status Subscriber Creation Status
subscribers: processed_emails: list_status integer(3) record_status List Creation Status
subscribers: processed_emails: email string(100) Email
Response Messages:
Code Status Example Body
200 OK
{
    "name": "Distribution Group",
    "list_id": "70639670-b5d6-443c-c56a-7d93593e2c95",
    "subscribers": {
        "processed": 1,
        "assign_new": 1,
        "assign_exists": 0,
        "subscribers_new": 1,
        "subscribers_inactive": 0,
        "subscribers_reactivate": 0,
        "errors": 0,
        "processed_emails": [
            {
                "email": "john.doe@example.com",
                "list_status": 200,
                "subscriber_status": 200
            }
        ]
    }
}

Overview of distribution lists


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
count 1000 100 Count of records Query integer (max. 1.000)
offset 1000 0 Offset Query integer
Example Request URL:
https://api.clevermonitor.com/v1.1/lists/?count=100&offset=0
Response Parameters:
Name Data Type Reference Description
list_id string(38) List ID
name string(100) Name
note string(100) Description
parent_id string(38) Parent List ID
subscribers integer(15) Number of subscribers in a list
date_form ISO 8601 Creation Date
Response Messages:
Code Status Example Body
200 OK
[
    {
        "list_id": "5ff42ca6-1965-49ed-97d0-b2b568c88bfd",
        "name": "Name 1",
        "note": "Description 1",
        "subscribers": 30001,
        "date_from": "2016-01-07T00:00:00+01:00",
        "parent_id": null
    },
    {
        "list_id": "c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
        "name": "Name 2",
        "note": "Description 2",
        "subscribers": 0,
        "date_from": "2016-01-23T00:00:00+01:00",
        "parent_id": null
    }
]

Detail of distribution list


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
list_id 5ff42ca6-1965-49ed-97d0-b2b568c88bfd null List ID path string(38)
Request Example:
{
    "name": "Distributing List",
    "note": "Description"
}
Example Request URL:
https://api.clevermonitor.com/v1.1/lists/5ff42ca6-1965-49ed-97d0-b2b568c88bfd
Response Parameters:
Name Data Type Reference Description
list_id string(38) List ID
name string(100) Name
note string(100) Description
parent_id string(38) Parent List ID
subscribers integer(15) Number of subscribers in a list
date_form ISO 8601 Creation Date
Response Messages:
Code Status Example Body
200 OK
{
    "list_id": "5ff42ca6-1965-49ed-97d0-b2b568c88bfd",
    "name": "Name 1",
    "note": "Description 1",
    "subscribers": 30001,
    "date_from": "2016-01-07T00:00:00+01:00",
    "parent_id": null
}

Update a distribution list


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
list_id 5ff42ca6-1965-49ed-97d0-b2b568c88bfd null List ID path string(38)
name Distribution List notset List Name body string(100)
note Description notset Description body string(100)
parent_id 5ff42ca6-1965-49ed-97d0-b2b568c88bfd notset Parent List ID body string(38)
Request Example:
{
    "name": "Distribution List",
    "note": "",
    "subscribers": 0,
    "parent_id": null
}
Example Request URL:
https://api.clevermonitor.com/v1.1/lists/5ff42ca6-1965-49ed-97d0-b2b568c88bfd
Response Parameters:
Name Data Type Reference Description
list_id string(38) List ID
name string(100) Name
note string(100) Description
parent_id string(38) Parent List ID
subscribers integer(15) Number of subscribers in a list
date_form ISO 8601 Creation Date
Response Messages:
Code Status Example Body
200 OK
{
    "list_id": "e5f55382-32d5-c161-6cb0-fb7f2ce2dbb6",
    "name": "Distribution List",
    "note": "Description",
    "subscribers": 0,
    "date_from": "2016-02-24T00:00:00+01:00",
    "parent_id": null
}

Delete a distribution list


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
list_id 5ff42ca6-1965-49ed-97d0-b2b568c88bfd null List ID path string(38)
Example Request URL:
https://api.clevermonitor.com/v1.1/lists/5ff42ca6-1965-49ed-97d0-b2b568c88bfd
Response Parameters:
Name Data Type Reference Description
list_id string(38) Deleted List ID
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "list_id": "5ff42ca6-1965-49ed-97d0-b2b568c88bfd",
    "message": "Distribution list deleted"
}

Preview subscribers in a distribution list


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
list_id 5ff42ca6-1965-49ed-97d0-b2b568c88bfd null List ID path string(38)
count 100 100 Number of records Query integer (max. 1.000)
offset 1000 0 Offset Query integer
Example Request URL:
https://api.clevermonitor.com/v1.1/lists/5ff42ca6-1965-49ed-97d0-b2b568c88bfd/subscribers/?count=100&offset=0
Response Parameters:
Name Data Type Reference Description
email_id string(38) Email ID
email string(100) Email
first_name string(50) First Name
last_name string(50) Last Name
date_from ISO 8601 Creation date
Response Messages:
Code Status Example Body
200 OK
[
    {
        "email_id": "3a356606-f460-5f80-4b3f-7f0edb64b0b7",
        "email": "john.doe@example.com",
        "first_name": null,
        "last_name": "john.doe",
        "date_from": "2016-02-24T00:00:00+01:00"
    }
]

Adding subscribers to a distribution list

The maximum number of created subscribers is 1.000 per request.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
list_id 5ff42ca6-1965-49ed-97d0-b2b568c88bfd null List ID path string(38)
reactivate true false Reactivate subscribers? body boolean
emails empty Emails body array
emails: email john.doe@example.com null Email or Email ID body string(100)
emails: first_name John null First Name body string(50)
emails: last_name Doe null Last Name body string(50)
emails: vip true false VIP Subscriber body boolean
emails: preferred_com 2 1 Preferred Communication body reference: preferred_com
emails: tags empty Subscriber Tags body array
emails: tags: tag null Subscriber Tag body string(50)
Request Example:
{
    "emails": [
        {
            "email": "john.doe@example.com",
            "first_name": "John",
            "last_name": "Doe"
        }
    ]
}
Example Request URL:
https://api.clevermonitor.com/v1.1/lists/5ff42ca6-1965-49ed-97d0-b2b568c88bfd/subscribers
Response Parameters:
Name Data Type Reference Description
name string(100) List Name
list_id string(38) List ID
processed integer Count of processed subscribers
assign_new integer Count of new assign subscribers
assign_exist integer Count of exists assign subscribers
subscribers_new integer Count of new subscribers
subscribers_inactive integer Count of inactive subscribers
subscribers_reactivate integer Count of reactivate subscribers
errors integer Errors Count
processed_emails array Array of processed emails
processed_emails: subscriber_status integer(3) record_status Subscriber Creation Status
processed_emails: list_status integer(3) record_status List Creation Status
processed_emails: email string(100) Email
Response Messages:
Code Status Example Body
200 OK
{
    "name": "Distributing Group",
    "list_id": "36505d01-1106-3b9a-91c1-a362078d347c",
    "processed": 1,
    "assign_new": 1,
    "assign_exists": 0,
    "subscribers_new": 1,
    "subscribers_inactive": 0,
    "subscribers_reactivate": 0,
    "errors": 0,
    "processed_emails": [
        {
            "subscriber_status": 200,
            "list_status": 200,
            "email": "john.doe@example.com"
        }
    ]
}

Delete subscribers in a distribution list

The maximum number of deleted subscribers is 1.000 per request.


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
list_id 5ff42ca6-1965-49ed-97d0-b2b568c88bfd null List ID path string(38)
emails empty Emails body array
emails: email john.doe@example.com null Email or Email ID body string(100)
Request Example:
{
    "emails": [
        {
            "email": "john.doe@example.com"
        }
    ]
}
Example Request URL:
https://api.clevermonitor.com/v1.1/lists/5ff42ca6-1965-49ed-97d0-b2b568c88bfd/subscribers
Response Parameters:
Name Data Type Reference Description
name string(100) List Name
list_id string(38) List ID
subscribers_processed integer Number of processed subscribers
subscribers_delete integer Number of deleted subscribers
subscribers_error string(38) Number of error subscribers
error array Error subscribers
error: email string(100) Email
error: email_id string(38) Email ID
delete array Deleted Subscribers
delete: email string(100) Email
delete: email_id string(38) Email ID
Response Messages:
Code Status Example Body
200 OK
{
    "name": "Distribution List",
    "list_id": "c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
    "subscribers_delete": 1,
    "subscribers_error": 0,
    "subscribers_processed": 1,
    "delete": [
        {
            "email": "john.doe@example.com",
            "email_id": "5508f3cc-ccb8-5cf2-edbc-a1e82d090bcf"
        }
    ],
    "error": []
}

Copyright © CleverMonitor, 2017