Zoho Deluge

https://www.zoho.com/deluge/help/
Admin
Zoho Deluge is a low-code scripting language used to automate and integrate applications within the...
Tokens:665,281
Snippets:9,525
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Parameter Examples

Source: https://www.zoho.com/deluge/help/directory/add-user.html

Individual parameter values used in the addUser example.

```Text
response
```

```Text
72XXXXXXX
```

```Text
zoho_directory_connection
```

```Text
John
```

```Text
John@xxxx.xxx
```

```Text
48XXXXXX
```

--------------------------------

### Example usage of getAllRecordings

Source: https://www.zoho.com/deluge/help/webinar/get-all-recordings.html

A practical example showing how to call the task with specific parameters.

```Deluge
response = zoho.webinar.getAllRecordings(99031443, 1, 20, "webinar");
```

--------------------------------

### Parameter examples for zoho.sdp.getRecordById

Source: https://www.zoho.com/deluge/help/sdp/get-record-by-id.html

Individual parameter examples used in the integration task.

```Deluge
response
```

```Deluge
"Request"
```

```Deluge
317XXXXXXXXXX348
```

```Deluge
""
```

```Deluge
"sdp_connection"
```

--------------------------------

### containsKey Examples

Source: https://www.zoho.com/deluge/help/functions/collection/containskey.html

Practical examples demonstrating key and index lookups in collections.

```Deluge
productVersion = collection("Creator": 5, "CRM": 2, "Mail": 8);
info productVersion.containsKey("CRM"); // Returns true
```

```Deluge
productVersion = collection("Creator", "CRM", "Mail");
info productVersion.containsKey(3); // Returns false
```

--------------------------------

### Activate User Parameter Examples

Source: https://www.zoho.com/deluge/help/one/activate-user.html

Individual parameter examples for the activateUser task.

```Text
response
```

```Text
72XXXXXXX
```

```Text
1510XXXXXXXX
```

```Text
zoho_one_connection
```

--------------------------------

### Parameter Examples

Source: https://www.zoho.com/deluge/help/directory/get-designations.html

Individual parameter values used in the example script.

```Text
response
```

```Text
72XXXXXXX
```

```Text
zoho_directory_connection
```

```Text
1
```

```Text
200
```

--------------------------------

### Example usage of zoho.webinar.getUserDetails

Source: https://www.zoho.com/deluge/help/webinar/get-user-details-by-user-id.html

A concrete example showing how to call the task with specific parameters.

```Deluge
response = zoho.webinar.getUserDetails(99031443, 640967000000027xxx, "webinar");
```

--------------------------------

### Example usage of getRegistrationDetails

Source: https://www.zoho.com/deluge/help/webinar/get-registration-details.html

A practical example showing how to call the task with specific parameters.

```Deluge
rsponse = zoho.webinar.getRegistrationDetails(86367739, 1049243583, 645551000000038094, 1, 1, 20, "webinar");
```

--------------------------------

### Deluge get Examples

Source: https://www.zoho.com/deluge/help/functions/collection/get.html

Examples demonstrating index-based retrieval from a list and key-based retrieval from a map.

```Deluge
names = Collection("name10", "name2", "name6", "name1");
first_name = names.get(0);

// the value "name10" is assigned to first_name
fifth_name = names.get(4);

// Throws a run-time error - "Given index 4 is greater than the list size"
names = Collection("name1": "John", "name2": "Bill");
name = names.get("name1");

// the value "John" is assigned to name
name = names.get("name3"); // returns null
```

--------------------------------

### Add User Example

Source: https://www.zoho.com/deluge/help/directory/add-user.html

Example script demonstrating how to construct the user data map and execute the addUser task.

```Deluge
userData = Map();
userData.put("first_name", "John");
userData.put("email_id", "John@xxxx.xxx");
userData.put("designation_id", "48XXXXXX");
response = zoho.directory.addUser(72XXXXXXX, userData, "zoho_directory_connection")
```

--------------------------------

### Retrieve data from a collection

Source: https://www.zoho.com/deluge/help/datatypes/collection.html

Syntax and examples for fetching values from a collection using the get function.

```Deluge
<value> = <collection_variable>.get(<index/key>);
```

```Deluge
value = gadgets.get(0);
```

```Deluge
value = details.get("Name");
```

--------------------------------

### Example: Create a new project

Source: https://www.zoho.com/deluge/help/projects/create-project.html

