Skip to content

Checklist Template

Checklist is a list of reminders or to-do things for technicians to follow

Attributes

id (long)
Unique identifier to identify the checklist template

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

Example 

234759602834500

name (string)
Unique name to identify the checklist template

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

Example 

Sample Content

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template. A maximum of 25 items can be added

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template.

Example 

{
  "checklistitems": [
    {
      "item": {
        "name": "Test network connectivity",
        "id": "3000000076139",
        "field_type": "Decision Box"
      },
      "id": "3000000076143",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Update system software",
        "id": "3000000076145",
        "field_type": "Single Line"
      },
      "id": "3000000076157",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "2"
    },
    {
      "item": {
        "name": "Check disk space usage",
        "id": "3000000076159",
        "field_type": "Numeric Field"
      },
      "id": "3000000076169",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "3"
    },
    {
      "item": {
        "name": "Monitor CPU and memory usage",
        "id": "3000000076171",
        "field_type": "Radio Button"
      },
      "id": "3000000076183",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "4"
    }
  ]
}

description (string)
Description of the checklist template

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

Example 

Sample Content

created_by (user)read only
Indicates the user who created the checklist template

created_by (user)
Indicates the user who created the checklist template

Example 

{
  "created_by": {
    "email_id": "test@zmail.com",
    "is_technician": true,
    "sms_mail": "",
    "mobile": "",
    "last_name": "",
    "user_scope": "internal_user",
    "sms_mail_id": "",
    "phone": "",
    "name": "tech1",
    "id": "100000000000034309",
    "photo_url": "test-photo_url",
    "is_vip_user": false,
    "first_name": "tech1",
    "job_title": ""
  }
}

created_time (datetime)read only
Indicates the time at which the checklist template was 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.

More Attributes Expand all

is_action_template (boolean)read only

indicates whether the checklist template is a custom action checklist or normal checklist template 

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

Add Checklist Template

This operation helps to add a new checklist template

Mandatory Fields :- name, checklistitems

Url

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

Attributes

id (long)
Unique identifier to identify the checklist template

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

Example 

234759602834500

name (string)
Unique name to identify the checklist template

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

Example 

Sample Content

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template. A maximum of 25 items can be added

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template.

Example 

{
  "checklistitems": [
    {
      "item": {
        "name": "Test network connectivity",
        "id": "3000000076139",
        "field_type": "Decision Box"
      },
      "id": "3000000076143",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Update system software",
        "id": "3000000076145",
        "field_type": "Single Line"
      },
      "id": "3000000076157",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "2"
    },
    {
      "item": {
        "name": "Check disk space usage",
        "id": "3000000076159",
        "field_type": "Numeric Field"
      },
      "id": "3000000076169",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "3"
    },
    {
      "item": {
        "name": "Monitor CPU and memory usage",
        "id": "3000000076171",
        "field_type": "Radio Button"
      },
      "id": "3000000076183",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "4"
    }
  ]
}

description (string)
Description of the checklist template

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

Example 

Sample Content


