Version 1.2



References overview


Example Request URL:
https://api.clevermonitor.com/v1.2/references
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references'
Output Parameters:
Name Data Type Description
key string(50) Reference uri
name string(50) Reference name
description string(150) Reference description
values: code integer Value code
values: description string Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "priority": {
        "name": "priority",
        "description": "Email priority",
        "values": {
            "1": {
                "code": 1,
                "description": "Low",
                "enable": true
            },
            "2": {
                "code": 2,
                "description": "Normal",
                "enable": true
            },
            "3": {
                "code": 3,
                "description": "High",
                "enable": true
            }
        }
    },
    "contact_source": {
        "name": "contact_source",
        "description": "Contact source",
        "values": {
            "1": {
                "code": 1,
                "description": "WS - e-mail",
                "enable": true
            },
            "2": {
                "code": 2,
                "description": "WS - full contact",
                "enable": true
            },
            "11": {
                "code": 11,
                "description": "Web - manual insertion",
                "enable": true
            },
            "12": {
                "code": 12,
                "description": "Web - bulk import",
                "enable": true
            }
        }
    }
}

Account type


Example Request URL:
https://api.clevermonitor.com/v1.2/references/account_type
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/account_type'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Batch processing status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/batch_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/batch_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(1) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Campaign status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/campaign_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/campaign_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Campaign source


Example Request URL:
https://api.clevermonitor.com/v1.2/references/campaign_source
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/campaign_source'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Campaign type


Example Request URL:
https://api.clevermonitor.com/v1.2/references/campaign_type
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/campaign_type'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(1) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Contact source


Example Request URL:
https://api.clevermonitor.com/v1.2/references/contact_source
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/contact_source'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Contact status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/contact_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/contact_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Contact type


Example Request URL:
https://api.clevermonitor.com/v1.2/references/contact_type
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/contact_type'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Countries


Example Request URL:
https://api.clevermonitor.com/v1.2/references/country
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/country'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: code2 string(2) Two-letter country code defined in ISO 3166-1
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "country",
    "description": "Countries",
    "values": {
        "203": {
            "code": 203,
            "code2": "CZ",
            "description": "Czech Republic",
            "enable": true
        }
    }
}

Custom field data type


Example Request URL:
https://api.clevermonitor.com/v1.2/references/field_type
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/field_type'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(2) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Custom field data source


Example Request URL:
https://api.clevermonitor.com/v1.2/references/field_source
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/field_source'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(1) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Message status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/message_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/message_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Preferred communication


Example Request URL:
https://api.clevermonitor.com/v1.2/references/preferred_com
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/preferred_com'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(1) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Email priority


Example Request URL:
https://api.clevermonitor.com/v1.2/references/priority
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/priority'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(1) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Record status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/record_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/record_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Transactional message status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/transaction_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/transaction_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code string(20) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

User status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/user_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/user_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(1) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Email validation status


Example Request URL:
https://api.clevermonitor.com/v1.2/references/validation_status
Example cURL:
curl -X GET --header 'Accept: application/json' 'https://api.clevermonitor.com/v1.2/references/validation_status'
Output Parameters:
Name Data Type Description
name string(50) Reference name
description string(150) Reference description
values: code integer(3) Value code
values: description string(150) Value name
values: enable boolean Value is enabled or disabled
Example Response:
{
    "name": "reference",
    "description": "Reference description",
    "values": [
        {
            "code": 0,
            "description": "Item description",
            "enable": true
        }
    ]
}

Copyright © CleverMonitor, 2017