Demonstrates creating a project named 'Sales' in the 'zylker' portal.

```Deluge
new_project = Map();
new_project.put("name", "Sales");
response = zoho.projects.createProject("zylker", new_project);
```

--------------------------------

### Get Maximum Age Example

Source: https://www.zoho.com/deluge/help/data-access/aggregate-records/maximum.html

Retrieves the maximum value from the age field in the Employees form.

```Deluge
EmployeeDetails = Employees
[
    ID != 0
].maximum(age);
```

--------------------------------

### CRM Get Users Success Response

Source: https://www.zoho.com/deluge/help/crm/get-user-data.html

Example JSON structure returned by the crm.getusers connector.

```JSON
{
    "status_code": 200,
    "response": "{
        "users": [
            {
                "zip": 6000049,
                "phone": 9876543210,
                "fax": null,
                "status": "active",
                "website": "http: //www.zoho.com",
                "street": null,
                "state": "TamilNadu",
                "country": "in",
                "city": "Chennai",
                "alias_name": null,
                "first_name": "Zoho",
                "timezone": "Asia/Calcutta",
                "zuid": "3032021",
                "email": "platform+demo@zohocorp.com",
                "dob": 22.2.1993,
                "last_name": Demo,
                "time_format": null,
                "role": "CEO",
                "user_id": "1297376000000094003",
                "language": "en_US",
                "confirm": true,
                "mobile": "9500080429",
                "full_name": "ZohoDemo",
                "profile": "Administrator"
            },
            {
                "zip": null,
                "phone": null,
                "fax": null,
                "status": "deleted",
                "website": null,
                "street": null,
                "state": null,
                "country": null,
                "city": null,
                "alias_name": null,
                "first_name": "Zoho1",
                "timezone": "Asia/Kolkata",
                "zuid": null,
                "email": "platform+demo1@zohocorp.com",
                "dob": null,
                "last_name": "Demo1",
                "time_format": null,
                "role": "CEO",
                "user_id": "1297376000000108007",
                "language": "en",
                "confirm": true,
                "mobile": null,
                "full_name": "Zoho1Demo1",
                "profile": "Administrator"
            }
        ]
    }"
}
```

--------------------------------

### Create Appointment Example

Source: https://www.zoho.com/deluge/help/bookings/create-appointment.html

A practical example showing how to define customer details and execute the appointment creation task.

```Deluge
// Create a KEY-VALUE variable to hold the customer details
customerDetails = Map();
customerDetails.put("name", "Laura");
customerDetails.put("email", "laura@gmail.com");
customerDetails.put("phone_number", "9999999999");

//Execute the bookings integration task to create an appointment
response = zoho.bookings.createAppointment(3883XXXXXXXXXXX7032, "18-Oct-2019 12:15:00", customerDetails, 3883XXXXXXXXXXX7008, "Asia/Calcutta", true, "bookings_oauth_connection");
```

```text
response
```

```text
3883XXXXXXXXXXX7032
```

```text
"18-Oct-2019 12:15:00"
```

```text
customerDetails
```

```text
3883XXXXXXXXXXX7008
```

```text
"Asia/Calcutta"
```

```text
true
```

```text
"bookings_oauth_connection"
```

--------------------------------

### Extension Property Task Examples

Source: https://www.zoho.com/deluge/help/cliq/extension-tasks.html

Demonstrates setting, getting, and deleting properties using a connection.

```Deluge
dataMap = {"username": "scottfisher"};
setResponse = zoho.cliq.extension.setProperties(dataMap, cliq_connection);
getResponse = zoho.cliq.extension.getProperties("username", cliq_connection);
deleteResponse = zoho.cliq.extension.deleteProperty("username", cliq_connection);
```

--------------------------------

### Get Last Key Example

Source: https://www.zoho.com/deluge/help/functions/collection/getlastkey.html

Retrieves the key associated with the last occurrence of the value 5 in a collection.

```Deluge
productVersion = collection("Creator": 5, "CRM": 2, "Mail": 5);
info productVersion.getLastKey(5); // Returns "Mail"
```

--------------------------------

### Mark a document as ready

Source: https://www.zoho.com/deluge/help/writer/mark-document-ready.html

Example script demonstrating how to mark a specific document as ready using a connection.

```Deluge
document_id = "h36bc2a6c50b2754a405880c1d1679a5f5be9";
response = zoho.writer.documents.markAsReady(document_id, "writer_oauth_connection");
info response;
```

