Version 1.1

deprecated

Subscribers


Create a subscriber


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email john.doe@example.com null Email body string(100)
first_name John null First Name body string(50)
last_name Doe null Last Name body string(50)
reactivate true false Reactivate a subscriber? body boolean
company Example null Company name body string(50)
salutation Mr. null Salutation body string(100)
alias John null Alias body string(100)
anniversary 2016-01-07T00:00:00+01:00 null Anniversary body ISO 8601
vip true false VIP Subscriber body boolean
preferred_com 1 1 Prefferred Communication body reference: preferred_com
contacts null Contacts - others body array
contacts: contact City 1 null Contact body string(50)
contacts: contact_type 99 99 Contact Type body reference: contact_type
tags null Tags body array
tags: tag my-group null Tag body string(50)
lists null Distribution Lists body array
lists: list 82eaba02-1c49-48d1-942d-7eb32a3722d7 null List ID body string(38)
Request Example:
{
    "email": "mike.johnson@example.com",
    "first_name": "Mike",
    "last_name": "Johnson",
    "company": "My Company",
    "lists": [
        "c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
        "5d16b01e-6927-651b-ef08-548485a0fd55"
    ],
    "contacts": [
        {
            "contact": "My City",
            "contact_type": 1
        }
    ],
    "tags": [
        "my-tag"
    ]
}
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/email
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(38) Email ID
record_status integer(3) record_status Subscriber Creation Status
contacts array Contacts - others
contacts: contact string(50) Contact
contacts: record_status integer(3) record_status Contact Creation Status
tags array Tags
tags: tag string(50) Tag
tags: record_status integer(3) record_status Tag Creation Status
lists array Distribution Lists
lists: list_id string(38) List ID
lists: record_status integer(3) record_status List Creation Status
Response Messages:
Code Status Example Body
201 OK
{
    "email": "mike.johnson@example.com",
    "email_id": "882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c",
    "record_status": 202,
    "contacts": [
        {
            "contact": "My City",
            "record_status": 202
        }
    ],
    "tags": [
        {
            "tag": "my-tag",
            "record_status": 202
        }
    ],
    "lists": [
        {
            "list_id": "c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
            "record_status": 202
        },
        {
            "list_id": "5d16b01e-6927-651b-ef08-548485a0fd55",
            "record_status": 202
        }
    ]
}

Detail of subscriber


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email john.doe@example.com null Email or Email ID body string(100)
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/email/john.doe@example.com
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(100) Email_id
first_name string(50) First Name
last_name string(50) Last Name
email_status integer(2) contact_status Email Status
subscriber_status integer(2) contact_status Subscriber Status
company string(50) Company name
salutation string(100) Salutation
alias string(100) Alias
anniversary ISO 8601 Anniversary
vip boolean VIP Subscriber
preferred_com int(3) preferred_com Prefferred Communication
contacts array Contacts - others
contacts: contact string(50) Contact
contacts: contact_type int(2) contact_type Contact type
tags array Tags
tags: tag string(50) Tag
lists array Distribution Lists
lists: list string(38) List ID
lists: date_from ISO 8061 Date From
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com",
    "email_id": "89dae0a6-14fe-c46c-cc4b-95440e95c1a0",
    "first_name": "John",
    "last_name": "Doe",
    "email_status": 1,
    "subscriber_status": 1,
    "company": null,
    "salutation": null,
    "alias": null,
    "anniversary": null,
    "vip": 1,
    "preferred_com": 1,
    "contacts": [],
    "tags": [],
    "lists": [
        {
            "list_id": "51aa2978-f1ac-37a2-cc15-443177b3581e",
            "date_from": "2016-02-26T00:00:00+01:00"
        },
        {
            "list_id": "70639670-b5d6-443c-c56a-7d93593e2c95",
            "date_from": "2016-02-26T00:00:00+01:00"
        }
    ]
}

Unsubscribe


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email john.doe@example.com null Email or Email ID path string(100)
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/email/unsubscribe/john.doe@example.com
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(38) Email ID
Message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com",
    "email_id": "89dae0a6-14fe-c46c-cc4b-95440e95c1a0",
    "message": "Subscriber unsubscribed"
}

Delete a subscriber


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email john.doe@example.com null Email or Email ID path string(100)
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/email/john.doe@example.com
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(38) Email ID
Message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com",
    "email_id": "89dae0a6-14fe-c46c-cc4b-95440e95c1a0",
    "message": "Subscriber deleted"
}