$ curl <service domain|custom domain>/app/<portal>/api/v3/checklist_templates\
      -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='{
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "description": "Checklist for routine server maintenance tasks",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check disk space usage",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "order": 1
            },
            {
              "name": "Medium",
              "order": 2
            },
            {
              "name": "Low",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/checklist_templates";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "description": "Checklist for routine server maintenance tasks",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check disk space usage",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "order": 1
            },
            {
              "name": "Medium",
              "order": 2
            },
            {
              "name": "Low",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
};
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/checklist_templates"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "description": "Checklist for routine server maintenance tasks",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check disk space usage",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "order": 1
            },
            {
              "name": "Medium",
              "order": 2
            },
            {
              "name": "Low",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
}
'@
$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/checklist_templates"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "description": "Checklist for routine server maintenance tasks",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0"
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250"
            }
          ]
        },
        "order": 2
      },
      {
        "item": {
          "name": "Check disk space usage",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":"
            }
          ]
        },
        "order": 3
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "order": 1
            },
            {
              "name": "Medium",
              "order": 2
            },
            {
              "name": "Low",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
}'''
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"
    },
    "checklist_template": {
        "created_time": {
            "display_value": "Feb 25, 2026 11:57 AM",
            "value": "1772000860833"
        },
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "checklistitems": [
            {
                "item": {
                    "name": "Test network connectivity",
                    "id": "3000000076139",
                    "field_type": "Decision Box"
                },
                "id": "3000000076143",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "1"
            },
            {
                "item": {
                    "name": "Update system software",
                    "id": "3000000076145",
                    "field_type": "Single Line"
                },
                "id": "3000000076157",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "2"
            },
            {
                "item": {
                    "name": "Check disk space usage",
                    "id": "3000000076159",
                    "field_type": "Numeric Field"
                },
                "id": "3000000076169",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "3"
            },
            {
                "item": {
                    "name": "Monitor CPU and memory usage",
                    "id": "3000000076171",
                    "field_type": "Radio Button"
                },
                "id": "3000000076183",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "4"
            }
        ],
        "id": "3000000076137",
        "created_by": {
            "email_id": "caffrey@zmail.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "3000000007884",
                "is_default": true
            },
            "phone": "",
            "employee_id": null,
            "name": "Tech 0",
            "id": "3000000065477",
            "is_vip_user": false,
            "department": null,
            "first_name": "Tech 0",
            "job_title": null
        },
        "is_action_template": false
    }
}

Edit Checklist Template

This operation helps to update an existing checklist template

Url

<service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_id}

Attributes

id (long)
Unique identifier to identify the checklist template

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

Example 

234759602834500

name (string)
Unique name to identify the checklist template

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

Example 

Sample Content

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template. A maximum of 25 items can be added

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template.

Example 

{
  "checklistitems": [
    {
      "item": {
        "name": "Test network connectivity",
        "id": "3000000076139",
        "field_type": "Decision Box"
      },
      "id": "3000000076143",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Update system software",
        "id": "3000000076145",
        "field_type": "Single Line"
      },
      "id": "3000000076157",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "2"
    },
    {
      "item": {
        "name": "Check disk space usage",
        "id": "3000000076159",
        "field_type": "Numeric Field"
      },
      "id": "3000000076169",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "3"
    },
    {
      "item": {
        "name": "Monitor CPU and memory usage",
        "id": "3000000076171",
        "field_type": "Radio Button"
      },
      "id": "3000000076183",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "4"
    }
  ]
}

description (string)
Description of the checklist template

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

Example 

Sample Content

is_action_template (boolean)read only
indicates whether the checklist template is a custom action checklist or normal checklist template 

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

$ curl <service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_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='{
  "checklist_template": {
    "name": "Server Maintenance Checklists",
    "description": "Checklist for routine server maintenance",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076139
        },
        "order": 1,
        "id": 3000000076143
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076147"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076149"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076151
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076153
            }
          ],
          "id": 3000000076145
        },
        "order": 2,
        "id": 3000000076157
      },
      {
        "item": {
          "name": "Disk space usage %",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076161"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076163"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076165
            }
          ],
          "id": 3000000076159
        },
        "order": 3,
        "id": 3000000076169
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "id": 3000000076173,
              "order": 1
            },
            {
              "name": "Medium",
              "id": 3000000076175,
              "order": 2
            },
            {
              "name": "Low",
              "id": 3000000076177,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076179"
            }
          ],
          "id": 3000000076171
        },
        "order": 4,
        "id": 3000000076183
      }
    ]
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "checklist_template": {
    "name": "Server Maintenance Checklists",
    "description": "Checklist for routine server maintenance",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076139
        },
        "order": 1,
        "id": 3000000076143
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076147"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076149"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076151
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076153
            }
          ],
          "id": 3000000076145
        },
        "order": 2,
        "id": 3000000076157
      },
      {
        "item": {
          "name": "Disk space usage %",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076161"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076163"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076165
            }
          ],
          "id": 3000000076159
        },
        "order": 3,
        "id": 3000000076169
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "id": 3000000076173,
              "order": 1
            },
            {
              "name": "Medium",
              "id": 3000000076175,
              "order": 2
            },
            {
              "name": "Low",
              "id": 3000000076177,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076179"
            }
          ],
          "id": 3000000076171
        },
        "order": 4,
        "id": 3000000076183
      }
    ]
  }
};
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/checklist_templates/{checklist_template_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "checklist_template": {
    "name": "Server Maintenance Checklists",
    "description": "Checklist for routine server maintenance",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076139
        },
        "order": 1,
        "id": 3000000076143
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076147"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076149"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076151
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076153
            }
          ],
          "id": 3000000076145
        },
        "order": 2,
        "id": 3000000076157
      },
      {
        "item": {
          "name": "Disk space usage %",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076161"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076163"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076165
            }
          ],
          "id": 3000000076159
        },
        "order": 3,
        "id": 3000000076169
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "id": 3000000076173,
              "order": 1
            },
            {
              "name": "Medium",
              "id": 3000000076175,
              "order": 2
            },
            {
              "name": "Low",
              "id": 3000000076177,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076179"
            }
          ],
          "id": 3000000076171
        },
        "order": 4,
        "id": 3000000076183
      }
    ]
  }
}
'@
$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/checklist_templates/{checklist_template_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "checklist_template": {
    "name": "Server Maintenance Checklists",
    "description": "Checklist for routine server maintenance",
    "checklistitems": [
      {
        "item": {
          "name": "Test network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076139
        },
        "order": 1,
        "id": 3000000076143
      },
      {
        "item": {
          "name": "Update system software",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076147"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076149"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076151
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076153
            }
          ],
          "id": 3000000076145
        },
        "order": 2,
        "id": 3000000076157
      },
      {
        "item": {
          "name": "Disk space usage %",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076161"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076163"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076165
            }
          ],
          "id": 3000000076159
        },
        "order": 3,
        "id": 3000000076169
      },
      {
        "item": {
          "name": "Monitor CPU and memory usage",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "HIgh",
              "id": 3000000076173,
              "order": 1
            },
            {
              "name": "Medium",
              "id": 3000000076175,
              "order": 2
            },
            {
              "name": "Low",
              "id": 3000000076177,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076179"
            }
          ],
          "id": 3000000076171
        },
        "order": 4,
        "id": 3000000076183
      }
    ]
  }
}'''
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"
    },
    "checklist_template": {
        "created_time": {
            "display_value": "Feb 25, 2026 11:57 AM",
            "value": "1772000860833"
        },
        "name": "Server Maintenance Checklists",
        "description": "Checklist for routine server maintenance",
        "checklistitems": [
            {
                "item": {
                    "name": "Test network connectivity",
                    "id": "3000000076139",
                    "field_type": "Decision Box"
                },
                "id": "3000000076143",
                "checklist_template": {
                    "name": "Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076137"
                },
                "order": "1"
            },
            {
                "item": {
                    "name": "Update system software",
                    "id": "3000000076145",
                    "field_type": "Single Line"
                },
                "id": "3000000076157",
                "checklist_template": {
                    "name": "Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076137"
                },
                "order": "2"
            },
            {
                "item": {
                    "name": "Disk space usage %",
                    "id": "3000000076159",
                    "field_type": "Numeric Field"
                },
                "id": "3000000076169",
                "checklist_template": {
                    "name": "Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076137"
                },
                "order": "3"
            },
            {
                "item": {
                    "name": "Monitor CPU and memory usage",
                    "id": "3000000076171",
                    "field_type": "Radio Button"
                },
                "id": "3000000076183",
                "checklist_template": {
                    "name": "Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076137"
                },
                "order": "4"
            }
        ],
        "id": "3000000076137",
        "created_by": {
            "email_id": "caffrey@zmail.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "3000000007884",
                "is_default": true
            },
            "phone": "",
            "employee_id": null,
            "name": "Tech 0",
            "id": "3000000065477",
            "is_vip_user": false,
            "department": null,
            "first_name": "Tech 0",
            "job_title": null
        },
        "is_action_template": false
    }
}

