Skip to content

Checklist

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

Attributes

id (long)
Unique identifier to identify the checklist

id (long)
Unique identifier to identify the checklist

Example 

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example 

Sample Content

checklistitems (checklist_item)
List of checklist items associated with this checklist. A maximum of 25 items can be added.

checklistitems (checklist_item)
Contains the collection of checklist items

Example 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example 

Sample Content

checklist_template (checklist_template)
Used to associate existing checklist templates 

checklist_template (checklist_template)
Used to associate existing checklist templates 

Example 

{
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "id": "100000000000041001"
  }
}

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

created_by (user)
Contains the details of the user who created the checklist

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": ""
  }
}

More Attributes Expand all

created_time (datetime)read only

Indicates the time at which the checklist was created

created_time (datetime)
The timestamp when the checklist was created

Example 

{"created_time":{"display_value":"Feb 25, 2026 10:30 AM","value":"1772098200000"}}

status (boolean)read only

Indicates whether the checklist is completed

status (boolean)
Indicates whether the checklist is completed

Add Checklist

This operation helps to add a new checklist to a request. Supports bulk add.

Mandatory Fields :- name, checklistitems

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists

Attributes

id (long)
Unique identifier to identify the checklist

id (long)
Unique identifier to identify the checklist

Example 

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example 

Sample Content

checklistitems (checklist_item)
List of checklist items associated with this checklist. A maximum of 25 items can be added.

checklistitems (checklist_item)
Contains the collection of checklist items

Example 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example 

Sample Content

checklist_template (checklist_template)
Used to associate existing checklist templates 

checklist_template (checklist_template)
Used to associate existing checklist templates 

Example 

{
  "checklist_template": {
    "name": "Server Maintenance Checklist",
    "id": "100000000000041001"
  }
}


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists\
      -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": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "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",
          "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": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true"
            }
          ]
        },
        "order": 4
      }
    ]
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "checklist": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "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",
          "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": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "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/requests/{request_id}/checklists"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "checklist": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "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",
          "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": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "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/requests/{request_id}/checklists"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "checklist": {
    "name": "PreDeployment Checklists",
    "description": "Checklists before deployment",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box"
        },
        "order": 1
      },
      {
        "item": {
          "name": "Review deployment plan",
          "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",
          "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": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup ",
              "order": 1
            },
            {
              "name": "Partial Backup",
              "order": 2
            },
            {
              "name": "N/A",
              "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": {
        "created_time": {
            "display_value": "Feb 25, 2026 03:11 PM",
            "value": "1772012483981"
        },
        "pending_for_workflow_execution": null,
        "name": "PreDeployment Checklists",
        "description": "Checklists before deployment",
        "checklistitems": [
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check network connectivity",
                    "id": "3000000076293",
                    "field_type": "Decision Box"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076295",
                "is_completed": false,
                "order": "1"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Review deployment plan",
                    "id": "3000000076297",
                    "field_type": "Single Line"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076307",
                "is_completed": false,
                "order": "2"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check Disk Space",
                    "id": "3000000076309",
                    "field_type": "Numeric Field"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076317",
                "is_completed": false,
                "order": "3"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Test backup procedures",
                    "id": "3000000076319",
                    "field_type": "Radio Button"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklists",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076329",
                "is_completed": false,
                "order": "4"
            }
        ],
        "id": "3000000076283",
        "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
        },
        "status": false
    }
}

Edit Checklist

This operation helps to update an existing checklist

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}

Attributes

id (long)
Unique identifier to identify the checklist

id (long)
Unique identifier to identify the checklist

Example 

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example 

Sample Content

checklistitems (checklist_item)
List of checklist items associated with this checklist. A maximum of 25 items can be added.

checklistitems (checklist_item)
Contains the collection of checklist items

Example 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example 