Subscribers report


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
contact_status 99 1 Contact Status Query reference: contact_status
count 10 100 Count of records Query integer(4) max(1.000)
offset 10 0 Offset Query integer(4)
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/?contact_status=99&count=1&offset=0
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(100) Email_id
first_name string(50) First Name
last_name string(50) Last Name
email_status integer(2) contact_status Email Status
subscriber_status integer(2) contact_status Subscriber Status
company string(50) Company name
salutation string(100) Salutation
alias string(100) Alias
anniversary ISO 8601 Anniversary
vip boolean VIP Subscriber
preferred_com int(3) preferred_com Prefferred Communication
contacts array Contacts - others
contacts: contact string(50) Contact
contacts: contact_type int(2) contact_type Contact Type
tags array Tags
tags: tag string(50) Tag
lists array Distribution Lists
lists: list string(38) List ID
lists: date_from ISO 8061 Date From
Response Messages:
Code Status Example Body
200 OK
[
    {
        "email": "john.doe@example.com",
        "email_id": "6e2fc510-404a-1609-a520-627b28e508bf",
        "first_name": "John",
        "last_name": "Doe",
        "email_status": 1,
        "subscriber_status": 1,
        "company": "My Company",
        "salutation": "Hello John",
        "alias": null,
        "anniversary": null,
        "vip": 1,
        "preferred_com": 1,
        "contacts": [],
        "tags": [],
        "lists": [
            {
                "list_id": "bfe0f29f-5a70-6037-1ed0-948d23580226",
                "date_from": "2016-02-25T00:00:00+01:00"
            },
            {
                "list_id": "6eafcf0a-0a92-8788-5b7b-5c8aa8c4dafb",
                "date_from": "2016-02-25T00:00:00+01:00"
            }
        ]
    },
    {
        "email": "mike.johnson@example.com",
        "email_id": "f065f84f-8824-9aa8-b1ee-6f6475106add",
        "first_name": "Mike",
        "last_name": "Johnson",
        "email_status": 99,
        "subscriber_status": 99,
        "company": null,
        "salutation": null,
        "alias": null,
        "anniversary": null,
        "vip": 0,
        "preferred_com": 1,
        "contacts": [],
        "tags": [],
        "lists": [
            {
                "list_id": "b49170ef-8803-8517-67b8-14ee4b5f1ac9",
                "date_from": "2016-02-25T00:00:00+01:00"
            }
        ]
    }
]

Update a subscriber


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email 5ff42ca6-1965-49ed-97d0-b2b568c88bfd null Email or Email ID body string(100)
first_name Mike null First Name body string(50)
last_name Johnson null Last Name body string(50)
salutation Mr. null Salutation body string(100)
alias John null Alias body string(100)
anniversary 2016-01-07T00:00:00+01:00 null Anniversary body ISO 8601
vip true false VIP Subscriber body boolean
preferred_com 1 1 Prefferred Communication body reference: preferred_com
contacts null Contacts - others body array
contacts: contact City 1 null Contact body string(50)
contacts: contact_type 99 99 Contact Type body reference: contact_type
tags null Tags body array
tags: tag my-group null Tag body string(50)
lists null Distribution Lists body array
lists: list 82eaba02-1c49-48d1-942d-7eb32a3722d7 null List ID body string(38)
Request Example:
{
    "first_name": "Mike",
    "last_name": "Johnson",
    "company": "My Company",
    "lists": [
        "c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
        "5d16b01e-6927-651b-ef08-548485a0fd55"
    ],
    "contacts": [
        {
            "contact": "My City",
            "contact_type": 1
        }
    ],
    "tags": [
        "my-tag"
    ]
}
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/email/5ff42ca6-1965-49ed-97d0-b2b568c88bfd
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(38) Email ID
record_status integer(3) record_status Subscriber Creation Status
contacts array Contacts
contacts: contact string(50) Contact
contacts: record_status integer(3) record_status Contact Creation Status
tags array Contacts
tags: tag string(50) Tag
tags: record_status integer(3) record_status Tag Creation Status
lists array Contacts
lists: list_id string(38) List ID
lists: record_status integer(3) record_status List Creation Status
Response Messages:
Code Status Example Body
200 OK
{
    "email": "mike.johnson@example.com",
    "email_id": "882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c",
    "record_status": 204,
    "tags": [
        {
            "tag": "my-tag",
            "record_status": 200
        }
    ],
    "contacts": [
        {
            "contact": "My City",
            "record_status": 202
        }
    ],
    "lists": [
        {
            "list_id": "c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
            "record_status": 202
        },
        {
            "list_id": "5d16b01e-6927-651b-ef08-548485a0fd55",
            "record_status": 202
        }
    ]
}

Remove subscriber from distribution list


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email 882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c null Email or Email ID path string(100)
list_id 882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c null List ID path string(38)
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/email/882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c/list
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(38) Email_id
list_id string(38) List ID
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com",
    "email_id": "b75e6092-a820-11e3-9cb5-9c8e99c49306",
    "list_id": "cec09f22-6ddb-11e5-b85d-08002789d050",
    "message": "List assign was deleted!"
}

Remove tag form subscriber


Request Parameters:
Name Example Value Default Value Description Type Data Type Required
email 882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c null Email or Email ID path string(100)
tag example_tag null Tag body string(100)
Example Request URL:
https://api.clevermonitor.com/v1.1/subscribers/email/882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c/tag
Response Parameters:
Name Data Type Reference Description
email string(100) Email
email_id string(38) Email_id
tag string(100) Tag
message string Message
Response Messages:
Code Status Example Body
200 OK
{
    "email": "john.doe@example.com",
    "email_id": "b75e6092-a820-11e3-9cb5-9c8e99c49306",
    "tag": "example_tag",
    "message": "Tag was deleted!"
}

Copyright © CleverMonitor, 2017