Creates an Alert template to display notifications for Windows users. This policy supports only user configurations.
post /dcapi/config-policies/v2/windows/alert
https://{serverurl}/dcapi/config-policies/v2/windows/alert Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Media type of the request body, as consumed by the endpoint.
Media type of the response body, as produced by the endpoint.
Name of the configuration. Returned as templateName in the response.
Free-text description of the configuration. May be an empty string.
What the configuration is applied to. Must be user - Alerts apply to users only.
Reapply the configuration at every agent refresh, even when it has already been applied successfully.
Apply the configuration at user logon.
Apply the configuration at the scheduled agent refresh.
Retry the configuration on the endpoint when it fails. noOfRetries sets how many attempts are made.
Honour refreshMinRetry as the minimum gap between two retries at refresh.
Honour logonStartupMinRetry as the minimum gap between two retries at startup or logon.
Number of retry attempts made after a failure. Read only when enableRetry is true.
Minimum number of minutes between two retries at refresh. Read only when enableRefreshMinRetry is true.
Minimum number of minutes between two retries at startup or logon. Read only when enableLogonStartupMinRetry is true.
Exactly one entry, carrying the alert settings applied for the user.
Number of days before password expiration when the user should be warned.
Allowed range: 0 to 60.
Example: warnPwdExpireDays: 14.
Minimum available drive space, in MB, at which a low disk space warning should be displayed.
Allowed range: 0 to 99999.
Example: warnOnDriveSpace: 500.
Whether temporary files should be purged when the configured conditions are met.
Allowed values:
true = Purges temporary files.
false = Does not purge temporary files.
When true, purgeFileType must also be supplied.
File type or file pattern of files that should be purged.
Required when purgeOnTemp is true.
Example: purgeFileType: "*.tmp".
Whether the user should be prompted before performing the configured alert action.
Allowed values:
true = Prompts the user before performing the action.
false = Performs the action without prompting the user.
Read only when purgeOnTemp is true.
Maximum file size, in MB, for files that should be considered for purging.
Allowed range: 0 to 99999.
Read only when purgeOnTemp is true.
Example: purgeFileSize: 50.
Send an email to the addresses listed in email once the deployment finishes.
Notify the endpoint user about this deployment. notificationDuration and notificationEnabledDays are read only when this is true.
Comma-separated email addresses notified about the deployment. May be an empty string when enableEmailNotify is false.
How long a deployment notification stays on screen for the endpoint user. Read only when enableNotification is true.
Number of days for which deployment notifications stay enabled. Read only when enableNotification is true.
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/alert \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{}],"label":"Windows Alert Config","configType":"user"}'Configure a single alert policy entry with all supported fields.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Windows Alert Config",
"configType": "user",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"promptUser": true,
"purgeFileSize": 50,
"purgeOnTemp": true,
"purgeFileType": "*.tmp",
"warnOnDriveSpace": 500,
"warnPwdExpireDays": 14
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/alert \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{}],"label":"Password Expiry Alert","configType":"user"}'Warn the user about password expiry while leaving the low-disk-space threshold at 500 MB and disabling temporary-file purging.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Password Expiry Alert",
"configType": "user",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"purgeOnTemp": false,
"warnPwdExpireDays": 7,
"warnOnDriveSpace": 500
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/alert \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{}],"label":"Temporary File Cleanup","configType":"user"}'Purge temporary files while keeping the password-expiry warning at 14 days and the low-disk-space warning at 500 MB.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Temporary File Cleanup",
"configType": "user",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"promptUser": false,
"purgeFileSize": 100,
"purgeOnTemp": true,
"purgeFileType": "*.bak"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
Success response returned when the configuration is saved as a reusable template.
Unique identifier of the created template. Pass it to the Deploy Configuration Template API to deploy this template to targets.
Name of the created template. It is the label sent in the request.
Type of configuration the template was created for. Allowed values:
computer
user
Login name of the API user who created the template.
Error response when the request contains invalid or missing required fields.
Product error code. 50003 = CONFIG_INVALID_INPUT_DATA: configDetails is missing or empty, or the configuration could not be resolved for this endpoint. 20003 = SERVICE_NOT_AVAILABLE: the configuration is deprecated for the requested configType.
Localised error message for the error code.
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Error response returned when the server does not have enough free disk space to store the configuration files.
Product error code. 170013 = INTERNAL_SERVER_ERROR: raised by the storage pre-check before the template is saved.
Localised error message for the error code.
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
Error response returned when the template could not be saved because of an unexpected server error.
Product error code. 1003 = INTERNAL_ERROR: the template could not be persisted. 50001 = CONFIG_INTERNAL_ERROR: an internal configuration error occurred while processing the request.
Localised error message for the error code.
Success response for configureAlerts
{
"templateName": "configureAlerts",
"templateId": 327,
"configType": "user",
"addedUser": "admin"
}
Error response for configureAlerts
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for warnOnPasswordExpiry
{
"templateName": "warnOnPasswordExpiry",
"templateId": 341,
"configType": "user",
"addedUser": "admin"
}
Error response for warnOnPasswordExpiry
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for purgeTemporaryFiles
{
"templateName": "purgeTemporaryFiles",
"templateId": 352,
"configType": "user",
"addedUser": "admin"
}
Error response for purgeTemporaryFiles
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
User is not authorized to create the configuration policy
{
"errorCode": 1001,
"errorMsg": "Access denied - You are not allowed to access the requested resource."
}
Storage pre-check rejected the request before the template was saved
{
"errorCode": 170013,
"errorMsg": "The server machine does not have sufficient disk space. Please free up space and try again."
}
Request rejected because the caller exceeded the configured rate limit
{
"errorCode": "IAM0019",
"url": "/dcapi/config-policies/v2/windows/alert",
"errorMsg": "The URL /dcapi/config-policies/v2/windows/alert was called too many times. Please retry after a while."
}
Unexpected server error while saving the configuration as a template
{
"errorCode": 1003,
"errorMsg": "An Internal Error occurred, try again later."
}
![]()
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.