Creates and deploys a new configuration from the specified template to the given targets.
post /dcapi/configuration/deploy/template
https://{serverurl}/dcapi/configuration/deploy/template Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Mandatory. The unique ID of the configuration template to deploy. Fetch from List Configuration Templates .
Mandatory. Single target descriptor identifying where the configuration should be deployed. See child keys. Only computer and user targets are supported.
Mandatory. Target type. Supported values are only (lowercase): computer, user.
Mandatory. Array of numeric resource IDs corresponding to the chosen 'type' (computer or user IDs only). Maximum 200 IDs per request.
Optional. Applies only when type=computer. When true, the configuration is deployed with the domain as the main target instead of the associated remote office. Defaults to false.
curl --request POST \
--url https://appdomains/dcapi/configuration/deploy/template \
--header 'Accept: application/configDeployTemplateStatus.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/deployConfigurationTemplate.v1+json' \
--data '{}'Deploy template to specific computer resources
{
"templateId": 2001,
"targets": {
"type": "computer",
"values": [
301,
302,
303
],
"isDomainMainTarget": false
}
}
Deploy template to specific user resources
{
"templateId": 2001,
"targets": {
"type": "user",
"values": [
401,
402
]
}
}
The unique ID of the newly created configuration collection from the template deployment.
Display name of the created configuration.
The configuration type (e.g., computer or user).
Username of the technician who initiated the deployment.
CONFIG_INVALID_INPUT_DATA: request payload is missing required fields (templateId, targets), or contains unsupported collectionType 2.
Message describing the specific validation failure in the request payload.
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
CONFIG_INVALID_INPUT_DATA: server storage limit exceeded, unable to create the configuration from template.
Message indicating insufficient storage space for the deployment.
SERVICE_NOT_AVAILABLE: unexpected error during template resolution or configuration deployment.
Message describing the internal server error encountered during deployment.
Template deployed successfully creating a new configuration
{
"configType": "computer",
"collectionId": 50001,
"addedUser": "admin",
"collectionName": "Firewall_Policy_Win11"
}
Request payload missing required templateId field
{
"error_description": "Required fields are missing in the request payload",
"error_code": "CONFIG_INVALID_INPUT_DATA"
}
Custom group is not supported by this API
{
"error_description": "Unsupported target type. Only computer or user targets are supported",
"error_code": "CONFIG_INVALID_INPUT_DATA"
}
User lacks required write role or scope
{
"error_description": "Access denied - You are not allowed to access the requested resource.",
"error_code": "UAC_UNAUTHORIZED"
}
Server storage limit exceeded
{
"error_description": "Insufficient storage space to deploy the configuration",
"error_code": "CONFIG_INVALID_INPUT_DATA"
}
Unexpected failure during template deployment
{
"error_description": "An unexpected error occurred. Please try again later.",
"error_code": "SERVICE_NOT_AVAILABLE"
}
![]()
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.