Skip to content

Customer

The Customers module lets you manage clients of the managed service provider (MSP). The MSP can maintain detailed records of all customers and their information, including associated solutions, advisory details, announcements, and more in the Customers module.

Attributes

id (long)
Denotes the ID of the customer.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

name (string)
Name of the Customer.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)
Description of the customer.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (string)
Domain of the Customer, which will be accessible by the Client Portal Users.

domain (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

default_site (string)
The site which was mentioned as a default Site.

default_site (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

{"default_site":{"name":"Customer 2's Default Site","id":"100000000000048561"}}

(long)
This logo will be displayed in the login page for the respective customer user. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input.

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

More Attributes Expand all

(long)

This logo will be displayed as the instance logo for the respective customer users. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input. 

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

support_email (string)

Email address to which customer-specific requests should be sent.

support_email (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

support_name (string)

The sender name to be mentioned in emails related to the customer.

support_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

door_no (string)

Door number of the Customer’s Address.

door_no (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

street (string)

Street of the Customer’s Address.

street (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

location (string)

Location of the customer.

location (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

landmark (string)

Landmark of the Customer’s Address.

landmark (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

city (string)

City of the Customer’s Address.

city (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

postal_code (string)

Postal Code of the Customer’s Address.

postal_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

state (string)

State of the Customer’s Address.

state (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

country (string)

Country of the Customer’s Address.

country (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

email_id (string)

Email address to which customer to be contacted.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

phone_number (string)

Phone Number to which customer to be contacted.

phone_number (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile to which customer to be contacted.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

fax (string)

Fax to which customer to be contacted.

fax (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

website (string)

Website of the Customer.

website (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

attachments (attachment)

Files that are attached to the request. The file should be added for the customer via “/customers/_uploads”. The file_id from the response should be added as the input.

attachments (attachment)

sites (site)

Lists the sites created under this customer.

sites (site)

Example 

{
  "sites": [
    {
      "deleted": false,
      "name": "Site 1",
      "description": "",
      "id": "100000000000052060",
      "is_default": false
    },
    {
      "deleted": false,
      "name": "Site 2",
      "description": "",
      "id": "100000000000052065",
      "is_default": false
    }
  ]
}

advisories (advisory)

Customer-specific information to share with users before logging in.

advisories (advisory)

Example 

{
  "advisories": [
    {
      "performed_by": {
        "email_id": "john.doe@abcmail.com",
        "site": {
          "deleted": false,
          "name": "Base Site",
          "id": "100000000000006824"
        },
        "name": "John Doe",
        "id": "100000000000040848"
      },
      "ispublic": true,
      "description": "Sample Advisory 1",
      "id": "100000000000052055",
      "performed_time": {
        "display_value": "Jan 17, 2025 03:36 PM",
        "value": "1737108380889"
      },
      "customer": {
        "id": "100000000000048556"
      }
    }
  ]
}

udf_fields (udf_fields)

Holds user defined fields’ values associated with the customer.

udf_fields (udf_fields)

template (customer_template)

Indicates the template which is used to create this customer.

template (customer_template)

Example 

{
  "template": {
    "inactive": false,
    "name": "General Customer Template",
    "id": "100000000000040055"
  }
}

created_time (datetime)read only

Indicates the time at which this customer is created.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

is_msp (boolean)read only

Boolean value indicating whether this customer is a MSP Customer.

is_msp (boolean)
Boolean value which can have two possible values. The values are true and false.

deleted_time (datetime)read only

Denotes the time at which the customer was deleted.

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

Add Customer

This operation allows the SDAdmin to create a new Customer.

Mandatory Fields :- name

Url

<service domain|custom domain>/app/<portal>/api/v3/customers

Attributes

id (long)
Denotes the ID of the customer.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

name (string)
Name of the Customer.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)
Description of the customer.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

default_site (string)
The site which was mentioned as a default Site.

default_site (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

{"default_site":{"name":"Customer 2's Default Site","id":"100000000000048561"}}

(long)
This logo will be displayed in the login page for the respective customer user. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input.

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

(long)
This logo will be displayed as the instance logo for the respective customer users. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input. 

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

More Attributes Expand all

support_email (string)

Email address to which customer-specific requests should be sent.

support_email (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

support_name (string)

The sender name to be mentioned in emails related to the customer.

support_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

door_no (string)

Door number of the Customer’s Address.

door_no (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

street (string)

Street of the Customer’s Address.

street (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

location (string)

Location of the customer.

location (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

landmark (string)

Landmark of the Customer’s Address.

landmark (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

city (string)

City of the Customer’s Address.

city (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

postal_code (string)

Postal Code of the Customer’s Address.

postal_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

state (string)

State of the Customer’s Address.

state (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

country (string)

Country of the Customer’s Address.

country (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

email_id (string)

Email address to which customer to be contacted.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

phone_number (string)

Phone Number to which customer to be contacted.

phone_number (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile to which customer to be contacted.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

fax (string)

Fax to which customer to be contacted.

fax (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

website (string)

Website of the Customer.

website (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

attachments (attachment)

Files that are attached to the request. The file should be added for the customer via “/customers/_uploads”. The file_id from the response should be added as the input.

attachments (attachment)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the customer.

udf_fields (udf_fields)

template (customer_template)

Indicates the template which is used to create this customer.

template (customer_template)

Example 

{
  "template": {
    "inactive": false,
    "name": "General Customer Template",
    "id": "100000000000040055"
  }
}

created_time (datetime)read only

Indicates the time at which this customer is created.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

is_msp (boolean)read only

Boolean value indicating whether this customer is a MSP Customer.

is_msp (boolean)
Boolean value which can have two possible values. The values are true and false.

deleted_time (datetime)read only

Denotes the time at which the customer was deleted.

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

$ curl <service domain|custom domain>/app/<portal>/api/v3/customers\
      -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='{
    "customer": {
        "name": "Customer A",
        "description": "Description of the Customer A",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Street",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   '

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
    "customer": {
        "name": "Customer A",
        "description": "Description of the Customer A",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Street",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   ;
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"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "customer": {
        "name": "Customer A",
        "description": "Description of the Customer A",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Street",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   
'@
$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"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "customer": {
        "name": "Customer A",
        "description": "Description of the Customer A",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Street",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   '''
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())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "customer": {
        "email_id": "aa@customerdomain.com",
        "template": {
            "inactive": false,
            "name": "General Customer Template",
            "id": "100000000000040055"
        },
        "country": "United States",
        "attachments": [],
        "city": "City YY",
        "description": "Description of the Customer A",
        "header_logo": null,
        "login_logo": null,
        "support_name": "Customer Support Name",
        "street": "Customer Streets",
        "door_no": "33",
        "id": "100000000000052115",
        "state": "State Bs",
        "is_msp": false,
        "landmark": "Near Landmark Xs",
        "fax": "+22 22222",
        "created_time": {
            "display_value": "Jan 17, 2025 04:24 PM",
            "value": "1737111264440"
        },
        "website": "https://www.customeraweb.com",
        "mobile": "11111111111",
        "support_email": "customeraa@customerdomain.com",
        "customer_group": [],
        "domain": "cust-100000000000052115.clients.sdpcloud.com",
        "name": "Customer A",
        "udf_fields": {
            "txt_single_line_field": null
        },
        "default_site": {
            "name": "Customer A Base Site",
            "id": "100000000000052120"
        },
        "location": "Location AAs",
        "phone_number": "222222222",
        "postal_code": "123454",
        "deleted_time": null
    }
}

Edit Customer

This operation allows the user to edit a specific customer.

Url

<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}

Attributes

id (long)
Denotes the ID of the customer.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

name (string)
Name of the Customer.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)
Description of the customer.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

default_site (string)
The site which was mentioned as a default Site.

default_site (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

{"default_site":{"name":"Customer 2's Default Site","id":"100000000000048561"}}

(long)
This logo will be displayed in the login page for the respective customer user. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input.

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

(long)
This logo will be displayed as the instance logo for the respective customer users. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input. 

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

More Attributes Expand all

support_email (string)

Email address to which customer-specific requests should be sent.

support_email (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

support_name (string)

The sender name to be mentioned in emails related to the customer.

support_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

door_no (string)

Door number of the Customer’s Address.

door_no (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

street (string)

Street of the Customer’s Address.

street (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

location (string)

Location of the customer.

location (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

landmark (string)

Landmark of the Customer’s Address.

landmark (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

city (string)

City of the Customer’s Address.

city (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

postal_code (string)

Postal Code of the Customer’s Address.

postal_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

state (string)

State of the Customer’s Address.

state (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

country (string)

Country of the Customer’s Address.

country (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

email_id (string)

Email address to which customer to be contacted.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

phone_number (string)

Phone Number to which customer to be contacted.

phone_number (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile to which customer to be contacted.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

fax (string)

Fax to which customer to be contacted.

fax (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

website (string)

Website of the Customer.

website (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

attachments (attachment)

Files that are attached to the request. The file should be added for the customer via “/customers/_uploads”. The file_id from the response should be added as the input.

attachments (attachment)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the customer.

udf_fields (udf_fields)

template (customer_template)

Indicates the template which is used to create this customer.

template (customer_template)

Example 

{
  "template": {
    "inactive": false,
    "name": "General Customer Template",
    "id": "100000000000040055"
  }
}

created_time (datetime)read only

Indicates the time at which this customer is created.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

is_msp (boolean)read only

Boolean value indicating whether this customer is a MSP Customer.

is_msp (boolean)
Boolean value which can have two possible values. The values are true and false.

deleted_time (datetime)read only

Denotes the time at which the customer was deleted.

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

$ curl <service domain|custom domain>/app/<portal>/api/v3/customers/{customer_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='{
    "customer": {
        "name": "Customer A edited",
        "description": "Description of the Customer A edited",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name edited",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Streets",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   '

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
    "customer": {
        "name": "Customer A edited",
        "description": "Description of the Customer A edited",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name edited",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Streets",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   ;
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}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
    "customer": {
        "name": "Customer A edited",
        "description": "Description of the Customer A edited",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name edited",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Streets",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   
'@
$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}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "customer": {
        "name": "Customer A edited",
        "description": "Description of the Customer A edited",
        "support_email": "customeraa@customerdomain.com",
        "support_name": "Customer Support Name edited",
        "state": "State Bs",
        "location": "Location AAs",
        "street": "Customer Streets",
        "landmark": "Near Landmark Xs",
        "postal_code": "123454"
    }
}   '''
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())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "customer": {
        "email_id": "aa@customerdomain.com",
        "template": {
            "inactive": false,
            "name": "General Customer Template",
            "id": "100000000000040055"
        },
        "country": "United States",
        "attachments": [],
        "city": "City YY",
        "description": "Description of the Customer A edited",
        "header_logo": null,
        "login_logo": null,
        "support_name": "Customer Support Name edited",
        "street": "Customer Streets",
        "door_no": "33",
        "id": "100000000000052115",
        "state": "State Bs",
        "is_msp": false,
        "landmark": "Near Landmark Xs",
        "fax": "+22 22222",
        "created_time": {
            "display_value": "Jan 17, 2025 04:24 PM",
            "value": "1737111264440"
        },
        "website": "https://www.customeraweb.com",
        "mobile": "11111111111",
        "support_email": "customeraa@customerdomain.com",
        "customer_group": [],
        "domain": "cust-100000000000052115.clients.sdpcloud.com",
        "name": "Customer A edited",
        "udf_fields": {
            "txt_single_line_field": null
        },
        "default_site": {
            "name": "Customer A Base Site",
            "id": "100000000000052120"
        },
        "location": "Location AAs",
        "phone_number": "222222222",
        "postal_code": "123454",
        "deleted_time": null
    }
}

Get Customer

This operation allows the user to get the information of a specific Customer.

Url

<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}

Attributes

id (long)
Denotes the ID of the customer.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

name (string)
Name of the Customer.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)
Description of the customer.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (string)
Domain of the Customer, which will be accessible by the Client Portal Users.

domain (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

default_site (string)
The site which was mentioned as a default Site.

default_site (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

{"default_site":{"name":"Customer 2's Default Site","id":"100000000000048561"}}

(long)
This logo will be displayed in the login page for the respective customer user. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input.

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

More Attributes Expand all

(long)

This logo will be displayed as the instance logo for the respective customer users. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input. 

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

support_email (string)

Email address to which customer-specific requests should be sent.

support_email (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

support_name (string)

The sender name to be mentioned in emails related to the customer.

support_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

door_no (string)

Door number of the Customer’s Address.

door_no (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

street (string)

Street of the Customer’s Address.

street (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

location (string)

Location of the customer.

location (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

landmark (string)

Landmark of the Customer’s Address.

landmark (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

city (string)

City of the Customer’s Address.

city (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

postal_code (string)

Postal Code of the Customer’s Address.

postal_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

state (string)

State of the Customer’s Address.

state (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

country (string)

Country of the Customer’s Address.

country (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

email_id (string)

Email address to which customer to be contacted.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

phone_number (string)

Phone Number to which customer to be contacted.

phone_number (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile to which customer to be contacted.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

fax (string)

Fax to which customer to be contacted.

fax (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

website (string)

Website of the Customer.

website (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

attachments (attachment)

Files that are attached to the request. The file should be added for the customer via “/customers/_uploads”. The file_id from the response should be added as the input.

attachments (attachment)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the customer.

udf_fields (udf_fields)

template (customer_template)

Indicates the template which is used to create this customer.

template (customer_template)

Example 

{
  "template": {
    "inactive": false,
    "name": "General Customer Template",
    "id": "100000000000040055"
  }
}

created_time (datetime)read only

Indicates the time at which this customer is created.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

is_msp (boolean)read only

Boolean value indicating whether this customer is a MSP Customer.

is_msp (boolean)
Boolean value which can have two possible values. The values are true and false.

deleted_time (datetime)read only

Denotes the time at which the customer was deleted.

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/customers/{customer_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}";
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}"
$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}"
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())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "customer": {
        "email_id": "aa@customerdomain.com",
        "template": {
            "inactive": false,
            "name": "General Customer Template",
            "id": "100000000000040055"
        },
        "country": "United States",
        "attachments": [],
        "city": "City YY",
        "description": "Description of the Customer A edited",
        "header_logo": null,
        "login_logo": null,
        "support_name": "Customer Support Name edited",
        "street": "Customer Streets",
        "door_no": "33",
        "id": "100000000000052115",
        "state": "State Bs",
        "is_msp": false,
        "landmark": "Near Landmark Xs",
        "fax": "+22 22222",
        "created_time": {
            "display_value": "Jan 17, 2025 04:24 PM",
            "value": "1737111264440"
        },
        "website": "https://www.customeraweb.com",
        "mobile": "11111111111",
        "support_email": "customeraa@customerdomain.com",
        "customer_group": [],
        "domain": "cust-100000000000052115.clients.sdpcloud.com",
        "name": "Customer A edited",
        "udf_fields": {
            "txt_single_line_field": null
        },
        "default_site": {
            "name": "Customer A Base Site",
            "id": "100000000000052120"
        },
        "location": "Location AAs",
        "phone_number": "222222222",
        "postal_code": "123454",
        "deleted_time": null
    }
}

Get List Customer

This operation allows the user to get the list of the customer information based on the criteria.

Url

<service domain|custom domain>/app/<portal>/api/v3/customers

Attributes

id (long)
Denotes the ID of the customer.

id (long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

name (string)
Name of the Customer.

name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

description (string)
Description of the customer.

description (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

domain (string)
Domain of the Customer, which will be accessible by the Client Portal Users.

domain (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

default_site (string)
The site which was mentioned as a default Site.

default_site (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

{"default_site":{"name":"Customer 2's Default Site","id":"100000000000048561"}}

(long)
This logo will be displayed in the login page for the respective customer user. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input.

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

More Attributes Expand all

(long)

This logo will be displayed as the instance logo for the respective customer users. The image should be added for the customer via “/customers/_images”. The file_id from the response should be added as the input. 

(long)
Numerical digits which are considered to have larger values.

Example 

234759602834500

support_email (string)

Email address to which customer-specific requests should be sent.

support_email (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

support_name (string)

The sender name to be mentioned in emails related to the customer.

support_name (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

door_no (string)

Door number of the Customer’s Address.

door_no (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

street (string)

Street of the Customer’s Address.

street (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

location (string)

Location of the customer.

location (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

landmark (string)

Landmark of the Customer’s Address.

landmark (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

city (string)

City of the Customer’s Address.

city (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

postal_code (string)

Postal Code of the Customer’s Address.

postal_code (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

state (string)

State of the Customer’s Address.

state (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

country (string)

Country of the Customer’s Address.

country (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

email_id (string)

Email address to which customer to be contacted.

email_id (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

abc.gmail.com

phone_number (string)

Phone Number to which customer to be contacted.

phone_number (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

mobile (string)

Mobile to which customer to be contacted.

mobile (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

fax (string)

Fax to which customer to be contacted.

fax (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

website (string)

Website of the Customer.

website (string)
A text in a plain format. No rich text or new line characters allowed.

Example 

Sample Content

attachments (attachment)

Files that are attached to the request. The file should be added for the customer via “/customers/_uploads”. The file_id from the response should be added as the input.

attachments (attachment)

udf_fields (udf_fields)

Holds user defined fields’ values associated with the customer.

udf_fields (udf_fields)

template (customer_template)

Indicates the template which is used to create this customer.

template (customer_template)

Example 

{
  "template": {
    "inactive": false,
    "name": "General Customer Template",
    "id": "100000000000040055"
  }
}

created_time (datetime)read only

Indicates the time at which this customer is created.

created_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

is_msp (boolean)read only

Boolean value indicating whether this customer is a MSP Customer.

is_msp (boolean)
Boolean value which can have two possible values. The values are true and false.

deleted_time (datetime)read only

Denotes the time at which the customer was deleted.

deleted_time (datetime)
Represents a date/time as a JSON Object. Would contain the value and the display_value attributes.

value : The time in long format (No. of milliseconds from Jan 1, 1970 ).

display_value : The time in a readable form in a format as personalized by the user. If not personalized, default format would be used.

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/customers\
      -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=''

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = ;
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"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @''@
$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"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''       
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())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "customer": [{
        "email_id": "aa@customerdomain.com",
        "template": {
            "inactive": false,
            "name": "General Customer Template",
            "id": "100000000000040055"
        },
        "country": "United States",
        "attachments": [],
        "city": "City YY",
        "description": "Description of the Customer A edited",
        "header_logo": null,
        "login_logo": null,
        "support_name": "Customer Support Name edited",
        "street": "Customer Streets",
        "door_no": "33",
        "id": "100000000000052115",
        "state": "State Bs",
        "is_msp": false,
        "landmark": "Near Landmark Xs",
        "fax": "+22 22222",
        "created_time": {
            "display_value": "Jan 17, 2025 04:24 PM",
            "value": "1737111264440"
        },
        "website": "https://www.customeraweb.com",
        "mobile": "11111111111",
        "support_email": "customeraa@customerdomain.com",
        "customer_group": [],
        "domain": "cust-100000000000052115.clients.sdpcloud.com",
        "name": "Customer A edited",
        "udf_fields": {
            "txt_single_line_field": null
        },
        "default_site": {
            "name": "Customer A Base Site",
            "id": "100000000000052120"
        },
        "location": "Location AAs",
        "phone_number": "222222222",
        "postal_code": "123454",
        "deleted_time": null
    }]
}

Add Service Url

This operation allows the user to configure a domain for the customer.

Url

<service domain|custom domain>/app/<portal>/app/itdesk/api/v3/customers/{customer_id}/client_portal_directory/_add_service_url


$ curl <service domain|custom domain>/app/<portal>/app/itdesk/api/v3/customers/{customer_id}/client_portal_directory/_add_service_url\
      -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='{
    "service_url": "sssssss.clients.sdpcloud.com"
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/app/itdesk/api/v3/customers/{customer_id}/client_portal_directory/_add_service_url";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
    "service_url": "sssssss.clients.sdpcloud.com"
};
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>/app/itdesk/api/v3/customers/{customer_id}/client_portal_directory/_add_service_url"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
    "service_url": "sssssss.clients.sdpcloud.com"
}
'@
$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>/app/itdesk/api/v3/customers/{customer_id}/client_portal_directory/_add_service_url"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
    "service_url": "sssssss.clients.sdpcloud.com"
}'''
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())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    }
}

View more

Delete Service Url

This operation allows the user to delete the configured domain for the customer.

Url

<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/client_portal_directory/_delete_service_url


$ curl <service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/client_portal_directory/_delete_service_url\
      -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}/client_portal_directory/_delete_service_url";
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}/client_portal_directory/_delete_service_url"
$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}/client_portal_directory/_delete_service_url"
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"
  }
}

View more

Inactive The Customer

This operation allows the user to mark a customer as inactive.

Url

<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/_move_to_trash


$ curl <service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/_move_to_trash\
      -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=''

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/_move_to_trash";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = ;
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}/_move_to_trash"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'

'@
$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}/_move_to_trash"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "customer": {
        "email_id": null,
        "template": {
            "inactive": false,
            "name": "General Customer Template",
            "id": "100000000000040055"
        },
        "country": null,
        "attachments": [],
        "city": null,
        "description": null,
        "header_logo": null,
        "login_logo": null,
        "client_portal": "1031147813",
        "support_name": null,
        "street": null,
        "door_no": null,
        "id": "100000000000044788",
        "state": null,
        "is_msp": false,
        "landmark": null,
        "fax": null,
        "created_time": {
            "display_value": "Jan 13, 2025 12:45 PM",
            "value": "1736752513016"
        },
        "website": null,
        "mobile": null,
        "support_email": null,
        "customer_group": [],
        "domain": "cust-100000000000044788.clients.sdpcloud.com",
        "name": "Customer A",
        "udf_fields": {
            "txt_single_line_field": null
        },
        "default_site": {
            "name": "Base Site",
            "id": "100000000000044793"
        },
        "location": null,
        "phone_number": null,
        "postal_code": null,
        "deleted_time": {
            "display_value": "Jan 20, 2025 02:28 PM",
            "value": "1737363501395"
        }
    }
}

View more

Restore The Inactive Customer

This operation allows the user to restore the customer/ reactive the inactive customer.

Url

<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/_restore_from_trash


$ curl <service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/_restore_from_trash\
      -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=''

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/customers/{customer_id}/_restore_from_trash";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = ;
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}/_restore_from_trash"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'

'@
$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}/_restore_from_trash"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
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())

{
    "response_status": {
        "status_code": 2000,
        "status": "success"
    },
    "customer": {
        "email_id": null,
        "template": {
            "inactive": false,
            "name": "General Customer Template",
            "id": "100000000000040055"
        },
        "country": null,
        "attachments": [],
        "city": null,
        "description": null,
        "header_logo": null,
        "login_logo": null,
        "client_portal": "1031147809",
        "support_name": null,
        "street": null,
        "door_no": null,
        "id": "100000000000042918",
        "state": null,
        "is_msp": false,
        "landmark": null,
        "fax": null,
        "created_time": {
            "display_value": "Jan 13, 2025 12:45 PM",
            "value": "1736752509411"
        },
        "website": null,
        "mobile": null,
        "support_email": null,
        "customer_group": [],
        "domain": "cust-100000000000042918.clients.sdpcloud.com",
        "name": "Customer A",
        "udf_fields": {
            "txt_single_line_field": null
        },
        "default_site": {
            "name": "Base Site",
            "id": "100000000000042923"
        },
        "location": null,
        "phone_number": null,
        "postal_code": null,
        "deleted_time": null
    }
}

View more