Add a new CardDAV payload configuration to an existing profile To create Carddav policy
Request URL https://{serverurl} /api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy
Scope
Header Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Request Parameters - Path Parameters profile_id string Mandatory
- Request Body application/json JSON object
Hide Sub-Attributes account_display_name string Optional
account_hostname string Mandatory
account_port integer Mandatory
Account Port. Default: 8843
principal_url string Optional
account_username string Optional
account_password string Optional
Account Password (sensitive - write-only)
account_password_id long Optional
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
--url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/json' \
--data '{"account_hostname":"https://zylker.com","account_port":8843}'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/api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy"))
.header("content-type", "application/json")
.header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"account_hostname\":\"https://zylker.com\",\"account_port\":8843}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
payload = "{\"account_hostname\":\"https://zylker.com\",\"account_port\":8843}"
headers = {
'content-type': "application/json",
'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52"
}
conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Content-Type", "application/json");
headersMap.put("Accept", "application/json");
data=Map();
data.put("account_hostname","value");
data.put("account_port","1");
response = invokeUrl
[
url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy"
type: POST
headers: headersMap
body: data
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/carddavpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"account_hostname":"https://zylker.com","account_port":8843}'▼ Show full
Sample Request Body Add CardDAV payload to the profile
Copied!
{
"account_hostname": "https://zylker.com",
"account_password": "********",
"principal_url": "https://zylker.com",
"account_display_name": "Zylker User",
"use_ssl": true,
"account_username": "Zylker User",
"account_password_id": 1,
"account_port": 8843
}
▼ Show full
Response Parameters - HTTP code 200 Response Body - application/json JSON object
Hide Sub-Attributes payload_id long
Unique identifier for the created payload item
account_display_name string
account_port integer
Account Port. Default: 8843
account_password string
Account Password (sensitive - write-only)
Possible Response Codes Sample Response: HTTP 200 CardDAV payload successfully added
Copied!
{
"payload_id": 9007199254741000,
"account_hostname": "https://zylker.com",
"account_password": "********",
"principal_url": "https://zylker.com",
"account_display_name": "Zylker User",
"use_ssl": true,
"account_username": "Zylker User",
"account_password_id": 1,
"account_port": 8843
}
▼ 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.