Activate User  

Table of Contents

Note:

  • This task is applicable to all services except Zoho Creator.
  • Each time the zoho.one.activateUser 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.activateUser 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.activateUser task is used to activate a user using their ID in the specified organization.

Note: Activating a user will regain access to their account and to all the associated applications.

Syntax

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

Scope

ZohoOne.Users.UPDATE

where:

ParameterDescriptionData type
responseis the variable that will hold the details of the activated user.KEY-VALUE
<orgID>is the ID of the organization in which the user needs to be activated.NUMBER
<userID>is the ID of the user who needs to be activated.NUMBER
<connection>is the name of the Zoho One connection.TEXT

Example

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

response = zoho.one.activateUser(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 activated.
zoho_one_connection
This is the TEXTthat represents the link name of the connection.

Response Format

{
   "status_code": 200,
   "activate": [
       {
           "href": "http://one.zoho.com/api/v1/orgs/72*******/users/1510********/activate"
       }
   ],
   "resource_name": "activate",
   "message": "User has been activated successfully!"
}