Delete one or more user-defined templates Permanently deletes the specified configuration templates. This action is irreversible.
Request URL https://{server-hostname}:8383/dcapi/configuration/template
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Content-Type string Mandatory
- Request Body application/json JSON object
Hide Sub-Attributes templateIds array Optional
Array of template IDs to delete. Each must be a valid user-defined template belonging to the requesting customer. Maximum 500 entries.
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
--url https://appdomain/dcapi/configuration/template \
--header 'Accept: application/deleteTemplateStatus.v1+json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52' \
--header 'Content-Type: application/deleteTemplate.v1+json' \
--data '{"templateIds":[1001,1002,1003]}'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/configuration/template"))
.header("Content-Type", "application/deleteTemplate.v1+json")
.header("Accept", "application/deleteTemplateStatus.v1+json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("DELETE", HttpRequest.BodyPublishers.ofString("{\"templateIds\":[1001,1002,1003]}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
payload = "{\"templateIds\":[1001,1002,1003]}"
headers = {
'Content-Type': "application/deleteTemplate.v1+json",
'Accept': "application/deleteTemplateStatus.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("DELETE", "/dcapi/configuration/template", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Content-Type", "application/deleteTemplate.v1+json");
headersMap.put("Accept", "application/deleteTemplateStatus.v1+json");
data=Map();
data_templateIds=List();
data_templateIds.add("1");
data.put("templateIds",data_templateIds);
response = invokeUrl
[
url: "https://appDomain/dcapi/configuration/template"
type: DELETE
headers: headersMap
body: data
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Content-Type", "application/deleteTemplate.v1+json")
$headers.Add("Accept", "application/deleteTemplateStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/configuration/template' -Method DELETE -Headers $headers -ContentType 'application/deleteTemplate.v1+json' -Body '{"templateIds":[1001,1002,1003]}'▼ Show full
Sample Request Body Delete multiple configuration templates
Copied!
{
"templateIds": [
1001,
1002,
1003
]
}
▼ Show full
Response Parameters - HTTP code 200 Response Body - application/json JSON object
Hide Sub-Attributes status string
Result of the delete templates operation
deletedCount string
Number of templates successfully deleted
- HTTP code 400 Response Body - application/json JSON object
Hide Sub-Attributes error_code string
BAD_REQUEST: template IDs are invalid, belong to another customer, or are system templates that cannot be deleted
error_description string
Message describing the template validation failure
- HTTP code 401 Response Body - application/json JSON object
Hide Sub-Attributes errorCode long
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
errorMsg string
Authentication failure reason
Possible Response Codes Sample Response: HTTP 200 Templates deleted successfully
Copied!
{
"deletedCount": 3,
"status": "Success"
}
▼ Show full
Sample Response: HTTP 400 Template IDs are invalid or belong to another customer
Copied!
{
"error_description": "Invalid template IDs or templates belong to another customer",
"error_code": "BAD_REQUEST"
}
▼ Show full
Sample Response: HTTP 401 User lacks write role or attempting to delete system templates
Copied!
{
"error_description": "Access denied - You are not allowed to access the requested resource.",
"error_code": "UAC_UNAUTHORIZED"
}
▼ Show full
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.