Get Checklist Template

This operation helps to get a single checklist template

Url

<service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_id}

Attributes

id (long)
Unique identifier to identify the checklist template

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

Example 

234759602834500

name (string)
Unique name to identify the checklist template

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

Example 

Sample Content

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template. A maximum of 25 items can be added

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template.

Example 

{
  "checklistitems": [
    {
      "item": {
        "name": "Test network connectivity",
        "id": "3000000076139",
        "field_type": "Decision Box"
      },
      "id": "3000000076143",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Update system software",
        "id": "3000000076145",
        "field_type": "Single Line"
      },
      "id": "3000000076157",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "2"
    },
    {
      "item": {
        "name": "Check disk space usage",
        "id": "3000000076159",
        "field_type": "Numeric Field"
      },
      "id": "3000000076169",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "3"
    },
    {
      "item": {
        "name": "Monitor CPU and memory usage",
        "id": "3000000076171",
        "field_type": "Radio Button"
      },
      "id": "3000000076183",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "4"
    }
  ]
}

description (string)
Description of the checklist template

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

Example 

Sample Content

created_by (user)read only
Indicates the user who created the checklist template

created_by (user)
Indicates the user who created the checklist template

Example 

{
  "created_by": {
    "email_id": "test@zmail.com",
    "is_technician": true,
    "sms_mail": "",
    "mobile": "",
    "last_name": "",
    "user_scope": "internal_user",
    "sms_mail_id": "",
    "phone": "",
    "name": "tech1",
    "id": "100000000000034309",
    "photo_url": "test-photo_url",
    "is_vip_user": false,
    "first_name": "tech1",
    "job_title": ""
  }
}

