Suspending a APD task.
This API endpoint is deprecating soon
View new endpoint >post /api/1.4/patch/suspendAPDTask
https://{serverurl}/api/1.4/patch/suspendAPDTask Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Name of the APD task to act on. Get the task names from Get APD Tasks api
curl --request POST \
--url https://appdomains/api/1.4/patch/suspendAPDTask \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json'Action identifier: suspendAPDTask
Suspend result payload
Suspend 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": "suspendAPDTask",
"message_response": {
"suspendapdtask": {
"status": "task has been suspended 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.