Choose where you’d like to start

Delete app user

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> );

ParamExplanation

<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 LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Created or Edited
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Edited
On LoadYes
On ValidateYes
On SuccessYes
On User inputYes
Subform on add rowYes
Subform on delete rowYes
When a record is Deleted
On ValidateYes
On SuccessYes
Other workflow events
On a scheduled dateNo
During approval processYes
During payment processYes
In a Custom FunctionYes
In an Action item in reportYes

example

A sample snippet to delete a user.

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

Get Started Now

Execute