Delete portal user
Note:
- This task is applicable only to Zoho Creator.
Overview
This deluge task deletes a specified user from the customer portal.
Return
This task returns a KEY-VALUE value in the format { "emailId" : "<specified_email>" }
Syntax
<variable> = thisapp.portal.deleteUser( <Email_ID> );
| Parameter | Description |
|---|---|
<variable> (optional) | Variable which will hold the returned value. |
| <Email_ID> | Email id of the customer portal user who needs to be deleted. Points to note for this parameter:
Applicable 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 being used to delete a customer portal user.
deletedUser = thisapp.portal.deleteUser("john@zillum.com");