Sample Content


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_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": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_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": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
};
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/requests/{request_id}/checklists/{checklist_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": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
}
'@
$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/requests/{request_id}/checklists/{checklist_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": {
    "name": "PreDeployment Checklist",
    "description": "Checklists before deployment update",
    "checklistitems": [
      {
        "item": {
          "name": "Check network connectivity",
          "field_type": "Decision Box",
          "id": 3000000076293
        },
        "order": 1,
        "id": 3000000076295
      },
      {
        "item": {
          "name": "Check Disk Space",
          "field_type": "Numeric Field",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076311"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076313"
            },
            {
              "constraint_name": "num_range",
              "constraint_value": ":",
              "id": 3000000076315
            }
          ],
          "id": 3000000076309
        },
        "order": 2,
        "id": 3000000076317
      },
      {
        "item": {
          "name": "Review deployment plan",
          "field_type": "Single Line",
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076299"
            },
            {
              "constraint_name": "unique",
              "constraint_value": "false",
              "id": "3000000076301"
            },
            {
              "constraint_name": "min_length",
              "constraint_value": "0",
              "id": 3000000076303
            },
            {
              "constraint_name": "max_length",
              "constraint_value": "250",
              "id": 3000000076305
            }
          ],
          "id": 3000000076297
        },
        "order": 3,
        "id": 3000000076307
      },
      {
        "item": {
          "name": "Test backup procedures",
          "field_type": "Radio Button",
          "allowed_values": [
            {
              "name": "Full Backup",
              "id": 3000000076321,
              "order": 1
            },
            {
              "name": "Partial Backup",
              "id": 3000000076323,
              "order": 2
            },
            {
              "name": "N/A",
              "id": 3000000076325,
              "order": 3
            }
          ],
          "constraints": [
            {
              "constraint_name": "nullable",
              "constraint_value": "true",
              "id": "3000000076327"
            }
          ],
          "id": 3000000076319
        },
        "order": 4,
        "id": 3000000076329
      }
    ]
  }
}'''
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": {
        "created_time": {
            "display_value": "Feb 25, 2026 03:11 PM",
            "value": "1772012483981"
        },
        "pending_for_workflow_execution": null,
        "name": "PreDeployment Checklist",
        "description": "Checklists before deployment update",
        "checklistitems": [
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check network connectivity",
                    "id": "3000000076293",
                    "field_type": "Decision Box"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076295",
                "is_completed": false,
                "order": "1"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Check Disk Space",
                    "id": "3000000076309",
                    "field_type": "Numeric Field"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076317",
                "is_completed": false,
                "order": "2"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Review deployment plan",
                    "id": "3000000076297",
                    "field_type": "Single Line"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076307",
                "is_completed": false,
                "order": "3"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Test backup procedures",
                    "id": "3000000076319",
                    "field_type": "Radio Button"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "PreDeployment Checklist",
                    "id": "3000000076283",
                    "status": false
                },
                "id": "3000000076329",
                "is_completed": false,
                "order": "4"
            }
        ],
        "id": "3000000076283",
        "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
        },
        "status": false
    }
}

Get Checklist

This operation helps to get a single checklist associated with a request

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}

Attributes

id (long)
Unique identifier to identify the checklist

id (long)
Unique identifier to identify the checklist

Example 

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example 

Sample Content

checklistitems (checklist_item)
List of checklist items associated with this checklist. A maximum of 25 items can be added.

checklistitems (checklist_item)
Contains the collection of checklist items

Example 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example 

Sample Content

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

created_by (user)
Contains the details of the user who created the checklist

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 was created

created_time (datetime)
The timestamp when the checklist was created

Example 

{"created_time":{"display_value":"Feb 25, 2026 10:30 AM","value":"1772098200000"}}

More Attributes Expand all

status (boolean)read only

Indicates whether the checklist is completed

status (boolean)
Indicates whether the checklist is completed

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_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/requests/{request_id}/checklists/{checklist_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/requests/{request_id}/checklists/{checklist_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/requests/{request_id}/checklists/{checklist_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": {
        "created_time": {
            "display_value": "Feb 25, 2026 03:01 PM",
            "value": "1772011864931"
        },
        "pending_for_workflow_execution": null,
        "name": "Server Maintenance Checklists",
        "description": "Checklist for routine server maintenance",
        "checklistitems": [
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Test network connectivity",
                    "id": "3000000076139",
                    "field_type": "Decision Box"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076275",
                "is_completed": false,
                "order": "1"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Update system software",
                    "id": "3000000076145",
                    "field_type": "Single Line"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076277",
                "is_completed": false,
                "order": "2"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Disk space usage  %",
                    "id": "3000000076159",
                    "field_type": "Numeric Field"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076279",
                "is_completed": false,
                "order": "3"
            },
            {
                "updated_on": null,
                "is_enabled": true,
                "item": {
                    "name": "Monitor CPU and memory usage %",
                    "id": "3000000076171",
                    "field_type": "Radio Button"
                },
                "cl_value": null,
                "updated_by": null,
                "checklist": {
                    "name": "Server Maintenance Checklists",
                    "id": "3000000076265",
                    "status": false
                },
                "id": "3000000076281",
                "is_completed": false,
                "order": "4"
            }
        ],
        "id": "3000000076265",
        "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
        },
        "status": false
    }
}

Get List Checklist

This operation helps to get the list of all checklists associated with a request

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists

Attributes

id (long)
Unique identifier to identify the checklist

id (long)
Unique identifier to identify the checklist

Example 

234759602834500

name (string)
Name of the checklist

name (string)
Name of the checklist

Example 

Sample Content

checklistitems (checklist_item)
List of checklist items associated with this checklist. A maximum of 25 items can be added.

checklistitems (checklist_item)
Contains the collection of checklist items

Example 

{
  "checklistitems": [
    {
      "is_enabled": true,
      "item": {
        "name": "Verify backup",
        "id": "100000000000040001",
        "field_type": "Decision Box"
      },
      "id": "100000000000045001",
      "is_completed": false,
      "order": "1"
    }
  ]
}

description (string)
Description of the checklist

description (string)
A brief description of the checklist

Example 

Sample Content

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

created_by (user)
Contains the details of the user who created the checklist

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": ""
  }
}

status (boolean)read only
Indicates whether the checklist is completed

status (boolean)
Indicates whether the checklist is completed

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

{
    "checklists": [
        {
            "pending_for_workflow_execution": null,
            "name": "Checklist 1",
            "description": null,
            "id": "3000000076067",
            "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
            },
            "status": false
        },
        {
            "pending_for_workflow_execution": null,
            "name": "Server Maintenance Checklists",
            "description": "Checklist for routine server maintenance",
            "id": "3000000076265",
            "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
            },
            "status": false
        }
    ],
    "response_status": [
        {
            "status_code": 2000,
            "status": "success"
        }
    ],
    "list_info": {
        "sort_fields": [
            {
                "field": "id",
                "order": "asc"
            }
        ],
        "has_more_rows": false,
        "start_index": 1,
        "total_count": 2,
        "page": 1,
        "get_total_count": "true",
        "row_count": 2
    }
}

Delete Checklist

This operation helps to delete checklist from a request.Bulk Supported

Url

<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}


$ curl <service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/requests/{request_id}/checklists/{checklist_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

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