Creates a Shortcut template to manage desktop or internet shortcuts on Windows target endpoints. This policy supports both computer and user configurations.
post /dcapi/config-policies/v2/windows/shortcut
https://{serverurl}/dcapi/config-policies/v2/windows/shortcut 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. Allowed values:
computer = applied to the endpoint
user = applied to the logged-on user
Shortcut supports both computer and user configurations.
Reapply the configuration at every agent refresh, even when it has already been applied successfully.
Apply the configuration at endpoint startup when configType is computer, or at user logon when configType is user.
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.
One entry per shortcut to create or delete, applied in the order they appear, for either a computer or user target.
Type of shortcut.
Allowed Values:
generalShortcut = Creates a shortcut to an application, file, folder, or other local resource.,
internetShortcut = Creates a shortcut to an internet or web URL.
Example: type: "generalShortcut".
Operation to perform.
Allowed values:
create = creates shortcut,
delete = deletes the shortcut matches with shortcutName
Example: operation: "create".
Name of the shortcut. This field is required when creating a shortcut and is used to identify the shortcut when deleting it.
Example: shortcutName: "My Application".
Path of the target application for which the shortcut should be created. The application can be located on the local machine or a network location.
Example: targetApp: "C:\Applications\MyApplication\Application.exe".
Web URL for which the shortcut should be created. This option is available only when Action = internetShortcut.
Example: targetUrl: "https://www.example.com".
If the application requires any arguments, specify the arguments. Leave it blank if it does not require any arguments.
Example: targetAppArgument: "--mode=production".
Select the location to create the shortcut. Also this location is used to identify shortcut location while deleting it. The shortcut location can be any of the following:
Allowed values for computer:
allUsersDesktop = Creates the shortcut on the desktop for all users. , allUsersStartMenu = Creates the shortcut in the Start Menu for all users. , allUsersProgramsGroup = Creates the shortcut in the Programs group for all users. , allUsersStartupGroup = Creates the shortcut in the Startup group for all users., customLocation = Creates the shortcut at a custom location specified by the user.
Allowed values for User:
userDesktop = Creates the shortcut on the current user's desktop.
userFavorites = Creates the shortcut in the current user's Favorites folder.
userStartMenu = Creates the shortcut in the current user's Start Menu.
userProgramsGroup = Creates the shortcut in the current user's Programs group.
userStartupGroup = Creates the shortcut in the current user's Startup group.
userQuickLaunchBar = Creates the shortcut in the current user's Quick Launch bar.
allUsersDesktop = Creates the shortcut on the desktop for all users.
allUsersStartMenu = Creates the shortcut in the Start Menu for all users.
allUsersProgramsGroup = Creates the shortcut in the Programs group for all users.
allUsersStartupGroup = Creates the shortcut in the Startup group for all users.
customLocation = Creates the shortcut at the custom location specified by the user.
Example: shortcutLocation: "allUsersDesktop".
Custom location where the shortcut should be created when shortcutLocation is customLocation.
Example: customLocationPath: "C:\Applications\Shortcuts".
Some applications may have some references to additional files during execution. In such cases, browse and select the location from where the application has to be started.
Example: startInFolder: "C:\Applications\MyApplication".
Comments for this shortcut.
Example: comments: "Create application shortcut".
Select and upload the icon file using POST /emsapi/files. The uploaded file is referenced here using its fileID and fileName.
fileID (Mandatory) : Identifier of a file already uploaded to the server. Upload the file first (POST /emsapi/files) and pass the fileID returned by that call. A fileID that has expired from the temporary upload folder is rejected.
fileName : Name of the uploaded icon file.
Supported file format: .ico
Identifier of a file already uploaded to the server. Upload the file first (POST /emsapi/files) and pass the fileID returned by that call. A fileID that has expired from the temporary upload folder is rejected.
Uploaded file name.
Select how the application has be started -
Allowed values:
normal = Starts the application in its default window state.,
maximized = Starts the application in a maximized window ,
minimized =Starts the application in a minimized window.
Example: runWindow: "normal".
Whether to overwrite the shortcut if it already exists.
Allowed values:
true = Overwrites the existing shortcut.
false = Does not overwrite the existing shortcut.
Whether the shortcut should run the application with administrator privileges. Allowed value:
true = Runs the application as an administrator.
false = Runs the application with standard user privileges.
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/shortcut \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"shortcutName":"My Application","type":"generalShortcut","operation":"create"}],"label":"Shortcut Config","configType":"computer"}'Create a computer-scoped shortcut entry with every documented field. Shortcut supports both computer and user configurations. targetUrl is empty here because the example creates a general shortcut rather than an internet shortcut.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Shortcut Config",
"configType": "computer",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"shortcutLocation": "userDesktop",
"comments": "Create application shortcut",
"customLocationPath": "",
"iconFile": {
"fileName": "Custom-Icon.ico",
"fileID": 302
},
"runasAdmin": false,
"startInFolder": "C:\\Applications\\MyApplication",
"type": "generalShortcut",
"targetAppArgument": "--mode=production",
"targetApp": "C:\\Applications\\MyApplication\\Application.exe",
"shortcutName": "My Application",
"runWindow": "normal",
"operation": "create",
"overwrite": false,
"targetUrl": ""
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/shortcut \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"shortcutName":"Support Portal","type":"internetShortcut","operation":"create"}],"label":"Internet Shortcut Config","configType":"user"}'Create an internet shortcut that opens a web URL.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Internet Shortcut Config",
"configType": "user",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"shortcutLocation": "userFavorites",
"comments": "Open the support portal",
"customLocationPath": "",
"iconFile": {
"fileName": "SupportPortal.ico",
"fileID": 305
},
"runasAdmin": false,
"startInFolder": "",
"type": "internetShortcut",
"targetAppArgument": "",
"targetApp": "",
"shortcutName": "Support Portal",
"runWindow": "normal",
"operation": "create",
"overwrite": true,
"targetUrl": "https://support.example.com"
}
],
"enableNotification": false,
"enableEmailNotify": false,
"notificationDuration": 6,
"enableRetry": false,
"enableRefreshMinRetry": false,
"email": ""
}
curl --request POST \
--url https://appdomains/dcapi/config-policies/v2/windows/shortcut \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/json' \
--data '{"configDetails":[{"shortcutName":"My Application","type":"generalShortcut","operation":"delete"}],"label":"Delete Shortcut Config","configType":"user"}'Delete an existing shortcut by name and location.
{
"applyAtRefresh": false,
"applyAlways": false,
"description": "Created through the Config Policies API.",
"label": "Delete Shortcut Config",
"configType": "user",
"applyAtStartupLogon": true,
"noOfRetries": 2,
"refreshMinRetry": 1,
"notificationEnabledDays": 3,
"enableLogonStartupMinRetry": false,
"logonStartupMinRetry": 1,
"configDetails": [
{
"shortcutLocation": "userDesktop",
"shortcutName": "My Application",
"type": "generalShortcut",
"operation": "delete"
}
],
"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 createShortcut
{
"templateName": "createShortcut",
"templateId": 337,
"configType": "computer",
"addedUser": "admin"
}
Error response for createShortcut
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for createInternetShortcut
{
"templateName": "createInternetShortcut",
"templateId": 351,
"configType": "user",
"addedUser": "admin"
}
Error response for createInternetShortcut
{
"errorCode": 50003,
"errorMsg": "Some Input field missing in configuration"
}
Success response for deleteShortcut
{
"templateName": "deleteShortcut",
"templateId": 358,
"configType": "user",
"addedUser": "admin"
}
Error response for deleteShortcut
{
"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/shortcut",
"errorMsg": "The URL /dcapi/config-policies/v2/windows/shortcut 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.