--------------------------------

### Get Users JSON Response Structure

Source: https://www.zoho.com/deluge/help/directory/get-users.html

Example of the JSON object returned when retrieving user data.

```json
{
  "status_code": 200,
    "users": [{
        "address": [
            {
                "address_type": 1,
                "city": “****”,
                "country": “**”,
                "country_display_name": “*****”,
                "extension": “2***”,
                "mobile": “99*******”,
                "phone": “89*******”,
                "postal_code": “66*****”,
                "seating_location": “O****”,
                "state": “******”,
                "street_address": “***”
            }
        ],
        "country_code": "gb",
        "customFields": [
            {
                "field_id": "79***********",
                "field_name": "BLOOD-GROUP",
                "field_value": “**”
            },
            {
                "field_id": "79***********",
                "field_name": "Height",
                "field_value": ***
            }
        ],
        "designation_id": "71******”,
        "display_name": “ki******”,
        "emails": [
            {
                "email_id": “ki******@*******.***”,
                "is_primary": true,
                "is_verified": true
            }
        ],
        "employee_id": “3****”,
        "first_name": “Ki******",
        "full_name": "ki******",
        "gender": "M",
        "is_active": true,
        "is_admin": false,
        "is_confirmed": true,
        "is_invited": false,
        "is_joined": false,
        "language_code": "en-us",
        "last_name": "",
        "reportingTo": {
            "emails": [
                {
                    "email_id": "na******@*******.***",
                    "is_primary": true,
                    "is_verified": true
                }
            ],
            "user_id": "79***********",
            "zuid": "77*******"
        },
        "timezone": "Asia/Kolkata",
        "user_id": "79**************”,
        "user_type": "confirmed",
        "zuid": "77*******"
},...]
    "resource_name": "users"
}
```

--------------------------------

### Example usage of getAllDepartments

Source: https://www.zoho.com/deluge/help/webinar/get-all-department.html

A practical example showing how to call the task with specific portal ID, pagination, and connection parameters.

```Deluge
response = zoho.webinar.getAllDepartments(86367739, 1, 20, "webinar");
```

--------------------------------

### Get Last Index Example

Source: https://www.zoho.com/deluge/help/functions/collection/getlastkey.html

Retrieves the index of the last occurrence of the string "Creator" in a collection.

```Deluge
products = collection("Creator", "CRM", "Creator");
info products.getLastKey("Creator"); // Returns 2
```

--------------------------------

### Example usage of zoho.webinar.getUsersList

Source: https://www.zoho.com/deluge/help/webinar/get-list-of-users.html

A concrete example showing how to call the task with specific portal ID, pagination, and connection parameters.

```Deluge
response = zoho.webinar.getUsersList(99031443, 1, 20, "webinar");
```

--------------------------------

### Fetch File and Get Size

Source: https://www.zoho.com/deluge/help/file/get-file-size.html

Example demonstrating how to fetch a file from a URL using invokeUrl and subsequently retrieve its size.

```Deluge
// to fetch file from the cloud using invokeUrl task
fileVariable = invokeUrl
[
    url : " http://insight.dev.schoolwires.com/HelpAssets/C2Assets/C2Files/C2ImportCalEventSample.csv "
    type : GET
];
```

```Deluge
// to fetch the size of the file
response = fileVariable.getFileSize(); // returns 545 (bytes)
```

--------------------------------

### Example usage of zoho.webinar.getWebinarById

Source: https://www.zoho.com/deluge/help/webinar/get-webinar-with-key.html

A concrete example showing how to call the task with specific identifiers and a connection name.

```Deluge
response = zoho.webinar.getWebinarById(99031443, 1080779662, 640967000000110006, "webinar");
```

--------------------------------

### Update User Example

Source: https://www.zoho.com/deluge/help/directory/update-user.html

Example script demonstrating how to prepare user data and execute the update task.

```Deluge
userData = Map();
userData.put("gender", "M");
userData.put("designation_id", "48XXXXXX");
userData.put("language_code", "en");
response = zoho.directory.updateUser(72XXXXXXX, 1510XXXXXXX, userData, "zoho_directory_connection")
```

--------------------------------

### Portal ID example

Source: https://www.zoho.com/deluge/help/webinar/create-webinar.html

Example of a unique portal identifier.

```Deluge
"9903xxxx"
```