created_time (datetime)read only
Indicates the time at which the checklist template was 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.

More Attributes Expand all

is_action_template (boolean)read only

indicates whether the checklist template is a custom action checklist or normal checklist template 

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

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_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/checklist_templates/{checklist_template_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/checklist_templates/{checklist_template_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/checklist_templates/{checklist_template_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"
    },
    "checklist_template": {
        "created_time": {
            "display_value": "Feb 25, 2026 11:57 AM",
            "value": "1772000860833"
        },
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "checklistitems": [
            {
                "item": {
                    "name": "Test network connectivity",
                    "id": "3000000076139",
                    "field_type": "Decision Box"
                },
                "id": "3000000076143",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "1"
            },
            {
                "item": {
                    "name": "Update system software",
                    "id": "3000000076145",
                    "field_type": "Single Line"
                },
                "id": "3000000076157",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "2"
            },
            {
                "item": {
                    "name": "Check disk space usage",
                    "id": "3000000076159",
                    "field_type": "Numeric Field"
                },
                "id": "3000000076169",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "3"
            },
            {
                "item": {
                    "name": "Monitor CPU and memory usage",
                    "id": "3000000076171",
                    "field_type": "Radio Button"
                },
                "id": "3000000076183",
                "checklist_template": {
                    "name": "Server Maintenance Checklist",
                    "description": "Checklist for routine server maintenance tasks",
                    "id": "3000000076137"
                },
                "order": "4"
            }
        ],
        "id": "3000000076137",
        "created_by": {
            "email_id": "caffrey@zmail.com",
            "is_technician": true,
            "sms_mail": null,
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "3000000007884",
                "is_default": true
            },
            "phone": "",
            "employee_id": null,
            "name": "Tech 0",
            "id": "3000000065477",
            "is_vip_user": false,
            "department": null,
            "first_name": "Tech 0",
            "job_title": null
        },
        "is_action_template": false
    }
}

