Modifying a APD task.
post /api/1.4/patch/modifyAPDTask
https://{serverurl}/api/1.4/patch/modifyAPDTask Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Automated Patch Deployment task settings to apply. The nested taskName identifies the existing task to modify; other provided fields overwrite the corresponding existing settings
Name of the patch task (mandatory field). Example: windows create task
Short description of the task purpose. Example: task for windows
Target OS platform for deployment (Windows, Mac, or Linux). Example: Windows
Includes security updates that fix vulnerabilities (applicable for Windows, Mac, Linux). Example: true
Severities of security updates to include. Example: [Critical, Important]
Includes non-security updates that fix functional or performance issues (applicable for Windows and Mac only). Example: true
Severities of non-security updates to include. Example: [Moderate, Low]
Includes updates from external vendors or third-party applications (applicable for Windows, Mac, Linux). Example: true
Severities of third-party updates to include. Example: [Critical]
Includes definition updates like antivirus or Windows Defender signatures (Windows only). Example: true
Includes cumulative sets of fixes and enhancements, typically service packs (Windows only). Example: true
Includes feature packs that add new capabilities (Windows only). Example: true
Enable or disable failure notifications for deployment. Example: false
Whether to attach failure reports in notification emails. Example: true
Enable or disable success report notifications. Example: false
Whether to attach success reports in notification emails. Example: true
File format of failure report attachment. Example: xls
File format of success report attachment. Example: pdf
Includes rollup updates that bundle multiple patches into one package (Windows only). Example: true
Includes driver updates (Windows only). Example: true
Includes preview rollup updates (Windows only). Example: true
Includes optional updates such as non-critical enhancements. At least one applicable update type must be selected for the chosen platform. Example: true
Defines how third-party applications should be patched (All, Specific, or All Except). Example: Patch Specific Applications
Defines how OS applications should be patched (All, Specific, or All Except). Example: Patch All Applications Except
List of OS applications to include or exclude during patching. Example: Windows Defender x64
List of third-party applications to include or exclude during patching. Example: Notepad++
Delay deployment by specified time after patch approval (in hours/days). Example: 5
Delay deployment by specified time after patch release (in hours/days). Example: 5
Task expiry date and time after which deployment becomes invalid (MM/DD/YYYY, HH:MM). Example: 08/29/2018, 00:00
Interval in days for sending success report notifications. Example: 3
Interval in days for sending failure notifications. Example: 1
Recipient email address for receiving notifications and reports. Example: user@example.com
Name of the deployment policy to use (mandatory field). Example: Force reboot excluding servers. Get the names from Get Deployment Policies api
Name of the target for deployment, matching target_type. Get domain names from Get Domains, remote office names from Get Remote Offices, or custom group names from Get Custom Groups api. Example: Local Office
Target type for deployment (DOMAIN, REMOTE_OFFICE, CUSTOM_GROUP). Example: REMOTE_OFFICE
Deadline configuration details for patch deployment
2->Force Reboot outside the deployment/reboot window, 1-Force reboot within the deployment/reboot window, 0->Disable force reboot
Specify after how many days the unpatched system should be
true-To enable deadline settings, false-To disable deadline settings.
curl --request POST \
--url https://appdomains/api/1.4/patch/modifyAPDTask \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"settings":{}}' {
"settings": {
"taskName": "windows create task",
"templateName": "Deploy any time at the earliest",
"target_type": "REMOTE_OFFICE",
"target_list": "Local Office"
}
}
Action identifier: modifyAPDTask
Modify result payload
Modify action result
Action result message (e.g., task has been deleted/resumed/suspended/modified successfully)
API version: 1.4
Overall operation status: success
Error code: APD_TASK_NOT_FOUND for task name mismatch, APD_ACTION_FAILED for action failures
Error type: APD_TASK_NOT_FOUND or APD_ACTION_FAILED
Detailed failure reason: task not found, task already in target state, or insufficient permissions
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
{
"message_type": "modifyAPDTask",
"message_response": {
"modifyapdtask": {
"status": "windows create task task modified successfully"
}
},
"message_version": "1.4",
"status": "success"
}
APD task with the given name does not exist
{
"error_code": "APD_TASK_NOT_FOUND",
"error": "APD_TASK_NOT_FOUND",
"error_description": "The specified APD task was not found"
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
![]()
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.