--------------------------------

### Worksheet Name Example

Source: https://www.zoho.com/deluge/help/sheet/get-records.html

Example of a worksheet name string.

```Deluge
"Sheet1"
```

--------------------------------

### Create a webinar with details

Source: https://www.zoho.com/deluge/help/webinar/create-webinar.html

Example script demonstrating how to construct a map of webinar details and execute the creation task.

```Deluge
webinarjson = Map();
webinarjson.put("topic", "deluge webinar");
webinarjson.put("agenda", "The webinar about the deluge function");
webinarjson.put("presenter", 675xxxx);
webinarjson.put("startTime", "Jun 19, 2026 04:00 PM");
webinarjson.put("duration", 3600000);
webinarjson.put("timezone", "Asia/Calcutta");
response = zoho.webinar.createWebinar(9903xxxx, webinarjson, "webinar");
```

--------------------------------

### Resource ID Example

Source: https://www.zoho.com/deluge/help/sheet/get-records.html

Example of a resource ID string.

```Deluge
"eev4nXXXXXXXXXXXXXXXXXXXXXXXXXXXcff41"
```

--------------------------------

### Module name example

Source: https://www.zoho.com/deluge/help/projects/create.html

Example of a module name string.

```Deluge
"tasks"
```

--------------------------------

### Example of creating a folder

Source: https://www.zoho.com/deluge/help/workdrive/create-folder.html

A practical example showing how to create a subfolder within a specific parent directory using an OAuth connection.

```Deluge
response = zoho.workdrive.createFolder("Subfolder", "o5cfkXXXXXXXXXXXXXXXXXXXXXXXXXXX7e30c", "workdrive_oauth_connection");
```

--------------------------------

### Parameter examples

Source: https://www.zoho.com/deluge/help/workdrive/create-folder.html

Individual components used in the folder creation task.

```Deluge
response
```

```Deluge
"Subfolder"
```

```Deluge
"o5cfkXXXXXXXXXXXXXXXXXXXXXXXXXXX7e30c"
```

```Deluge
"workdrive_oauth_connection"
```

--------------------------------

### Project ID example

Source: https://www.zoho.com/deluge/help/projects/create.html

Example of a project ID number.

```Deluge
548XXXXXXXXXXX771
```

--------------------------------

### Portal name example

Source: https://www.zoho.com/deluge/help/projects/create.html

Example of a portal name string.

```Deluge
"zylker"
```

--------------------------------

### Record ID Example

Source: https://www.zoho.com/deluge/help/fsm/update-transitions.html

Example of a record ID string.

```Deluge
23033XXXXXXXXXXXXXX
```

--------------------------------

### Parameter Examples

Source: https://www.zoho.com/deluge/help/writer/sign-documents.html

Individual variable examples used in the signDocument task.

```Deluge
response
```

```Deluge
"3z7frc3fda95142ef45fbb9aadf220632b1d6"
```

```Deluge
"zohosign"
```

```Deluge
email
```

```Deluge
"Signed Document"
```

```Deluge
inputMap
```

```Deluge
"action_type"
```

--------------------------------

### Example usage of getRecordingsByKey

Source: https://www.zoho.com/deluge/help/webinar/get-recordings-by-webinar-key.html

A practical example showing how to call the task with specific portal and webinar identifiers.

```Deluge
response = zoho.webinar.getRecordingsByKey(99031443, 1080779662, "webinar");
```

--------------------------------

### Parameter examples

Source: https://www.zoho.com/deluge/help/recruit/search-records.html

Individual parameter examples used in the searchRecords task.

```Deluge
"Candidates"
```

```Deluge
"State|=|California"
```

```Deluge
1
```

```Deluge
3
```

```Deluge
"Last Name,Email"
```

--------------------------------

### Example: Create a New Team Folder

Source: https://www.zoho.com/deluge/help/workdrive/create-team-folder.html

A practical example demonstrating how to create a private team folder named 'Marketing' within a specific team.

```Deluge
response = zoho.workdrive.createTeamFolder("Marketing", "af0u7XXXXXXXXXXXXXXXXXXXXXXXXXXXee228", "This is a team folder", false, "workdrive_oauth_connection");
```

--------------------------------

### Connection Name Example

Source: https://www.zoho.com/deluge/help/fsm/update-transitions.html

Example of the connection link name string.

```Deluge
"fsm_connection"
```
Tokens:
Raw