Get List Checklist Template

This operation helps to get the list of all checklist templates

Url

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

Attributes

id (long)
Unique identifier to identify the checklist template

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

Example 

234759602834500

name (string)
Unique name to identify the checklist template

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

Example 

Sample Content

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template. A maximum of 25 items can be added

checklistitems (checklistitem_template)
List of checklist item templates associated with the checklist template.

Example 

{
  "checklistitems": [
    {
      "item": {
        "name": "Test network connectivity",
        "id": "3000000076139",
        "field_type": "Decision Box"
      },
      "id": "3000000076143",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "1"
    },
    {
      "item": {
        "name": "Update system software",
        "id": "3000000076145",
        "field_type": "Single Line"
      },
      "id": "3000000076157",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "2"
    },
    {
      "item": {
        "name": "Check disk space usage",
        "id": "3000000076159",
        "field_type": "Numeric Field"
      },
      "id": "3000000076169",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "3"
    },
    {
      "item": {
        "name": "Monitor CPU and memory usage",
        "id": "3000000076171",
        "field_type": "Radio Button"
      },
      "id": "3000000076183",
      "checklist_template": {
        "name": "Server Maintenance Checklist",
        "description": "Checklist for routine server maintenance tasks",
        "id": "3000000076137"
      },
      "order": "4"
    }
  ]
}

description (string)
Description of the checklist template

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

Example 

Sample Content

created_by (user)read only
Indicates the user who created the checklist template

created_by (user)
Indicates the user who created the checklist template

Example 

{
  "created_by": {
    "email_id": "test@zmail.com",
    "is_technician": true,
    "sms_mail": "",
    "mobile": "",
    "last_name": "",
    "user_scope": "internal_user",
    "sms_mail_id": "",
    "phone": "",
    "name": "tech1",
    "id": "100000000000034309",
    "photo_url": "test-photo_url",
    "is_vip_user": false,
    "first_name": "tech1",
    "job_title": ""
  }
}

created_time (datetime)read only
Indicates the time at which the checklist template was 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.

More Attributes Expand all

is_action_template (boolean)read only

indicates whether the checklist template is a custom action checklist or normal checklist template 

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

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/checklist_templates\
      -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/checklist_templates";
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/checklist_templates"
$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/checklist_templates"
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"
        }
    ],
    "checklist_templates": [
        {
            "name": "copy_Server Maintenance Checklists",
            "description": "Checklist for routine server maintenance",
            "id": "3000000076201",
            "created_by": {
                "email_id": "caffrey@zmail.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": "",
                "last_name": "",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "deleted": false,
                    "name": "Base Site",
                    "id": "3000000007884",
                    "is_default": true
                },
                "phone": "",
                "employee_id": null,
                "name": "Tech 0",
                "id": "3000000065477",

                "is_vip_user": false,
                "department": null,
                "first_name": "Tech 0",
                "job_title": null
            }
        },
        {
            "name": "Server Maintenance Checklists",
            "description": "Checklist for routine server maintenance",
            "id": "3000000076137",
            "created_by": {
                "email_id": "caffrey@zmail.com",
                "is_technician": true,
                "sms_mail": null,
                "mobile": "",
                "last_name": "",
                "user_scope": "internal_user",
                "sms_mail_id": null,
                "cost_per_hour": "0",
                "site": {
                    "deleted": false,
                    "name": "Base Site",
                    "id": "3000000007884",
                    "is_default": true
                },
                "phone": "",
                "employee_id": null,
                "name": "Tech 0",
                "id": "3000000065477",

                "is_vip_user": false,
                "department": null,
                "first_name": "Tech 0",
                "job_title": null
            }
        }
    ],
    "list_info": {
        "sort_fields": [
            {
                "field": "name",
                "order": "asc"
            }
        ],
        "has_more_rows": false,
        "start_index": 1,
        "fields_required": [
            "name",
            "description",
            "created_by"
        ],
        "total_count": 2,
        "page": 1,
        "get_total_count": "true",
        "row_count": 2
    }
}

