Starts a new text chat session with the specified computer. Returns session details including the session ID, client member IDs, the active logged-on user, and connection status. Requires the computer to be online and managed.
post /dcapi/tools/chat/{resourceId}/initiate
https://{serverurl}/dcapi/tools/chat/{resourceId}/initiate
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
The unique identifier of the target device
curl --request POST \
--url https://appdomains/dcapi/tools/chat/{resourceId}/initiate \
--header 'Accept: application/chatInitiationStatus.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
--header 'content-type: application/json' \
--data '{}' {
"chatInitiatedFrom": "console",
"loggedOnUserName": "john.doe",
"sessionID": 998877665544,
"initAgentFlag": true,
"chatType": 1
}
Unique identifier of the initiated chat session
Technician member ID in the chat session
Agent member ID on the remote computer
Logged-on user on the remote computer
Session status: initiated, connected, failed
{
"agentMemberID": "agent_101",
"loggedOnUser": "john.doe",
"connectionStatus": "initiated",
"techMemberID": "tech_001",
"sessionId": 998877665544
}
![]()
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.