Deactivate User

Note:

This task is applicable to all services except Zoho Creator.
Each time the zoho.one.deactivateUser integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.one.deactivateUser integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script.

Overview

The zoho.one.deactivateUser task is used to deactivate a user using their ID in the specified organization.

Note: Deactivating a user will unassign/disable the user from all associated applications.

<response> = zoho.one.deactivateUser(<orgID>, <userID>, <connection>);

ZohoOne.Users.DELETE

where,

Parameter	Description	Data type
response	is the variable that will hold the details of the user deactivated from the organization.	KEY-VALUE
<orgID>	is the ID of the organization from which the user needs to be deactivated.	NUMBER
<userID>	is the ID of the user who needs to be deactivated.	NUMBER
<connection>	is the name of the Zoho One connection.	TEXT

The following script deactivates a user with ID - 1510XXXXXXXX from an organization with ID - 72XXXXXXX in Zoho One:

 response = zoho.one.deactivateUser(72XXXXXXX, 1510XXXXXXXX, "zoho_one_connection");

where:

response

This is the KEY-VALUEresponse returned by Zoho One.

72XXXXXXX

This is the NUMBERthat represents the organization ID of Zoho One account.

1510XXXXXXXX

This is the NUMBERthat represents the user ID of a user who needs to be deactivated.

zoho_one_connection

This is the TEXTthat represents the link name of the connection.

{
"status_code": 204,
"resource_name": "activate",
"message": "User has been deactivated successfully!"
}