Delete app user

Table of Contents

Note:

  • This task is applicable only to Zoho Creator.

Overview

This deluge task deletes a specified user from the application. 

Return

This task returns a KEY-VALUE value in the format {"emailId":"<specified_email>"}​

Syntax

<variable> = thisapp.permissions.deleteUser( <Email_ID> );

Param Explanation

<variable>

(optional)

Variable which will hold the returned value.
<Email_ID>

Email id of the user who needs to be deleted from the application.

Points to note for this parameter:

  • If the specified value is not a valid email address, a runtime error will be encountered.
  • If the specified email address is not found, the function runs error free.  
  • You can view the email addresses of existing users in the application from the Account setup page.

Data type is TEXT.

This task can be used in the following events

When a record is Created
On Load Yes
On Validate Yes
On Success Yes
On User input Yes
Subform on add row Yes
Subform on delete row Yes
When a record is Created or Edited
On Load Yes
On Validate Yes
On Success Yes
On User input Yes
Subform on add row Yes
Subform on delete row Yes
When a record is Edited
On Load Yes
On Validate Yes
On Success Yes
On User input Yes
Subform on add row Yes
Subform on delete row Yes
When a record is Deleted
On Validate Yes
On Success Yes
Other workflow events
On a scheduled date No
During approval process Yes
During payment process Yes
In a Custom Function Yes
In an Action item in report Yes

example

A sample snippet to delete a user.

deletedUser = thisapp.permissions.deleteUser("john@zillum.com");