Delete Checklist Template

No Description

Url

<service domain|custom domain>/app/<portal>/


$ curl <service domain|custom domain>/app/<portal>/\
      -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>/";
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>/"
$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>/"
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"
  }
}

Copy

This operation helps to copy a checklist template

Url

<service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_id}/_copy


$ curl <service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_id}/_copy\
      -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='{
  "checklist_template": {
    "name": "copy_Server Maintenance Checklists"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_id}/_copy";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "checklist_template": {
    "name": "copy_Server Maintenance Checklists"
  }
};
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/checklist_templates/{checklist_template_id}/_copy"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "checklist_template": {
    "name": "copy_Server Maintenance Checklists"
  }
}
'@
$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/checklist_templates/{checklist_template_id}/_copy"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "checklist_template": {
    "name": "copy_Server Maintenance Checklists"
  }
}'''
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"
    },
    "checklist_template": {
        "created_time": {
            "display_value": "Feb 25, 2026 12:16 PM",
            "value": "1772001997714"
        },
        "name": "copy_Server Maintenance Checklists",
        "description": "Checklist for routine server maintenance",
        "checklistitems": [
            {
                "item": {
                    "name": "Test network connectivity",
                    "id": "3000000076139",
                    "field_type": "Decision Box"
                },
                "id": "3000000076205",
                "checklist_template": {
                    "name": "copy_Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076201"
                },
                "order": "1"
            },
            {
                "item": {
                    "name": "Update system software",
                    "id": "3000000076145",
                    "field_type": "Single Line"
                },
                "id": "3000000076209",
                "checklist_template": {
                    "name": "copy_Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076201"
                },
                "order": "2"
            },
            {
                "item": {
                    "name": "Disk space usage %",
                    "id": "3000000076159",
                    "field_type": "Numeric Field"
                },
                "id": "3000000076213",
                "checklist_template": {
                    "name": "copy_Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076201"
                },
                "order": "3"
            },
            {
                "item": {
                    "name": "Monitor CPU and memory usage",
                    "id": "3000000076171",
                    "field_type": "Radio Button"
                },
                "id": "3000000076217",
                "checklist_template": {
                    "name": "copy_Server Maintenance Checklists",
                    "description": "Checklist for routine server maintenance",
                    "id": "3000000076201"
                },
                "order": "4"
            }
        ],
        "id": "3000000076201",
        "created_by": {
            "email_id": "caffrey@zmail.com",
            "is_technician": true,
            "sms_mail": null,
            "contact_info_id": "3000000065475",
            "mobile": "",
            "last_name": "",
            "user_scope": "internal_user",
            "sms_mail_id": null,
            "cost_per_hour": "0",
            "site": {
                "deleted": false,
                "name": "Base Site",
                "id": "3000000007884",
                "is_default": true,
                "customer": null
            },
            "phone": "",
            "employee_id": null,
            "name": "Tech 0",
            "id": "3000000065477",
            "is_vip_user": false,
            "department": null,
            "first_name": "Tech 0",
            "job_title": null,
            "customer": null
        },
        "is_action_template": false
    }
}

View more

Associated Template Details

This operation helps to get the list of templates a checklist template is associated with

Url

<service domain|custom domain>/app/<portal>/api/v3/checklist_templates/{checklist_template_id}/_associated_template_details


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

{
    "template": [
        {
            "comments": "This template is used to create request when there is problem in printer.",
            "is_service_request": false,
            "module": {
                "name": "request",
                "id": 3000000005998,
                "display_name": "Request"
            },
            "name": "Printer problem",
            "id": 3000000046238
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "has_more_rows": false,
        "start_index": 1,
        "total_count": 1,
        "page": 1,
        "row_count": 1
    }
}

View more