<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories
Advisory
Advisories provide recommendations or advices to technicians and these advisories are shown in the Request Details page when enabled, corresponding to each of the customer.
Attributes
Add Advisory
Add a advisory under the respective customer
Mandatory Fields :- description
Url
Attributes
id (long)
Unique identifier to identify the advisory.
description (html)
Contains the description of the advisory.
performed_by (user)read only
Indicates the user who created the advisory.
performed_time (datetime)read only
Indicates the created time of the advisory.
$ curl <service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories\
-X POST\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"advisory": {
"ispublic": true,
"description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Advisory content f<br></div></div>"
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"advisory": {
"ispublic": true,
"description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Advisory content f<br></div></div>"
}
};
params = {"input_data": input_data};
response = invokeurl
[
url: url
type: POST
parameters: params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"advisory": {
"ispublic": true,
"description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Advisory content f<br></div></div>"
}
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"advisory": {
"ispublic": true,
"description": "<div class=\"personalize-wrapper\" style=\"font-family: 'PT Sans',Arial,Helvetica,sans-serif, sans-serif;font-size: 13px;\"><div>Advisory content f<br></div></div>"
}
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"advisory": {
"updated_time": null,
"attachments": [],
"performed_by": {
"email_id": "james.white@zohotest.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": null,
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "11346000000210001",
"is_default": true,
"customer": {
"id": "11346000000274812"
}
},
"phone": null,
"employee_id": null,
"name": "James",
"id": "11346000000275451",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=1234567&t=user&height=60&width=60",
"is_vip_user": false,
"department": null,
"first_name": "James",
"job_title": null,
"customer": {
"name": "Customer A",
"id": "11346000000274812",
"is_msp": true,
"deleted_time": null
}
},
"ispublic": true,
"description": "<div class=\"personalize-wrapper\" style=\"font-family:"PT Sans", Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Advisory content for customer<br><\/div><\/div>",
"id": "11346000000656001",
"performed_time": {
"display_value": "Jan 29, 2025 03:02 PM",
"value": "1738143162734"
},
"customer": {
"name": "Kong",
"id": "11346000000618007",
"is_msp": false,
"deleted_time": null
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Edit Advisory
Edit the existing advisories.
Url
<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}
Attributes
id (long)
Unique identifier to identify the advisory.
description (html)
Contains the description of the advisory.
performed_by (user)read only
Indicates the user who created the advisory.
performed_time (datetime)read only
Indicates the created time of the advisory.
$ curl <service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"advisory": {
"description": "<div class=\"personalize-wrapper\" style=\"font-family:"PT Sans", Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Advisory content for customer is edited<br></div></div>",
"ispublic": false
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"advisory": {
"description": "<div class=\"personalize-wrapper\" style=\"font-family:"PT Sans", Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Advisory content for customer is edited<br></div></div>",
"ispublic": false
}
};
params = {"input_data": input_data};
response = invokeurl
[
url: url
type: PUT
parameters: params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"advisory": {
"description": "<div class=\"personalize-wrapper\" style=\"font-family:"PT Sans", Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Advisory content for customer is edited<br></div></div>",
"ispublic": false
}
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"advisory": {
"description": "<div class=\"personalize-wrapper\" style=\"font-family:"PT Sans", Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Advisory content for customer is edited<br></div></div>",
"ispublic": false
}
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"advisory": {
"updated_time": {
"display_value": "Jan 29, 2025 03:08 PM",
"value": "1738143520375"
},
"attachments": [],
"performed_by": {
"email_id": "james.white@zohotest.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": null,
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "11346000000210001",
"is_default": true,
"customer": {
"id": "11346000000274812"
}
},
"phone": null,
"employee_id": null,
"name": "James",
"id": "11346000000275451",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123456789&t=user&height=60&width=60",
"is_vip_user": false,
"department": null,
"first_name": "James",
"job_title": null,
"customer": {
"name": "Customer A",
"id": "11346000000274812",
"is_msp": true,
"deleted_time": null
}
},
"ispublic": false,
"description": "<div class=\"personalize-wrapper\" style=\"font-family:"PT Sans", Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Advisory content for customer is edited<br><\/div><\/div>",
"id": "11346000000656001",
"performed_time": {
"display_value": "Jan 29, 2025 03:02 PM",
"value": "1738143162734"
},
"customer": {
"name": "Kong",
"id": "11346000000618007",
"is_msp": false,
"deleted_time": null
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get Advisory
Get the details of an advisory.
Url
<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}
Attributes
id (long)
Unique identifier to identify the advisory.
description (html)
Contains the description of the advisory.
performed_by (user)read only
Indicates the user who created the advisory.
performed_time (datetime)read only
Indicates the created time of the advisory.
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}\
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
url: url
type: GET
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"advisory": {
"updated_time": {
"display_value": "Jan 29, 2025 03:08 PM",
"value": "1738143520375"
},
"attachments": [],
"performed_by": {
"email_id": "james.white@zohotest.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": null,
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "11346000000210001",
"is_default": true,
"customer": {
"id": "11346000000274812"
}
},
"phone": null,
"employee_id": null,
"name": "James",
"id": "11346000000275451",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=123456789&t=user&height=60&width=60",
"is_vip_user": false,
"department": null,
"first_name": "James",
"job_title": null,
"customer": {
"name": "Customer A",
"id": "11346000000274812",
"is_msp": true,
"deleted_time": null
}
},
"ispublic": false,
"description": "<div class=\"personalize-wrapper\" style=\"font-family:"PT Sans", Arial, Helvetica, sans-serif, sans-serif; font-size:13px\"><div>Advisory content for customer is edited<br><\/div><\/div>",
"id": "11346000000656001",
"performed_time": {
"display_value": "Jan 29, 2025 03:02 PM",
"value": "1738143162734"
},
"customer": {
"name": "Kong",
"id": "11346000000618007",
"is_msp": false,
"deleted_time": null
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get List Advisory
Get the list of the advisories under a customer
Url
<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories
Attributes
id (long)
Unique identifier to identify the advisory.
description (html)
Contains the description of the advisory.
performed_by (user)read only
Indicates the user who created the advisory.
performed_time (datetime)read only
Indicates the created time of the advisory.
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories\
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
--data-urlencode input_data='{
"list_info": {
"row_count": 10,
"start_index": 1,
"fields_required": [
"description",
"performed_by",
"performed_time",
"updated_time",
"ispublic"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
]
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"list_info": {
"row_count": 10,
"start_index": 1,
"fields_required": [
"description",
"performed_by",
"performed_time",
"updated_time",
"ispublic"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
]
}
};
params = {"input_data":input_data};
response = invokeurl
[
url: url
type: GET
parameters:params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{
"list_info": {
"row_count": 10,
"start_index": 1,
"fields_required": [
"description",
"performed_by",
"performed_time",
"updated_time",
"ispublic"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
]
}
}'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"list_info": {
"row_count": 10,
"start_index": 1,
"fields_required": [
"description",
"performed_by",
"performed_time",
"updated_time",
"ispublic"
],
"get_total_count": true,
"sort_fields": [
{
"field": "id",
"order": "desc"
}
]
}
}'''
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"advisories": [
{
"updated_time": {
"display_value": "Jan 29, 2025 03:08 PM",
"value": "1738143520375"
},
"performed_by": {
"email_id": "james.white@zohotest.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": null,
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "11346000000210001",
"is_default": true,
"customer": {
"id": "11346000000274812"
}
},
"phone": null,
"employee_id": null,
"name": "James",
"id": "11346000000275451",
"photo_url": "https://contacts.zoho.com/file?exp=10&ID=12345678&t=user&height=60&width=60",
"is_vip_user": false,
"department": null,
"first_name": "James",
"job_title": null,
"customer": {
"name": "Customer A",
"id": "11346000000274812",
"is_msp": true,
"deleted_time": null
}
},
"ispublic": false,
"description": "Advisory content for customer is edited",
"id": "11346000000656001",
"performed_time": {
"display_value": "Jan 29, 2025 03:02 PM",
"value": "1738143162734"
}
}
],
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"sort_fields": [
{
"field": "id",
"order": "desc"
}
],
"has_more_rows": false,
"start_index": 1,
"fields_required": [
"description",
"performed_by",
"performed_time",
"updated_time",
"ispublic"
],
"total_count": 1,
"page": 1,
"get_total_count": "true",
"row_count": 1
}
}
Delete Advisory
Deletes the specific Advisory
Url
<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}
$ curl <service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}\
-X DELETE\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
url: url
type: DELETE
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{CUSTOMER_ID}/advisories/{ADVISORY_ID}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"response_status": {
"status_code": 2000,
"status": "success"
}
}