The purpose of this API is to delete a user from a Zoho Connect external network.
| Request URL: | https://connect.zoho.com/pulse/api/deleteUserFromNetwork |
OAuth Scope: | zohopulse.networkAdmin.DELETE |
Request Method: | POST |
| Mandatory Header: | Header name: Authorization Header Value: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52 |
Parameters
| Name | Description | Required |
| scopeID (required) | scope id of the network | Required |
| userId (either userId or emailId) | user id of user to be deleted | Required |
| emailId (either emailId or userId) | email id of user to be deleted | Required |
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/deleteUserFromNetwork?scopeID=12345&userId=123&password=Sample Success Response
Copied{
"deleteUserFromNetwork": {
"result": "success"
}
}Sample Failure Response-1
Copied{
"deleteUserFromNetwork": {
"result": "failure",
"reason": "SELF_DELETE_NOT_ALLOWED"
}
}Sample Failure Response-2
Copied{
"deleteUserFromNetwork": {
"result": "failure",
"reason": "Mandatory value userId or emailId is missing"
}
}