# Zoho Desk Integration via LowCodeAPI

## Overview

Customer support

## Base Endpoint

```
https://api.lowcodeapi.com/zohodesk/
```

## Authentication

LowCodeAPI handles authentication automatically. You only need to:

1. **Sign up** at [Zoho Desk](https://www.zoho.com/desk/)
2. **Get your credentials** from [credential page](https://api-console.zoho.com/)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests

**Auth Type**: OAUTH2.0

## API Categories

- **Account Deduplication** - 4 endpoints
- **Account Followers** - 3 endpoints
- **Account TimeEntry** - 2 endpoints
- **Accounts** - 18 endpoints
- **Accounts / Account Contact Mapping** - 1 endpoints
- **Accounts Attachments** - 3 endpoints
- **Accounts Comments** - 5 endpoints
- **Active Timer** - 3 endpoints
- **Activities** - 2 endpoints
- **Agent** - 20 endpoints
- **Agent Signatures** - 3 endpoints
- **Agent TimeEntry** - 3 endpoints
- **Article Feedback** - 5 endpoints
- **Articles** - 28 endpoints
- **Articles Comments** - 5 endpoints
- **AutomationFeatureCount** - 1 endpoints
- **Badgification** - 19 endpoints
- **Blueprints** - 16 endpoints
- **BugTracker** - 1 endpoints
- **Businesshours** - 6 endpoints
- **Calls** - 10 endpoints
- **Calls Comments** - 5 endpoints
- **Channels** - 1 endpoints
- **Community** - 88 endpoints
- **Contact Deduplication** - 4 endpoints
- **Contact Followers** - 3 endpoints
- **Contact TimeEntry** - 2 endpoints
- **Contacts** - 27 endpoints
- **Contacts Attachments** - 3 endpoints
- **Contacts Comments** - 5 endpoints
- **Contracts** - 6 endpoints
- **Contracts Comments** - 5 endpoints
- **Customer Feedback** - 4 endpoints
- **Dashboards** - 8 endpoints
- **Data Sharing Rules** - 2 endpoints
- **Departments** - 15 endpoints
- **DependencyMappings** - 5 endpoints
- **Domain Mapping** - 5 endpoints
- **EmailTemplates** - 8 endpoints
- **Entity Followers** - 2 endpoints
- **Events** - 9 endpoints
- **Events Comments** - 5 endpoints
- **Finance** - 6 endpoints
- **Groups** - 8 endpoints
- **Help Center** - 3 endpoints
- **HolidayList** - 5 endpoints
- **Jira** - 1 endpoints
- **KBCategory** - 13 endpoints
- **Labels** - 9 endpoints
- **LayoutRules** - 6 endpoints
- **Layouts** - 17 endpoints
- **Locales** - 3 endpoints
- **MailConfigurations** - 4 endpoints
- **MailReplyAddress** - 6 endpoints
- **Modules** - 5 endpoints
- **Notification** - 3 endpoints
- **OrganizationFields** - 9 endpoints
- **Organizations** - 11 endpoints
- **Product Attachments** - 3 endpoints
- **Products** - 11 endpoints
- **Profiles** - 10 endpoints
- **Recycle Bin** - 5 endpoints
- **Roles** - 9 endpoints
- **RoutingPreference** - 2 endpoints
- **Search** - 10 endpoints
- **SkillConfiguration** - 2 endpoints
- **SkillTypes** - 5 endpoints
- **Skills** - 10 endpoints
- **Subject Access Requests** - 9 endpoints
- **SupportEmailAddress** - 5 endpoints
- **SupportEmailDomain** - 2 endpoints
- **Task TimeEntry** - 6 endpoints
- **Task Timer** - 2 endpoints
- **Tasks** - 10 endpoints
- **Tasks Attachments** - 3 endpoints
- **Tasks Comments** - 5 endpoints
- **Teams** - 10 endpoints
- **TemplateFolders** - 5 endpoints
- **Threads** - 10 endpoints
- **Ticket Approvals** - 4 endpoints
- **Ticket Attachments** - 4 endpoints
- **Ticket Count** - 2 endpoints
- **Ticket Followers** - 3 endpoints
- **Ticket Tags** - 9 endpoints
- **Ticket Templates** - 5 endpoints
- **Ticket TimeEntry** - 7 endpoints
- **Ticket Timer** - 2 endpoints
- **Tickets** - 28 endpoints
- **Tickets Comments** - 6 endpoints
- **Timetracking** - 4 endpoints
- **Uploads** - 1 endpoints
- **Users** - 13 endpoints
- **ValidationRules** - 6 endpoints
- **Views** - 7 endpoints
- **agentAvailability** - 5 endpoints

## Common Endpoints

### Category: Account Deduplication

#### List duplicate accounts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/groupaccountduplicatevalues`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groupaccountduplicatevalues?fieldName={fieldName}&from={from}&limit={limit}&swFieldValue={swFieldValue}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API lists the duplicate entries of an account

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`fieldName` | string | No | Name of the field whose values must be matched for deduplication. Values allowed are: email, phone, and accountName |
|`from` | number | No | Index number starting from which the accounts must be fetched. Default: 0 |
|`limit` | number | No | Number of accounts to fetch. Range: 1-100 |
|`swFieldValue` | string | No | Key that specifies the letter with which the field values must start. Max chars: 100 |
|`sortBy` | string | No | Key that sort the accounts by a specific attribute: count or fieldValue. Default sorting order is ascending. A - prefix denotes descending order of sorting |

---

#### List details of duplicate accounts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/groupaccounts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groupaccounts?fieldName={fieldName}&from={from}&limit={limit}&fieldValue={fieldValue}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API lists all the details of duplicate accounts

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`fieldName` | string | Yes | Name of the field whose values must be matched for deduplication. Values allowed are: email, phone, and accountName |
|`from` | number | No | Index number starting from which the accounts must be fetched. Default: 0 |
|`limit` | number | No | Number of accounts to fetch. Range: 1-100 |
|`fieldValue` | string | Yes | Actual values in each field related to the account |
|`sortBy` | string | No | Key that sort the accounts by a specific attribute: count or fieldValue. Default sorting order is ascending. A - prefix denotes descending order of sorting |

---

#### Get Default Field Name

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accountsdeduplication/defaultfieldname`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accountsdeduplication/defaultfieldname?api_token={api_token}
```

**Description**: This API fetches the name of the field set as the default field for account deduplication

---

#### Set default field for account deduplication

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/accountsdeduplication/defaultfieldname`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accountsdeduplication/defaultfieldname?api_token={api_token}
```

**Description**: This API sets the field you specify as the default field for deduplicating accounts

**Request Body**:
```json
{
  "fieldName": "<string>",
  "markDefault": "<boolean>"
}
```

---

### Category: Account Followers

#### Add account followers

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/accounts/account_id/addfollowers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/addfollowers?api_token={api_token}
```

**Description**: This API adds one or more users to the followers list of an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Request Body**:
```json
{
  "followerIds": "<array>"
}
```

---

#### Remove account followers

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/accounts/account_id/removefollowers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/removefollowers?api_token={api_token}
```

**Description**: This API removes one or more users from the followers list of an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Request Body**:
```json
{
  "followerIds": "<array>"
}
```

---

#### Get account followers

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/accounts/account_id/followers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/followers?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches the list of users following an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the followers must be fetched |
|`limit` | number | No | Number of followers to list. Range: 1-100 |

---

### Category: Account TimeEntry

#### List Account Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/timeentry`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/timeentry?module={module}&departmentId={departmentId}&from={from}&limit={limit}&orderBy={orderBy}&include={include}&billStatus={billStatus}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&api_token={api_token}
```

**Description**: This API lists time entries recorded for a ticket or task related to an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module from which the time entries must be fetched. Values allowed are tickets and tasks. Max chars: 100 |
|`departmentId` | number | No | ID of the department |
|`from` | number | No | Index number, starting from which the time entries must be fetched |
|`limit` | number | No | Number of time entries to fetch. Range: 1-100 |
|`orderBy` | string | No | Key that sorts the time entries in ascending or descending order, based on the executedTime attribute |
|`include` | string | No | Secondary information related to the time entry. Value supported is owner. Max chars: 100 |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |
|`createdTimeRange` | string | No | Key that filters time entries created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters time entries whose details were modified in a particular period of time |

---

#### Get summation of Account Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/timeentrysummation`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/timeentrysummation?module={module}&departmentId={departmentId}&billStatus={billStatus}&api_token={api_token}
```

**Description**: This API fetches summation of time entries for an account from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module Preference. It can be either tickets or tasks. Max chars: 100 |
|`departmentId` | number | No | ID of the department |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |

---

### Category: Accounts

#### Get Account

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/account_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id?include={include}&api_token={api_token}
```

**Description**: This API fetches an account from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Allowed values are : owner |

---

#### List accounts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts?from={from}&limit={limit}&viewId={viewId}&sortBy={sortBy}&fields={fields}&api_token={api_token}
```

**Description**: This API lists a particular number of accounts, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the accounts must be listed |
|`limit` | number | No | Number of accounts to fetch |
|`viewId` | number | No | ID of the view to apply while fetching the resources |
|`sortBy` | string | No | Sort by a specific attribute: accountName or createdTime |
|`fields` | string | No | Key that returns the values of mentioned fields (both pre-defined and custom) in your portal |

---

#### Create Account

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/accounts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts?api_token={api_token}
```

**Description**: This API creates an account in your help desk portal

**Request Body**:
```json
{
  "accountName": "<string>"
}
```

---

#### Update Account

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/accounts/account_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id?api_token={api_token}
```

**Description**: This API updates details of an existing account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Accounts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/accounts/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/movetotrash?api_token={api_token}
```

**Description**: This API moves the accounts specified to the Recycle Bin

**Request Body**:
```json
{
  "accountIds": "<array>"
}
```

---

#### Get contract

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/contracts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/contracts?from={from}&limit={limit}&departmentId={departmentId}&contractStatus={contractStatus}&api_token={api_token}
```

**Description**: Getting contracts of an Account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index,DEFAULT 1 |
|`limit` | number | No | Number of contracts to fetch, Ranges from 1-50, DEFAULT 50 |
|`departmentId` | number | No | ID of the department from which the contracts must be fetched |
|`contractStatus` | string | No | Contract Status,Indicates the Current Status of the Contract, Values are ACTIVE, EXPIRED, FUTURE |

---

#### List all contracts count

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contracts/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/count?viewId={viewId}&departmentId={departmentId}&ownerId={ownerId}&api_token={api_token}
```

**Description**: This API lists the number of contracts made with the account

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`viewId` | number | Yes | Custom view Id |
|`departmentId` | string | Yes | Mandatory param to fetch the count of the contracts for a given ID of a department |
|`ownerId` | number | No | Displays the number of contracts of only a particular owner |

---

#### List all accounts count

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/accounts/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/count?viewId={viewId}&startsWith={startsWith}&api_token={api_token}
```

**Description**: Get accounts count

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`viewId` | number | Yes | Custom view Id |
|`startsWith` | string | No | Displays the number of accounts whose first name or last name begins with the letter you specify |

---

#### List Associated contacts

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/accounts/accounts_id/contacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/accounts_id/contacts?from={from}&limit={limit}&sortBy={sortBy}&isSpam={isSpam}&api_token={api_token}
```

**Description**: This API lists the contacts associated with an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index |
|`limit` | number | No | No. of contacts to fetch |
|`sortBy` | string | No | Parameter that sorts contacts by one of these attributes |
|`isSpam` | boolean | No | Filters Spam contacts |

---

#### List tickets by account

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/tickets?departmentId={departmentId}&from={from}&limit={limit}&sortBy={sortBy}&dueDate={dueDate}&isSpam={isSpam}&include={include}&api_token={api_token}
```

**Description**: This API lists tickets received from a specific account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department from which the tickets must be fetched |
|`from` | number | No | Index number, starting from which the tickets must be fetched |
|`limit` | number | No | Number of tickets to fetch |
|`sortBy` | string | No | Sort by a specific attribute: createdTime or modifiedTime |
|`dueDate` | string | No | Filter by ticket duedate. Values allowed are overdue, tomorrow, currentWeek, currentMonth and today |
|`isSpam` | boolean | No | Filters Spam tickets |
|`include` | string | No | Additional information related to the tickets |

---

#### List products by account

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/products`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/products?from={from}&limit={limit}&departmentId={departmentId}&api_token={api_token}
```

**Description**: This API lists products associated for a specific account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index |
|`limit` | number | No | Number of products to fetch |
|`departmentId` | number | No | Department from which the products need to be queried |

---

#### Merge Accounts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/merge`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/merge?api_token={api_token}
```

**Description**: This API merges two or more accounts

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Associate products with an account

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/accounts/account_id/associateproducts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/associateproducts?api_token={api_token}
```

**Description**: This API associates products with an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Request Body**:
```json
{
  "ids": "<array>",
  "associate": "<boolean>"
}
```

---

#### Update many accounts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/accounts/updatemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/updatemany?api_token={api_token}
```

**Description**: This API updates multiple accounts at once

**Request Body**:
```json
{
  "ids": "<array>",
  "fieldName": "<string>"
}
```

---

#### Get account history

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/accounts/account_id/history`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/history?departmentId={departmentId}&agentId={agentId}&contactId={contactId}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches the ticket history of an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department from which the history details must be fetched |
|`agentId` | number | No | Key that filters ticket activities performed by a particular agent |
|`contactId` | number | No | Key that filters ticket activities related to a particular contact |
|`from` | number | No | Index number starting from which the history details must be fetched |
|`limit` | number | No | Number of history details to fetch range : 1-100 |

---

*Note: Showing 15 of 18 endpoints in this category.*

---

### Category: Accounts / Account Contact Mapping

#### Update association info

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/accountcontactmapping/mapping_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accountcontactmapping/mapping_id?api_token={api_token}
```

**Description**: This API updates the details of an account-contact mapping

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`mapping_id` | string | Yes | Mapping ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: Accounts Attachments

#### List Account attachments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/attachments?sortBy={sortBy}&from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: This API lists the files attached to an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sortBy` | string | No | Sort by the createdTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`from` | number | No | Index number, starting from which the attachments must be fetched |
|`limit` | number | No | Number of attachments to fetch. Range: 1-100 |
|`include` | string | No | Secondary information related to the attachments. Value allowed is creator, which returns the details of users who added the attachments |

---

#### Create Account attachment

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/attachments?api_token={api_token}
```

**Description**: This API attaches a file to an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Account attachment

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/accounts/account_id/attachments/attachment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/account_id/attachments/attachment_id?api_token={api_token}
```

**Description**: This API deletes an attachment from a account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |
|`attachment_id` | string | Yes | Attachment ID |

---

### Category: Accounts Comments

#### Create an account comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/accounts/account_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/comments?api_token={api_token}
```

**Description**: This API adds a comment to an account

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update an account comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/accounts/account_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/comments/comment_id?api_token={api_token}
```

**Description**: This API updates an existing account comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |
|`comment_id` | string | Yes | Comment ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete an account comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/accounts/account_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes an existing account comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |
|`comment_id` | string | Yes | Comment ID |

---

#### Get an account comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/accounts/account_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/comments/comment_id?include={include}&api_token={api_token}
```

**Description**: This API fetches an account comment from the portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |
|`comment_id` | string | Yes | Comment ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the comments |

---

#### List all account comments

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/accounts/account_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/accounts/account_id/comments?from={from}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on an account, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`account_id` | string | Yes | Account ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the comments must be fetched |
|`limit` | number | Yes | No. of comments to fetch |
|`sortBy` | string | No | Sort comments by the commentedTime attribute |
|`include` | string | No | Secondary information related to the comments |

---

### Category: Active Timer

#### Get Active Timer for an Agent

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/myactivetimers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/myactivetimers?departmentId={departmentId}&limit={limit}&from={from}&api_token={api_token}
```

**Description**: This API fetches currently running timer details for an agent

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | Department to which the ticket belongs |
|`limit` | number | No | Limit |
|`from` | number | No | From |

---

#### List ticket timers

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/activetimer`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/activetimer?from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: This API fetches the details of timers currently active in a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the timers must be fetched |
|`limit` | number | No | Number of timers to fetch. Range: 1-100 |
|`include` | string | No | Secondary information related to the timers. Value supported is owner. Max chars: 100 |

---

#### List task timers

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/activetimer`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/activetimer?from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: This API fetches the details of timers currently active in a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the timers must be fetched |
|`limit` | number | No | Number of timers to fetch. Range: 1-100 |
|`include` | string | No | Secondary information related to the timers. Value supported is owner. Max chars: 100 |

---

### Category: Activities

#### List ticket activities

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/activities`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/activities?from={from}&isCompleted={isCompleted}&isSpam={isSpam}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of activities associated with a ticket, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the activities must be listed |
|`isCompleted` | boolean | No | Key that denotes if the activity was completed or not |
|`isSpam` | boolean | No | Key that denotes whether to fetch spam activities or not |
|`limit` | number | No | Number of activities to list. Range: 1-100 |
|`sortBy` | string | No | Sort by a specific attribute: activityTime or createdTime. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`include` | string | No | Allowed values are: contacts, assignee, tickets, teams, projects, integInfon |

---

#### Delete spam activities

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/activities/emptyspam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/activities/emptyspam?api_token={api_token}
```

**Description**: This API deletes all spam activities

**Request Body**:
```json
{
  "departmentId": "<number>"
}
```

---

### Category: Agent

#### Get agent

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id?include={include}&api_token={api_token}
```

**Description**: This API fetches details of an agent in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the agent |

---

#### List agents

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents?from={from}&limit={limit}&status={status}&departmentIds={departmentIds}&profileIds={profileIds}&roleIds={roleIds}&rolePermissionType={rolePermissionType}&isConfirmed={isConfirmed}&isLightAgent={isLightAgent}&include={include}&searchStr={searchStr}&fieldName={fieldName}&sortOrder={sortOrder}&api_token={api_token}
```

**Description**: This API lists a particular number of agents, based on the limit specified.

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the agents must be fetched |
|`limit` | number | No | Number of agents to fetch |
|`status` | string | No | Key that filters agents based on their activation status: ACTIVE, DISABLED, DELETED or IMPORTED |
|`departmentIds` | number | No | Comma-separated array of department IDs |
|`profileIds` | number | No | Comma-separated array of profile IDs |
|`roleIds` | number | No | Comma-separated array of role IDst |
|`rolePermissionType` | string | No | Types of roles and permissions of the agents to list |
|`isConfirmed` | boolean | No | Key that denotes if the agents must be confirmed or unconfirmed |
|`isLightAgent` | boolean | No | Key that denotes if the agents must be light or non light |
|`include` | string | No | Secondary information related to agents, Values allowed are profile, role |
|`searchStr` | string | No | String to search for agents by first name, last name, or email ID |
|`fieldName` | string | No | Name of the field that must be used for searching and listing agents |
|`sortOrder` | string | No | To sort the available list of agents in either ascending or descending order |

---

#### Get agents count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/count?status={status}&isConfirmed={isConfirmed}&includeLightAgent={includeLightAgent}&api_token={api_token}
```

**Description**: This API lists the agents count by status, confirmed and include light

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`status` | string | No | Parameter that filters agents based on their activation status: ACTIVE or DISABLED |
|`isConfirmed` | boolean | No | Filters Confirmed & Unconfirmed agents |
|`includeLightAgent` | boolean | No | Count light agent |

---

#### Get agent details by agentId

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agentsbyids`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agentsbyids?agentIds={agentIds}&api_token={api_token}
```

**Description**: This API fetches details of agents via the agent IDs passed in the API request

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_ids` | string | Yes | Agent IDs |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agentIds` | number | Yes | Comma-separated array of agent IDs |

---

#### Get My Information

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/myinfo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/myinfo?include={include}&api_token={api_token}
```

**Description**: This API fetches details of the currently logged in agent

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the agent |

---

#### Activate agents

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents/activate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/activate?api_token={api_token}
```

**Description**: This API activates agents in your help desk

**Request Body**:
```json
{
  "agent_ids": "<array>"
}
```

---

#### Deactivate agent

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/deactivate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/deactivate?api_token={api_token}
```

**Description**: This API deactivates an agent in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

---

#### Reinvite unconfirmed agents

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents/reinvite`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/reinvite?api_token={api_token}
```

**Description**: This API sends reinvitation mails to unconfirmed agents

**Request Body**:
```json
{
  "agent_ids": "<array>"
}
```

---

#### Add agent

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents?api_token={api_token}
```

**Description**: This API adds an agent to your help desk

**Request Body**:
```json
{
  "emailId": "<string>",
  "lastName": "<string>",
  "associatedDepartmentIds": "<array>",
  "rolePermissionType": "<string>"
}
```

---

#### Update agent

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/agents/agent_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id?api_token={api_token}
```

**Description**: This API updates details of an agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete unconfirmed agents

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents/deleteunconfirmed`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/deleteunconfirmed?api_token={api_token}
```

**Description**: This API deletes unconfirmed agents from your help desk

**Request Body**:
```json
{
  "agent_ids": "<array>"
}
```

---

#### Delete confirmed agent

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/delete`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/delete?api_token={api_token}
```

**Description**: This API deletes a confirmed agent from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Anonymize deleted agent

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/deletedagents/agent_id/anonymize`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/deletedagents/agent_id/anonymize?api_token={api_token}
```

**Description**: This API removes the identification details of a deleted agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Upload my photo

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/uploadmyphoto`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/uploadmyphoto?api_token={api_token}
```

**Description**: This API sets the profile photo for the currently logged in agent

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get agent photo

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/photo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/photo?fileSize={fileSize}&api_token={api_token}
```

**Description**: This API gets the profile photo for the given agent id

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`fileSize` | string | No | Size of the image file to download |

---

*Note: Showing 15 of 20 endpoints in this category.*

---

### Category: Agent Signatures

#### Get signatures of agent

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/signatures`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/signatures?api_token={api_token}
```

**Description**: This API fetches the different signatures configured by an agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

---

#### Update signatures of agent

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/signatures`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/signatures?api_token={api_token}
```

**Description**: This API updates the existing signatures of an agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update customized signatures of agent

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/updatecustomizedsignature`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/updatecustomizedsignature?api_token={api_token}
```

**Description**: This API updates the customized signatures of an agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Request Body**:
```json
{
  "departmentId": "<number>",
  "signature": "<string>"
}
```

---

### Category: Agent TimeEntry

#### Get an Agent Time Entry

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/timeentry/timeentry_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/timeentry/timeentry_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a time entry related to an agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |
|`timeEntry_id` | string | Yes | Time Entry ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the time entry. Value supported is owner |

---

#### List Agent Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/timeentry`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/timeentry?module={module}&departmentId={departmentId}&from={from}&limit={limit}&orderBy={orderBy}&include={include}&billStatus={billStatus}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&api_token={api_token}
```

**Description**: This API lists the time entries associated with an agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module from which the time entries must be fetched. Values allowed are tickets and tasks |
|`departmentId` | number | No | ID of the department |
|`from` | number | No | Index number, starting from which the time entries must be fetched |
|`limit` | number | No | Number of time entries to fetch. Range: 1-100 |
|`orderBy` | string | No | Key that sorts the time entries in ascending or descending order, based on the executedTime attribute. Values allowed are ASC (default) and DESC |
|`include` | string | No | Secondary information related to the time entry. Value supported is owner. Max chars: 100 |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |
|`createdTimeRange` | string | No | Key that filters time entries created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ |
|`modifiedTimeRange` | string | No | Key that filters time entries whose details were modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ |

---

#### Get summation of Agent Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/timeentrysummation`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/timeentrysummation?module={module}&departmentId={departmentId}&billStatus={billStatus}&api_token={api_token}
```

**Description**: This API fetches the sum of time entries associated with an agent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module Preference. It can be either tickets or tasks |
|`departmentId` | number | No | ID of the department |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |

---

### Category: Article Feedback

#### List feedback comments on article translation

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articles/article_id/translations/locale/feedbacks`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/article_id/translations/locale/feedbacks?from={from}&limit={limit}&sortBy={sortBy}&createdTimeRange={createdTimeRange}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of comments received on a translation of an article, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`article_id` | string | Yes | Article ID |
|`locale` | string | Yes | Locale |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the comments must be fetched |
|`limit` | number | No | Number of comments to list |
|`sortBy` | string | No | Key that sorts the comments based on a specific attribute: createdTime |
|`createdTimeRange` | string | No | Key that filters comments created within a specific date and time range |
|`include` | string | No | Additional information related to the comments |

---

#### Get details of feedback comment

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articlefeedbacks/feedback_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articlefeedbacks/feedback_id?include={include}&api_token={api_token}
```

**Description**: This API fetches the details of a particular feedback comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`feedback_id` | string | Yes | Feedback ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the comment |

---

#### List feedback comments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articlefeedbacks`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articlefeedbacks?from={from}&limit={limit}&sortBy={sortBy}&include={include}&departmentIds={departmentIds}&rootCategoryIds={rootCategoryIds}&timeRange={timeRange}&locale={locale}&api_token={api_token}
```

**Description**: This API lists a particular number of comments received on an article, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the comments must be fetched |
|`limit` | number | No | Number of comments to list |
|`sortBy` | string | No | Key that sorts the comments based on a specific attribute: createdTime |
|`include` | string | No | Additional information related to the comments |
|`departmentIds` | string | No | Filter article feedback comments based on department ids |
|`rootCategoryIds` | string | No | Filter article feedback comments based on rootCategoryIds |
|`timeRange` | string | No | Key that filters comments created within a specific date and time range |
|`locale` | string | No | Locale of an article translation in which feedback comments to be fetched |

---

#### Delete feedback comment

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/articlefeedbacks/feedback_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articlefeedbacks/feedback_id?api_token={api_token}
```

**Description**: This API deletes a particular feedback comment from an article

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`feedback_id` | string | Yes | Feedback ID |

---

#### Convert feedback comment into ticket

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/articlefeedbacks/feedback_id/addasticket`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articlefeedbacks/feedback_id/addasticket?api_token={api_token}
```

**Description**: This API adds a feedback comment as a ticket in your help desk portal and assigns it to the author of the article

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`feedback_id` | string | Yes | Feedback ID |

---

### Category: Articles

#### List articles

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles?from={from}&limit={limit}&sortBy={sortBy}&permission={permission}&authorId={authorId}&categoryId={categoryId}&modifiedTimeRange={modifiedTimeRange}&expiryTimeRange={expiryTimeRange}&status={status}&api_token={api_token}
```

**Description**: This API fetches a specific number of articles from your knowledge base, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the articles must be fetched |
|`limit` | number | No | Number of articles to fetch |
|`sortBy` | string | No | Key that sorts the articles based on a specific attribute |
|`permission` | string | No | Access permission for the article |
|`authorId` | number | No | ID of article owner |
|`categoryId` | number | No | ID of the category to which the article belongs |
|`modifiedTimeRange` | string | No | Key that filters articles modified within a specific date and time range |
|`expiryTimeRange` | string | No | Key that filters articles which will expire within a specific date and time range |
|`status` | string | No | Publishing status of the article |

---

#### Get article

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articles/article_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/article_id?version={version}&api_token={api_token}
```

**Description**: This API fetches an article from your knowledge base

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`article_id` | string | Yes | Article ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`version` | string | No | Version number of the article |

---

#### Create an article

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/articles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles?api_token={api_token}
```

**Description**: This API creates an article in your helpdesk

**Request Body**:
```json
{
  "categoryId": "<number>",
  "title": "<string>",
  "answer": "<string>",
  "status": "<string>",
  "permission": "<string>"
}
```

---

#### Update an article

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/articles/article_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/article_id?api_token={api_token}
```

**Description**: This API updates an existing article

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`article_id` | string | Yes | Article ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Validate permalink

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/articles/checkpermalinkavailability`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/checkpermalinkavailability?api_token={api_token}
```

**Description**: This API validates if a permalink is available for a help article

**Request Body**:
```json
{
  "permalink": "<string>"
}
```

---

#### Get article history

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articles/article_id/history`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/article_id/history?from={from}&limit={limit}&events={events}&userIds={userIds}&fromTime={fromTime}&toTime={toTime}&api_token={api_token}
```

**Description**: This API fetches the event history of an article

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`article_id` | string | Yes | Article ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | From index |
|`limit` | number | Yes | Number of records to fetch |
|`events` | string | No | Actions happened on the article |
|`userIds` | number | No | User who did the action |
|`fromTime` | string | No | From time |
|`toTime` | string | No | To time |

---

#### Upload attachments

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/articleattachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articleattachments?api_token={api_token}
```

**Description**: This API uploads files to your portal gallery

**Request Body**:
```json
{
  "workspaceId": "<string>",
  "attachmentType": "<string>"
}
```

---

#### Move articles to trash

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/articles/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/movetotrash?api_token={api_token}
```

**Description**: This API moves articles to the Recycle Bin

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Preview article

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/articles/preview`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/preview?api_token={api_token}
```

**Description**: This API shows a preview of help articles, through which you can check the content for formatting, alignment, and grammar/spelling errors and get the look and feel of the help article even before publishing it

**Request Body**:
```json
{
  "title": "<string>",
  "answer": "<string>"
}
```

---

#### Get article count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articles/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/count?categoryId={categoryId}&authorId={authorId}&status={status}&permission={permission}&api_token={api_token}
```

**Description**: This API returns the number of articles published in the knowledge base of your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`categoryId` | number | No | Article count for given category |
|`authorId` | number | No | Article count for the particular author |
|`status` | string | No | Publishing status of the article to get count |
|`permission` | string | No | Permissions to get the article count |

---

#### Map articles to tickets

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/notifyarticleusage`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/notifyarticleusage?api_token={api_token}
```

**Description**: This API maps tickets with help articles to automatically suggest the same articles for similar tickets that arrive later

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Get articles for manual sorting

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/kbcategory/category_id/repositionarticles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbcategory/category_id/repositionarticles?api_token={api_token}
```

**Description**: This API lists the positions of help articles to enable manual sorting

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category_id` | string | Yes | Category ID |

---

#### Update article position

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbcategory/category_id/repositionarticles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbcategory/category_id/repositionarticles?api_token={api_token}
```

**Description**: This API helps you manually sort articles in your knowledge base

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category_id` | string | Yes | Category ID |

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Add translation

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/articles/articleid/translations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/articleid/translations?api_token={api_token}
```

**Description**: This API adds a translated version of an article

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`articleId` | string | Yes | Article ID |

**Request Body**:
```json
{
  "title": "<string>",
  "answer": "<string>",
  "status": "<string>",
  "permission": "<string>",
  "locale": "<string>",
  "authorId": "<number>",
  "translationState": "<string>"
}
```

---

#### Edit translation

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/articles/articleid/translations/locale`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/articleid/translations/locale?api_token={api_token}
```

**Description**: This API edits an already translated article

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`articleId` | string | Yes | Article ID |
|`locale` | string | Yes | Locale |

**Request Body**:
```json
{
  "key": "value"
}
```

---

*Note: Showing 15 of 28 endpoints in this category.*

---

### Category: Articles Comments

#### Create a translation comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/articles/article_id/translations/locale/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/articles/article_id/translations/locale/comments?api_token={api_token}
```

**Description**: This API adds a comment to an article translation

---

#### Update a translation comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/articles/article_id/translations/locale/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/articles/article_id/translations/locale/comments/comment_id?api_token={api_token}
```

**Description**: This API updates an existing article translation comment

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a translation comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/articles/article_id/translations/locale/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/articles/article_id/translations/locale/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes an existing article translation comment

---

#### Get a article translation comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/articles/article_id/translations/locale/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/articles/article_id/translations/locale/comments/comment_id?api_token={api_token}
```

**Description**: This API fetches an article translation comment from the portal

---

#### List all translation comments

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/articles/article_id/translations/locale/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/articles/article_id/translations/locale/comments?api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on an article translation, based on the limit specified

---

### Category: AutomationFeatureCount

#### Get Automation Feature Count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/automationfeaturecount`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/automationfeaturecount?departmentId={departmentId}&module={module}&feature={feature}&api_token={api_token}
```

**Description**: This API is used to Get Automation Feature Limits

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | Department Id |
|`module` | string | No | Module, allowed values tickets,contacts,contracts,accounts,tasks,products,timeEntry,events,calls,customModule |
|`feature` | string | Yes | Feature, allowed values businesshours,holidaylist,Skills,SkillType,workflows,blueprints,automationAlerts,fieldUpdates,automationTasks,customFunctions |

---

### Category: Badgification

#### List badges

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/badges`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/badges?from={from}&limit={limit}&type={type}&api_token={api_token}
```

**Description**: This API lists a particular number of default and custom badges, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | Index number starting from which the badges must be listed |
|`limit` | number | Yes | Number of badges to list |
|`type` | string | No | Type of badge: default or custom |

---

#### Add badge

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/badges`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/badges?api_token={api_token}
```

**Description**: This API adds a badge to your user community

**Request Body**:
```json
{
  "name": "<string>",
  "isCustom": "<boolean>"
}
```

---

#### Update badge

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v1/badges/value`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/badges/value?api_token={api_token}
```

**Description**: This API updates the details of a badge

**Request Body**:
```json
{
  "name": "<string>"
}
```

---

#### Delete badge

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/badges/value`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/badges/value?api_token={api_token}
```

**Description**: This API deletes a badge from the user community

---

#### List levels

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/levels`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/levels?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of levels, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | Index number, starting from which the levels must be listed |
|`limit` | number | Yes | Number of limits to list |

---

#### Add level

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/levels`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/levels?api_token={api_token}
```

**Description**: This API adds a level to the user community

**Request Body**:
```json
{
  "name": "<string>",
  "pointsToReach": "<number>"
}
```

---

#### Update level

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v1/levels/value`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/levels/value?api_token={api_token}
```

**Description**: This API updates the details of a level

**Request Body**:
```json
{
  "name": "<string>",
  "pointsToReach": "<number>"
}
```

---

#### Delete level

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/levels/value`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/levels/value?api_token={api_token}
```

**Description**: This API deletes a level from the user community

---

#### List creditworthy activities

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/credits`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/credits?from={from}&limit={limit}&type={type}&api_token={api_token}
```

**Description**: This API lists a particular number of creditworthy activities, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | Index number, starting from which the activities must be listed |
|`limit` | number | Yes | Number of activities to list |
|`type` | string | No | Type of creditworthy activity: default or custom |

---

#### Add creditworthy activity

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/credits`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/credits?api_token={api_token}
```

**Description**: This API adds a creditworthy activity to the user community

**Request Body**:
```json
{
  "name": "<string>",
  "points": "<number>"
}
```

---

#### Update creditworthy activity

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v1/credits/value`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/credits/value?api_token={api_token}
```

**Description**: This API updates a creditworthy activity

**Request Body**:
```json
{
  "name": "<string>",
  "points": "<number>"
}
```

---

#### Delete creditworthy activity

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/credits/value`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/credits/value?api_token={api_token}
```

**Description**: This API deletes a creditworthy activity from the user community

---

#### List credit holders

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/credits/value/users`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/credits/value/users?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of users with credits, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | Index number, starting from which the users must be listed |
|`limit` | number | Yes | Number of users to list |

---

#### Add credit holders

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/credits/value/associateusers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/credits/value/associateusers?api_token={api_token}
```

**Description**: This API adds the users specified in the request to the credit holders list

**Request Body**:
```json
{
  "userIds": "<array>"
}
```

---

#### Remove credit holders

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/credits/value/dissociateusers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/credits/value/dissociateusers?api_token={api_token}
```

**Description**: This API removes users from the custom holders list

**Request Body**:
```json
{
  "userIds": "<array>"
}
```

---

*Note: Showing 15 of 19 endpoints in this category.*

---

### Category: Blueprints

#### Get Blueprint Details

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/blueprints/blueprint_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/blueprints/blueprint_id?api_token={api_token}
```

**Description**: To get a specific blueprint details

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`blueprint_id` | string | Yes | Blueprint ID |

---

#### List all blueprints in a department

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/blueprints`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/blueprints?departmentId={departmentId}&module={module}&status={status}&api_token={api_token}
```

**Description**: To get all blueprints in a specific department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | Department for which the blueprints are listed |
|`module` | string | Yes | Module of the blueprints to be listed |
|`status` | string | No | To get blueprints by status, allowed values are ACTIVE ,INACTIVE and DRAFT |

---

#### Create Blueprint

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/blueprints`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/blueprints?api_token={api_token}
```

**Description**: To create a blueprint

**Request Body**:
```json
{
  "name": "<string>",
  "module": "<string>",
  "departmentId": "<number>",
  "layoutId": "<number>",
  "type": "<string>",
  "fieldId": "<number>",
  "chartData": "<object>",
  "states": "<array>",
  "transitions": "<array>",
  "connections": "<array>"
}
```

---

#### Update a blueprint

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/blueprints/blueprint_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/blueprints/blueprint_id?api_token={api_token}
```

**Description**: To update an existing blueprint

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`blueprint_id` | string | Yes | Blueprint ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Blueprint

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/blueprints/blueprint_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/blueprints/blueprint_id?api_token={api_token}
```

**Description**: To delete a specific blueprint

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`blueprint_id` | string | Yes | Blueprint ID |

---

#### Reorder blueprints

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/blueprints/reorder`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/blueprints/reorder?api_token={api_token}
```

**Description**: To reorder blueprints in a specific department

**Request Body**:
```json
{
  "departmentId": "<number>",
  "module": "<string>",
  "ids": "<array>"
}
```

---

#### Get Applied Blueprint details of ticket for an user

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/blueprint`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/blueprint?include={include}&api_token={api_token}
```

**Description**: To get the applied blueprint details of a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Meta information related to the transition owners |

---

#### Get During transition form

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/transitions/transitionid/form`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/transitions/transitionid/form?api_token={api_token}
```

**Description**: To get During transition form details for the given transition

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`transitionId` | string | Yes | Transition ID |

---

#### Revoke Blueprint at Entity Level

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/revokeblueprint`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/revokeblueprint?api_token={api_token}
```

**Description**: To revoke blueprint from an entity

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

#### Revoke Blueprint from Blueprint Level

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/blueprints/value/revoke`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/blueprints/value/revoke?api_token={api_token}
```

**Description**: To revoke all entities from a particular blueprint

---

#### Validate transition field updates

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/transitions/transitionid/validatefieldupdates`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/transitions/transitionid/validatefieldupdates?api_token={api_token}
```

**Description**: To validate field updates for the given transition

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`transitionId` | string | Yes | Transition ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Perform transition

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/transitions/transitionid/perform`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/transitions/transitionid/perform?api_token={api_token}
```

**Description**: To perform transition for an entity

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`transitionId` | string | Yes | Transition ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete the during actions transition draft

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/transitions/transitionid/discarddraft`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/transitions/transitionid/discarddraft?api_token={api_token}
```

**Description**: To delete the during actions transition draft

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`transitionId` | string | Yes | Transition ID |

---

#### Save the during actions transition draft

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/transitions/transitionid/savedraft`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/transitions/transitionid/savedraft?api_token={api_token}
```

**Description**: To save the during actions transition draft

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`transitionId` | string | Yes | Transition ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get attachment of a transition draft

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/transitions/transitionid/attachments/attachmentid/content`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/transitions/transitionid/attachments/attachmentid/content?inline={inline}&api_token={api_token}
```

**Description**: View a specific attachment added to a transition draft

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`transitionId` | string | Yes | Transition ID |
|`attachmentId` | string | Yes | Attachment ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`inline` | boolean | No | Whether the display is to be inline |

---

*Note: Showing 15 of 16 endpoints in this category.*

---

### Category: BugTracker

#### Get Linked Tickets by Bug Id

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/bug/bugid/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/bug/bugid/tickets?api_token={api_token}
```

**Description**: This API fetches support tickets associated with the Bug Id specified in the API request

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`bugId` | string | Yes | Bug ID |

---

### Category: Businesshours

#### Create business hours set

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/businesshours`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/businesshours?api_token={api_token}
```

**Description**: This API creates a business hours set in your help desk portal

**Request Body**:
```json
{
  "name": "<string>",
  "status": "<string>",
  "type": "<string>"
}
```

---

#### Get business hours set

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/businesshours/businesshourid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/businesshours/businesshourid?api_token={api_token}
```

**Description**: This API fetches the details of a business hours set configured in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`businessHourId` | string | Yes | Business Hour ID |

---

#### Update business hours set

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/businesshours/businesshourid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/businesshours/businesshourid?api_token={api_token}
```

**Description**: This API updates the details of a business hours set configured in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`businessHourId` | string | Yes | Business Hour ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete business hours set

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/businesshours/businesshourid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/businesshours/businesshourid?api_token={api_token}
```

**Description**: This API deletes a business hours set from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`businessHourId` | string | Yes | Business Hour ID |

---

#### List business hour sets

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/businesshours`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/businesshours?from={from}&limit={limit}&status={status}&api_token={api_token}
```

**Description**: This API lists a particular number of business hour sets, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the business hour sets must be listed |
|`limit` | number | No | Number of business hour sets to list. Range: 1-50 |
|`status` | string | No | Activation status of the business hour sets. Values allowed are ACTIVE and INACTIVE |

---

#### List associated automation rules

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/businesshours/businesshourid/relatedrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/businesshours/businesshourid/relatedrules?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of automation rules that include a business hours set,based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`businessHourId` | string | Yes | Business Hour ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the rules must be listed |
|`limit` | number | No | Number of rules to list. Range: 1-50 |

---

### Category: Calls

#### Get call

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/calls/call_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls/call_id?include={include}&api_token={api_token}
```

**Description**: This API fetches the details of a call

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the call. Values allowed are: contacts, assignee, tickets, teams, livecalls |

---

#### List calls

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/calls`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls?include={include}&from={from}&limit={limit}&departmentId={departmentId}&departmentIds={departmentIds}&viewId={viewId}&assignee={assignee}&startTime={startTime}&isCompleted={isCompleted}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API fetches a particular number of calls, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the call. Values allowed are: contacts, assignee, tickets, teams |
|`from` | number | No | Index number, starting from which the calls must be fetched |
|`limit` | number | No | Number of calls to fetch |
|`departmentId` | number | No | ID of the department from which the calls must be fetched |
|`departmentIds` | number | No | Departments from which the calls need to be queried |
|`viewId` | number | No | ID of the view to apply while fetching the resources |
|`assignee` | number | No | Key that filters tickets by assignee. Values allowed are any valid assignee ID or multiple assignee IDs separated by commas |
|`startTime` | string | No | Start time for completing the call. Values allowed are Overdue, Tomorrow, CurrentWeek, CurrentMonth, and Today. You can pass multiple values by separating them with commas |
|`isCompleted` | boolean | No | Key that denotes whether the call is completed or not |
|`sortBy` | string | No | Key that sorts the calls by a specific attribute: startTime or createdTime. The default sorting order is ascending. A - prefix denotes descending order of sorting |

---

#### Create call

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/calls`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls?api_token={api_token}
```

**Description**: This API adds a call entry to your help desk portal

**Request Body**:
```json
{
  "departmentId": "<number>",
  "subject": "<string>",
  "startTime": "<string>",
  "direction": "<string>",
  "duration": "<number>",
  "status": "<string>",
  "contactId": "<number>"
}
```

---

#### Update call

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/calls/call_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls/call_id?api_token={api_token}
```

**Description**: This API updates the details of a call

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List calls by ticket

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/calls`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/calls?from={from}&isCompleted={isCompleted}&isSpam={isSpam}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of calls associated with a ticket, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the calls must be listed |
|`isCompleted` | boolean | No | Key that denotes if the call was completed or not |
|`isSpam` | boolean | No | Key that denotes whether to fetch spam calls or not |
|`limit` | number | No | Number of calls to list |
|`sortBy` | string | No | Sort by a specific attribute: startTime or createdTime. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`include` | string | No | Allowed values are: contacts, assignee, tickets, teams |

---

#### Delete calls

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/calls/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/calls/movetotrash?api_token={api_token}
```

**Description**: This API moves call entries to the Recycle Bin of your help desk portal

**Request Body**:
```json
{
  "entityIds": "<array>"
}
```

---

#### Delete spam calls

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/calls/deletespam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/calls/deletespam?api_token={api_token}
```

**Description**: This API deletes the given spam calls

**Request Body**:
```json
{
  "callIds": "<array>"
}
```

---

#### Clear live call mapping from an activity

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/calls/call_id/clearlivecall`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/calls/call_id/clearlivecall?api_token={api_token}
```

**Description**: This API clears the live call mapping from an activity

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |

---

#### Update many calls

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/calls/updatemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/calls/updatemany?api_token={api_token}
```

**Description**: This API updates multiple calls at once

**Request Body**:
```json
{
  "ids": "<array>",
  "fieldName": "<string>"
}
```

---

#### Empty spam calls

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/calls/emptyspam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/calls/emptyspam?api_token={api_token}
```

**Description**: This API deletes all spam calls

**Request Body**:
```json
{
  "departmentId": "<number>"
}
```

---

### Category: Calls Comments

#### Create a call comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/calls/call_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls/call_id/comments?api_token={api_token}
```

**Description**: This API adds a comment to a call

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update a call comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/calls/call_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls/call_id/comments/comment_id?api_token={api_token}
```

**Description**: This API updates an existing call comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |
|`comment_id` | string | Yes | Comment ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a call comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/calls/call_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls/call_id/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes an existing call comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |
|`comment_id` | string | Yes | Comment ID |

---

#### Get a call comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/calls/call_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls/call_id/comments/comment_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a call comment from the portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |
|`comment_id` | string | Yes | Comment ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments |

---

#### List all call comments

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/calls/call_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/calls/call_id/comments?from={from}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on a call, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`call_id` | string | Yes | Call ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the comments must be fetched |
|`limit` | number | Yes | No. of comments to fetch |
|`sortBy` | string | No | Sort comments by the commentedTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`include` | string | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments |

---

### Category: Channels

#### List configured channels

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/channels`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/channels?api_token={api_token}
```

**Description**: This API fetches currently installed channels including System, Channel integration and Instant Messaging channels

---

### Category: Community

#### Like topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/like`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/like?api_token={api_token}
```

**Description**: This API enables users to like a topic

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Unlike topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/unlike`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/unlike?api_token={api_token}
```

**Description**: This API enables users to unlike a topic

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Follow topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/follow`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/follow?api_token={api_token}
```

**Description**: This API enables users to follow a topic

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Unfollow topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/unfollow`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/unfollow?api_token={api_token}
```

**Description**: This API enables users to unfollow a topic

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Lock topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/lock`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/lock?api_token={api_token}
```

**Description**: This API helps lock a forum topic, so that further user actions are restricted

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Unlock topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/unlock`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/unlock?api_token={api_token}
```

**Description**: This API helps unlock a forum topic, so that further user actions can be performed

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Moderate topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/moderate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/moderate?api_token={api_token}
```

**Description**: This API allows to set the forum topics as moderate

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Unmoderate topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/unmoderate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/unmoderate?api_token={api_token}
```

**Description**: This API helps unmoderate a forum topic, which means user comments are published without reviewing

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Trash topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/movetotrash?api_token={api_token}
```

**Description**: This API moves a forum topic to trash of your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

#### Move topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/move`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/move?api_token={api_token}
```

**Description**: This API moves a forum topic from one community category to another

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

**Request Body**:
```json
{
  "categoryId": "<number>"
}
```

---

#### Associate tags to topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/associatetags`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/associatetags?api_token={api_token}
```

**Description**: This API associates quick access/reference tags to a forum topic

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

**Request Body**:
```json
{
  "tags": "<array>"
}
```

---

#### Dissociate tags from topic

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/dissociatetags`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/dissociatetags?api_token={api_token}
```

**Description**: This API removes quick access/reference tags from a forum topic

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

**Request Body**:
```json
{
  "tags": "<array>"
}
```

---

#### List topic followers

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/followers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/followers?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of users who follow a forum topic, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | Index number, starting from which the users must be listed. |
|`limit` | number | Yes | Number of users to list |

---

#### List topic participants

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/participants`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/participants?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of users who participated in a forum topic, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | Index number, starting from which the users must be listed. |
|`limit` | number | Yes | Number of users to list |

---

#### List topic voters

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/communitytopics/id/voters`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/communitytopics/id/voters?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of users who voted in a forum topic, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | Yes | Index number, starting from which the users must be listed. |
|`limit` | number | Yes | Number of users to list |

---

*Note: Showing 15 of 88 endpoints in this category.*

---

### Category: Contact Deduplication

#### List duplicate contacts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/groupcontactduplicatevalues`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groupcontactduplicatevalues?api_token={api_token}
```

**Description**: This API lists the duplicate entries of a contact

---

#### List details of duplicate contacts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/groupcontacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groupcontacts?fieldName={fieldName}&sortBy={sortBy}&from={from}&limit={limit}&fieldValues={fieldValues}&include={include}&api_token={api_token}
```

**Description**: This API lists all the details of duplicate contacts

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`fieldName` | string | Yes | Name of the field whose values must be matched for deduplication. Values allowed are: firstName, lastName, email, secondaryEmail, phone, fullName, bothEmail. max chars: 100 |
|`sortBy` | string | No | Key that sorts the contacts by a specific attribute: firstName, lastName, fullName, phone, email, account, createdTime, modifiedTime. max chars: 100 |
|`from` | number | No | Index number starting from which the contacts must be fetched. Default: 0, range: >=0 |
|`limit` | number | No | Number of contacts to fetch. Range: 1-100 |
|`fieldValues` | string | Yes | Actual values in each field related to the contact. max chars: 100 |
|`include` | array | No | Secondary information related to the contact. Value allowed is: accounts. |

---

#### Get name of default field

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contactsdeduplication/defaultfieldname`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contactsdeduplication/defaultfieldname?api_token={api_token}
```

**Description**: This API fetches the name of the field set as the default field for contact deduplication

---

#### Set default field for contact deduplication

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contactsdeduplication/defaultfieldname`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contactsdeduplication/defaultfieldname?api_token={api_token}
```

**Description**: This API sets the field you specify as the default field for deduplicating contacts

**Request Body**:
```json
{
  "fieldName": "<string>",
  "markDefault": "<boolean>"
}
```

---

### Category: Contact Followers

#### Add contact followers

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/addfollowers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/addfollowers?api_token={api_token}
```

**Description**: This API adds one or more users to the followers list of a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Request Body**:
```json
{
  "followerIds": "<array>"
}
```

---

#### Remove contact followers

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/removefollowers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/removefollowers?api_token={api_token}
```

**Description**: This API removes one or more users from the followers list of a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Request Body**:
```json
{
  "followerIds": "<array>"
}
```

---

#### Get contact followers

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/followers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/followers?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches the list of users following a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the followers must be fetched |
|`limit` | number | No | Number of followers to list. Range: 1-100 |

---

### Category: Contact TimeEntry

#### List Contact Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/timeentry`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/timeentry?module={module}&departmentId={departmentId}&from={from}&limit={limit}&orderBy={orderBy}&include={include}&billStatus={billStatus}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&api_token={api_token}
```

**Description**: This API lists time entries recorded for a ticket or task related to a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module from which the time entries must be fetched. Values allowed are tickets and tasks |
|`departmentId` | number | No | ID of the department |
|`from` | number | No | Index number, starting from which the time entries must be fetched |
|`limit` | number | No | Number of time entries to fetch. Range: 1-100 |
|`orderBy` | string | No | Key that sorts the time entries in ascending or descending order, based on the executedTime attribute. Values allowed are ASC (default) and DESC |
|`include` | string | No | Secondary information related to the time entry. Value supported is owner. Max chars: 100 |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |
|`createdTimeRange` | string | No | Key that filters time entries created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ |
|`modifiedTimeRange` | string | No | Key that filters time entries whose details were modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ |

---

#### Get summation of Contact Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/timeentrysummation`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/timeentrysummation?module={module}&departmentId={departmentId}&billStatus={billStatus}&api_token={api_token}
```

**Description**: This API fetches summation of time entries for a contact from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module Preference. It can be either tickets or tasks. Max chars: 100 |
|`departmentId` | number | No | ID of the department |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |

---

### Category: Contacts

#### Get Contact

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a single contact from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Allowed values are : accounts , owner |

---

#### List contacts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts?include={include}&from={from}&limit={limit}&viewId={viewId}&sortBy={sortBy}&fields={fields}&api_token={api_token}
```

**Description**: This API lists a particular number of contacts, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | array | No | Secondary information related to the contact.Value supported is accounts |
|`from` | number | No | Index number, starting from which the contacts must be fetched |
|`limit` | string | No | Number of contacts to fetch |
|`viewId` | number | No | ID of the view to apply while fetching the resources |
|`sortBy` | string | No | Sort by a specific attribute: firstName, lastName, or createdTime |
|`fields` | string | No | Key that returns the values of mentioned fields (both pre-defined and custom) in your portal |

---

#### Create Contact

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts?api_token={api_token}
```

**Description**: This API creates a contact in your help desk portal

**Request Body**:
```json
{
  "lastName": "<string>"
}
```

---

#### Update a contact

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id?api_token={api_token}
```

**Description**: This API updates details of an existing contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Contacts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contacts/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/movetotrash?api_token={api_token}
```

**Description**: This API moves the contacts specified to the Recycle Bin

**Request Body**:
```json
{
  "contactIds": "<array>"
}
```

---

#### Delete spam contacts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contacts/deletespam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/deletespam?api_token={api_token}
```

**Description**: This API deletes the given spam contacts

**Request Body**:
```json
{
  "contactIds": "<array>"
}
```

---

#### Get Contact Profiles

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/profiles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/profiles?include={include}&api_token={api_token}
```

**Description**: This api fetches the list of profiles of this contact from various channels

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | array | No | Additional information related to the profile's channel |

---

#### Update many contacts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contacts/updatemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/updatemany?api_token={api_token}
```

**Description**: This API updates multiple contacts at once

**Request Body**:
```json
{
  "ids": "<array>",
  "fieldName": "<string>"
}
```

---

#### List Contacts By Ids

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contactsbyids`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contactsbyids?ids={ids}&api_token={api_token}
```

**Description**: This API lists details of specific contacts, based on the IDs passed in the request

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ids` | number | Yes | List of Contact Ids (separated by comma) which must be fetched |

---

#### List tickets by contact

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/tickets?departmentId={departmentId}&from={from}&limit={limit}&sortBy={sortBy}&dueDate={dueDate}&isSpam={isSpam}&include={include}&api_token={api_token}
```

**Description**: This API lists tickets received from a specific contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department from which the tickets must be fetched |
|`from` | number | No | Index number, starting from which the tickets must be fetched |
|`limit` | number | No | Number of tickets to fetch |
|`sortBy` | string | No | Sort by a specific attribute: createdTime or modifiedTime |
|`dueDate` | string | No | Filter by ticket duedate. Values allowed are overdue, tomorrow, currentWeek, currentMonth and today |
|`isSpam` | boolean | No | Filters Spam tickets |
|`include` | string | No | Additional information related to the tickets |

---

#### List products by contact

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/products`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/products?from={from}&limit={limit}&departmentId={departmentId}&api_token={api_token}
```

**Description**: This API lists products associated for a specific contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index |
|`limit` | number | No | Number of products to fetch |
|`departmentId` | number | No | Department from which the products need to be queried |

---

#### Get contacts count

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contacts/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/count?viewId={viewId}&startsWith={startsWith}&api_token={api_token}
```

**Description**: This API displays the count for the number of contacts in a custom view

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`viewId` | number | Yes | Custom view ID |
|`startsWith` | string | No | Displays the number of contacts whose first name or last name begins with the letter you specify |

---

#### Get contact statistics

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/statistics`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/statistics?departmentId={departmentId}&api_token={api_token}
```

**Description**: This API fetches the overall statistics of an contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department from which the statistics must be fetched |

---

#### Merge Contacts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/merge`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/merge?api_token={api_token}
```

**Description**: This API merges two or more contacts

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Mark contact as spam

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contacts/markspam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/markspam?api_token={api_token}
```

**Description**: This API marks contacts as spam

**Request Body**:
```json
{
  "ids": "<array>",
  "isSpam": "<boolean>"
}
```

---

*Note: Showing 15 of 27 endpoints in this category.*

---

### Category: Contacts Attachments

#### List Contact Attachments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/attachments?sortBy={sortBy}&from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: This API lists the files attached to a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sortBy` | string | No | Sort by the createdTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`from` | number | No | Index number, starting from which the attachments must be fetched |
|`limit` | number | No | Number of attachments to fetch. Range: 1-100 |
|`include` | string | No | Secondary information related to the attachments. Value allowed is creator, which returns the details of users who added the attachments |

---

#### Create Contact Attachment

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/attachments?api_token={api_token}
```

**Description**: This API attaches a file to a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Contact attachment

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/contacts/contact_id/attachments/attachment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/contact_id/attachments/attachment_id?api_token={api_token}
```

**Description**: This API removes an attachment from a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |
|`attachment_id` | string | Yes | Attachment ID |

---

### Category: Contacts Comments

#### Create a contact comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/comments?api_token={api_token}
```

**Description**: This API adds a comment to a contact

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update a contact comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/comments/comment_id?api_token={api_token}
```

**Description**: This API updates an existing contact comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |
|`comment_id` | string | Yes | Comment ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a contact comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes an existing contact comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |
|`comment_id` | string | Yes | Comment ID |

---

#### Get a contact comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/comments/comment_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a contact comment from the portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |
|`comment_id` | string | Yes | Comment ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments |

---

#### List all contact comments

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contacts/contact_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contacts/contact_id/comments?from={from}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on a contact, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contact_id` | string | Yes | Contact ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the comments must be fetched |
|`limit` | number | Yes | No. of comments to fetch |
|`sortBy` | string | No | Sort by the commentedTime attribute. Default order is descending. Use prefix - for descending order. |
|`include` | string | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments. |

---

### Category: Contracts

#### Get a contract

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contracts/contract_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/contract_id?api_token={api_token}
```

**Description**: This API fetches a single contract from your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`contract_id` | string | Yes | Contract ID |

---

#### List all contracts

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contracts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts?from={from}&limit={limit}&viewId={viewId}&departmentIds={departmentIds}&accountId={accountId}&ownerIds={ownerIds}&contractName={contractName}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: To get a list of contracts

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index |
|`limit` | number | No | Number of contracts to fetch |
|`viewId` | number | No | ID of the view to apply while fetching the resources |
|`departmentIds` | number | No | IDs of the departments from which the contract must be fetched |
|`accountId` | number | No | ID of the account associated with the contract |
|`ownerIds` | number | No | Returns contracts whose owner ids are mentioned |
|`contractName` | string | No | to search contracts having name starting with |
|`sortBy` | string | No | Parameter that sorts contracts |
|`include` | string | No | Allowed Value is: accounts |

---

#### Create a contract

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contracts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contracts?api_token={api_token}
```

**Description**: This API creates a contract in your helpdesk

**Request Body**:
```json
{
  "departmentId": "<number>",
  "startDate": "<string>",
  "ownerId": "<number>",
  "contractName": "<string>"
}
```

---

#### Update a contract

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/contracts/contract_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contracts/contract_id?api_token={api_token}
```

**Description**: This API updates the details of an existing contract

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete contracts

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/contracts/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/movetotrash?api_token={api_token}
```

**Description**: This API moves contracts to the Recycle Bin of your help desk portal

**Request Body**:
```json
{
  "contractIds": "<array>"
}
```

---

#### Update many contracts

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/contracts/updatemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contracts/updatemany?api_token={api_token}
```

**Description**: This API updates multiple contracts at once

**Request Body**:
```json
{
  "ids": "<array>",
  "fieldName": "<string>",
  "isCustomField": "<boolean>"
}
```

---

### Category: Contracts Comments

#### Create a contract comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/contracts/contract_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/contract_id/comments?api_token={api_token}
```

**Description**: This API adds a comment to a contract

---

#### Update a contract comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/contracts/contract_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/contract_id/comments/comment_id?api_token={api_token}
```

**Description**: This API updates an existing contract comment

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a contract comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/contracts/contract_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/contract_id/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes an existing contract comment

---

#### Get a contract comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contracts/contract_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/contract_id/comments/comment_id?api_token={api_token}
```

**Description**: This API fetches a contract comment from the portal

---

#### List all contract comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/contracts/contract_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/contracts/contract_id/comments?api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on a contract, based on the limit specified

---

### Category: Customer Feedback

#### List all customer feedback

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/customerhappiness`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/customerhappiness?department={department}&agentId={agentId}&contactId={contactId}&accountId={accountId}&ticketId={ticketId}&startTime={startTime}&endTime={endTime}&from={from}&limit={limit}&rating={rating}&duration={duration}&startDate={startDate}&endDate={endDate}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: Get customer feedback list for a given department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department` | string | Yes | Mandatory param to fetch the customer-happiness list for a given ID of the department. You can also provide department as allDepartment to fetch customer happiness from all departments |
|`agentId` | number | No | Filter that returns the customer-happiness list for a particular agent |
|`contactId` | number | No | Filter that returns the customer-happiness list for a particular contact |
|`accountId` | number | No | Filter that returns the customer-happiness list for a particular account |
|`ticketId` | number | No | Filter that returns the customer-happiness list for a particular ticket |
|`startTime` | number | No | Start time from which the customer-happiness list should show. Start time should be in GMT time zone and in milliseconds |
|`endTime` | number | No | Start time till which the customer-happiness list should show. End time should be in GMT time zone and in milliseconds |
|`from` | number | No | The starting index from which the list should be displayed based on the time of receiving customer feedback |
|`limit` | number | No | Number of ratings to be displayed in the list |
|`rating` | string | No | Segregate the list based on the type of rating. Allowed values are good, ok, or bad |
|`duration` | string | No | Period from which the customer happiness rating must be fetched. Values allowed are: TODAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, LAST_7_DAYS, YESTERDAY, LAST_1_HOUR, CUSTOM_IN_DATE, LAST_100_RATINGS, LAST24HOURS and LAST_30_DAYS |
|`startDate` | string | No | start date time |
|`endDate` | string | No | end date time |
|`sortBy` | string | No | Sorted by ratedtime |
|`include` | string | No | Allowed values are : contacts, tickets, agents. You can include both by separating them with a comma in the query param |

---

#### Get customer feedback count

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/customerhappiness/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/customerhappiness/count?department={department}&agentId={agentId}&contactId={contactId}&accountId={accountId}&ticketId={ticketId}&startTime={startTime}&endTime={endTime}&duration={duration}&startDate={startDate}&endDate={endDate}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API gives you the count of the ratings given by the customers for each category of a given department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department` | string | Yes | Mandatory param to fetch the customer-happiness list for a given ID of the department. You can also provide department as allDepartment to fetch customer happiness from all departments |
|`agentId` | number | No | Filter that returns the customer-happiness list for a particular agent |
|`contactId` | number | No | Filter that returns the customer-happiness list for a particular contact |
|`accountId` | number | No | Filter that returns the customer-happiness list for a particular account |
|`ticketId` | number | No | Filter that returns the customer-happiness list for a particular ticket |
|`startTime` | number | No | Start time from which the customer-happiness list should show. Start time should be in GMT time zone and in milliseconds |
|`endTime` | number | No | Start time till which the customer-happiness list should show. End time should be in GMT time zone and in milliseconds |
|`duration` | string | No | Period from which the customer happiness rating must be fetched. Values allowed are: TODAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, LAST_7_DAYS, YESTERDAY, LAST_1_HOUR, CUSTOM_IN_DATE, LAST_100_RATINGS, LAST24HOURS and LAST_30_DAYS |
|`startDate` | string | No | start date time |
|`endDate` | string | No | end date time |
|`from` | number | No | The from index |
|`limit` | number | No | Number of rating to be displayed |

---

#### Get the customer feedback content

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/customerhappiness/thread_id/content`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/customerhappiness/thread_id/content?api_token={api_token}
```

**Description**: This API retrieves the content of specific customer feedback

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`thread_id` | string | Yes | Thread ID |

---

#### Get the customer feedback placeholder link

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/customerhappinesslinkholder`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/customerhappinesslinkholder?departmentId={departmentId}&api_token={api_token}
```

**Description**: This API provides an html placeholder to insert the customer feedback link into the reply mail

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the department for which the placeholder should be collected |

---

### Category: Dashboards

#### Get created tickets count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/createdtickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/createdtickets?groupBy={groupBy}&departmentId={departmentId}&agentId={agentId}&teamId={teamId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API fetches the number of tickets created in a particular duration

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups the ticket count according to a particular attribute. This value can be date channel agent | hour |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`teamId` | number | No | ID(s) of the team(s) from which the stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

#### Get on hold tickets count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/onholdtickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/onholdtickets?groupBy={groupBy}&departmentId={departmentId}&agentId={agentId}&teamId={teamId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API fetches the number of tickets that are in the on hold status

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups the ticket count according to a particular attribute.This value can be date channel agent | hour |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`teamId` | number | No | ID(s) of the team(s) from which the stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

#### Get closed tickets count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/solvedtickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/solvedtickets?groupBy={groupBy}&departmentId={departmentId}&agentId={agentId}&teamId={teamId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API fetches the number of tickets that are resolved

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups the ticket count according to a particular attribute.This value can be date channel agent | hour |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`teamId` | number | No | ID(s) of the team(s) from which the stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

#### Get unresolved tickets count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/backlogtickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/backlogtickets?groupBy={groupBy}&departmentId={departmentId}&agentId={agentId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API fetches the number of tickets that have remained unresolved over a particular period

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups the ticket count according to a particular attribute.This value can be date channel agent |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

#### List resolution times

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/ticketsresolutiontime`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/ticketsresolutiontime?groupBy={groupBy}&departmentId={departmentId}&agentId={agentId}&teamId={teamId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API lists the durations taken to resolve tickets

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups stats according to a specific attribute: date, channel, agent, or hour |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`teamId` | number | No | ID(s) of the team(s) from which the stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

#### List response times

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/responsetime`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/responsetime?groupBy={groupBy}&isFirstResponse={isFirstResponse}&departmentId={departmentId}&agentId={agentId}&teamId={teamId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API lists the durations taken to respond to tickets

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups stats according to a specific attribute: date, channel, agent, or hour |
|`isFirstResponse` | boolean | Yes | Key that specifies if the response is the first response to the customer question |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`teamId` | number | No | ID(s) of the team(s) from which the stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

#### Get total response count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/responsecount`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/responsecount?groupBy={groupBy}&departmentId={departmentId}&agentId={agentId}&teamId={teamId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API fetches the total number of responses sent/made by your agents

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups the ticket count according to a particular attribute.This value can be date channel agent | hour |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`teamId` | number | No | ID(s) of the team(s) from which the stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

#### Get reopened tickets count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dashboards/reopenedtickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dashboards/reopenedtickets?groupBy={groupBy}&departmentId={departmentId}&agentId={agentId}&teamId={teamId}&duration={duration}&startDate={startDate}&endDate={endDate}&channel={channel}&api_token={api_token}
```

**Description**: This API fetches the number of tickets that were reopened in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`groupBy` | string | Yes | Key that groups the ticket count according to a particular attribute.This value can be date channel agent | hour |
|`departmentId` | number | No | ID(s) of the department(s) from which the stats must be fetched |
|`agentId` | number | No | ID(s) of the agent(s) whose stats must be fetched |
|`teamId` | number | No | ID(s) of the team(s) from which the stats must be fetched |
|`duration` | string | Yes | Predefined time range from which the stats must be fetched |
|`startDate` | string | No | Starting date for defining custom time range |
|`endDate` | string | No | Ending date for defining custom time range |
|`channel` | string | No | Channel through which the tickets were received |

---

### Category: Data Sharing Rules

#### Get data sharing rules

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/datasharingrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/datasharingrules?api_token={api_token}
```

**Description**: This API fetches the different data sharing rules configured in your help desk portal

---

#### Update data sharing rules

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/datasharingrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/datasharingrules?api_token={api_token}
```

**Description**: This API updates the data sharing rules configured in your help desk portal

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: Departments

#### Get department

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments/department_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id?api_token={api_token}
```

**Description**: This API fetches the details of a department from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

---

#### List departments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments?isEnabled={isEnabled}&from={from}&searchStr={searchStr}&limit={limit}&chatStatus={chatStatus}&api_token={api_token}
```

**Description**: This API lists a particular number of departments, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`isEnabled` | boolean | No | Key that filters departments based on their enabled status |
|`from` | number | No | Index number, starting from which the departments must be fetched |
|`searchStr` | String | No | String to search for departments by name, help center name, or description |
|`limit` | number | No | Number of departments to fetch |
|`chatStatus` | string | No | Key that filters departments based on their chat status |

---

#### List agents in department

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments/department_id/agents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/agents?from={from}&limit={limit}&status={status}&isLightAgent={isLightAgent}&isConfirmed={isConfirmed}&searchStr={searchStr}&fieldName={fieldName}&sortOrder={sortOrder}&api_token={api_token}
```

**Description**: This API lists the agents in a department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the agents must be listed |
|`limit` | number | No | Number of agents to fetch; default value is 10 and maximum value is 200 |
|`status` | String | No | Key that filters agents, based on their activation status: ACTIVE or DISABLED |
|`isLightAgent` | boolean | No | Key that denotes if the agents must be light or non light |
|`isConfirmed` | boolean | No | Key that denotes if the agents must be confirmed or unconfirmed |
|`searchStr` | string | No | String to search for agents by first name, last name, or email ID |
|`fieldName` | string | No | Name of the field that must be used for searching and listing agents |
|`sortOrder` | string | No | To sort the available list of agents in either ascending or descending order |

---

#### Get department count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/count?isEnabled={isEnabled}&api_token={api_token}
```

**Description**: This API returns the number of departments configured in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`isEnabled` | boolean | No | Key that filters departments based on their enabled status |

---

#### Get department details by department IDs

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departmentsbyids`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departmentsbyids?departmentIds={departmentIds}&api_token={api_token}
```

**Description**: This API fetches the details of the departments whose IDs are passed in the API request

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentIds` | number | Yes | Comma-separated array of department IDs |

---

#### Check for duplicate departments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments/checkexists`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/checkexists?departmentName={departmentName}&api_token={api_token}
```

**Description**: This API checks if multiple departments have the same name

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentName` | string | Yes | Name of the department for which you want to check duplicate entries |

---

#### Add department

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/departments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments?api_token={api_token}
```

**Description**: This API adds a department to your help desk portal

**Request Body**:
```json
{
  "name": "<string>",
  "associatedAgentIds": "<array>"
}
```

---

#### Update department

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/departments/department_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id?api_token={api_token}
```

**Description**: This API updates the details of an existing department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

**Request Body**:
```json
{
  "associatedAgentIds": "<array>"
}
```

---

#### Disable department

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/departments/department_id/disable`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/disable?api_token={api_token}
```

**Description**: This API disables a department in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

**Request Body**:
```json
{
  "agentNewDepartment": "<number>"
}
```

---

#### Enable department

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/departments/department_id/enable`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/enable?api_token={api_token}
```

**Description**: This API enables a department in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

---

#### Associate agents to department

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/departments/department_id/associateagents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/associateagents?api_token={api_token}
```

**Description**: This API associates agents to a department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

**Request Body**:
```json
{
  "agentIds": "<array>"
}
```

---

#### Dissociate agents from department

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/departments/department_id/dissociateagents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/dissociateagents?api_token={api_token}
```

**Description**: This API dissociates agents from a department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

**Request Body**:
```json
{
  "agentIds": "<array>"
}
```

---

#### Get department logo

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments/department_id/logo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/logo?fileSize={fileSize}&api_token={api_token}
```

**Description**: This API fetches the logo set for a department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`fileSize` | string | No | Size of the image file to download |

---

#### Upload department logo

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/departments/department_id/logo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/logo?api_token={api_token}
```

**Description**: This API updates the logo set for a department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete department logo

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/departments/department_id/logo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/logo?api_token={api_token}
```

**Description**: This API removes the logo set for a department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

---

### Category: DependencyMappings

#### List dependency mappings in a layout

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/dependencymappings`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dependencymappings?layoutId={layoutId}&api_token={api_token}
```

**Description**: This API lists the dependency mappings configured in a layout

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layoutId` | number | No | ID of the layout in which the dependency is mapped |

---

#### Get possible dependency mappings in a layout

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/availabledependencymappings`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/availabledependencymappings?layoutId={layoutId}&api_token={api_token}
```

**Description**: This API fetches the parent and child fields using which you can configure dependency mappings in a layout

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layoutId` | number | Yes | Layout ID |

---

#### Create dependency mapping

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/dependencymappings`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dependencymappings?api_token={api_token}
```

**Description**: This API creates a dependency mapping between two fields

**Request Body**:
```json
{
  "layoutId": "<number>",
  "parentId": "<number>",
  "childId": "<number>",
  "mappings": "<array>"
}
```

---

#### Update dependency mapping

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/dependencymappings/dependencymapping_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dependencymappings/dependencymapping_id?api_token={api_token}
```

**Description**: This API updates details of an existing dependency mapping

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dependencymapping_id` | string | Yes | Dependencymapping ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete dependency mapping

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/dependencymappings/dependencymapping_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/dependencymappings/dependencymapping_id?api_token={api_token}
```

**Description**: This API deletes a dependency mapping from a layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`dependencymapping_id` | string | Yes | Dependencymapping ID |

---

### Category: Domain Mapping

#### Add domain

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/domains`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/domains?api_token={api_token}
```

**Description**: This API adds a domain to your help desk

**Request Body**:
```json
{
  "domain": "<string>"
}
```

---

#### Verify domain

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/domains/verify`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/domains/verify?api_token={api_token}
```

**Description**: This API verifies a domain in your help desk

**Request Body**:
```json
{
  "domain": "<string>",
  "method": "<string>"
}
```

---

#### Apply domain

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/domains/apply`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/domains/apply?api_token={api_token}
```

**Description**: This API maps a domain to the default portal in your help desk

**Request Body**:
```json
{
  "domain": "<string>"
}
```

---

#### Reset current domain

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/domains/reset`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/domains/reset?api_token={api_token}
```

**Description**: This API resets the current domain of the default portal in your help desk

---

#### List domains

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/domains`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/domains?isVerified={isVerified}&isApplied={isApplied}&api_token={api_token}
```

**Description**: This API lists the domains configured in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`isVerified` | boolean | No | Key that filters domains based on their verification status |
|`isApplied` | boolean | No | Key that filters domains based on their application status in the help desk |

---

### Category: EmailTemplates

#### Add Template

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/templates`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates?api_token={api_token}
```

**Description**: Add a new Template

**Request Body**:
```json
{
  "templateName": "<string>",
  "subject": "<string>",
  "recordType": "<string>",
  "departmentId": "<number>",
  "folderId": "<number>",
  "fromId": "<string>",
  "contentType": "<string>"
}
```

---

#### View Template

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/templates/template_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates/template_id?api_token={api_token}
```

**Description**: View a particular Template

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`template_id` | string | Yes | Template ID |

---

#### Update Template

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/templates/template_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates/template_id?api_token={api_token}
```

**Description**: Update an existing Template

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`template_id` | string | Yes | Template ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Template

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/templates/template_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates/template_id?api_token={api_token}
```

**Description**: Delete a Template

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`template_id` | string | Yes | Template ID |

---

#### Listing Templates

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/templates`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates?departmentId={departmentId}&module={module}&from={from}&limit={limit}&searchStr={searchStr}&folderId={folderId}&api_token={api_token}
```

**Description**: List all Templates

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | The corresponding department to be fetched |
|`module` | string | No | The name of the module |
|`from` | number | Yes | from index, DEFAULT 1 |
|`limit` | number | Yes | number of templates to be retrieved Range 1-50, DEFAULT 50 |
|`searchStr` | string | No | String to search for templates by name |
|`folderId` | number | No | the corresponding folder to be fetched |

---

#### Rendering a Template

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/templates/template_id/render`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates/template_id/render?api_token={api_token}
```

**Description**: Render an exisiting Template into reply

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`template_id` | string | Yes | Template ID |

**Request Body**:
```json
{
  "entityId": "<number>"
}
```

---

#### Fetching placeholders

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/templates/placeholders`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates/placeholders?module={module}&departmentId={departmentId}&api_token={api_token}
```

**Description**: List the placeholders supported in emailTemplates

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | To get placeholders for this module. Allowed values are tickets, tasks, contacts, accounts, products, solutions, calls, events |
|`departmentId` | number | Yes | To get placeholders for this departmentId |

---

#### Cloning a Email Template Attachments

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/templates/template_id/cloneattachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templates/template_id/cloneattachments?api_token={api_token}
```

**Description**: Cloning an exisiting Template's attachments

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`template_id` | string | Yes | Template ID |

---

### Category: Entity Followers

#### Get Entity followers count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/moduleapiname/entityid/followerscount`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/moduleapiname/entityid/followerscount?userType={userType}&api_token={api_token}
```

**Description**: This API fetches the count of follower list based on given filter

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`moduleAPIName` | string | Yes | Module API Name |
|`entityId` | string | Yes | Entity ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`userType` | string | No | To get the followers count based on userType. Allowed values: AGENTS, END_USERS. Default value: all users will be processed |

---

#### Get Entity followers details

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/moduleapiname/entityid/followers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/moduleapiname/entityid/followers?userType={userType}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches the list of follower details based on the given filter

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`moduleAPIName` | string | Yes | Module API Name |
|`entityId` | string | Yes | Entity ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`userType` | string | No | To get the followers based on userType. Allowed values: AGENTS, END_USERS. Default value: all users will be processed |
|`from` | number | Yes | Index number, starting from which the followers must be listed. Default value is 1. |
|`limit` | number | No | Number of followers to list |

---

### Category: Events

#### Get event

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/events/event_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events/event_id?include={include}&api_token={api_token}
```

**Description**: This API fetches the details of an event

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`event_id` | string | Yes | Event ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Allowed values are: contacts, assignee, tickets, teams, integInfo. |

---

#### List events

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/events`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events?include={include}&from={from}&limit={limit}&startTime={startTime}&departmentId={departmentId}&departmentIds={departmentIds}&assignee={assignee}&viewId={viewId}&isCompleted={isCompleted}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API lists a particular number of events, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the event. Allowed values are: contacts, assignee, tickets, teams, integInfo |
|`from` | number | No | Index number, starting from which the events must be fetched |
|`limit` | number | No | Number of events to list. Range: 1-100 |
|`startTime` | string | No | Start time for completing the event. Values allowed are Overdue, Tomorrow, CurrentWeek, CurrentMonth, and Today. You can pass multiple values by separating them with commas |
|`departmentId` | number | No | ID of the department from which the events must be fetched |
|`departmentIds` | number | No | Departments from which the events need to be queried |
|`assignee` | number | No | Key that filters events by assignee. Values allowed are any valid assignee ID or multiple assignee IDs separated by commas |
|`viewId` | number | No | ID of the view to apply while fetching the resources |
|`isCompleted` | boolean | No | Key that denotes whether the event is completed or not |
|`sortBy` | string | No | Key that sorts the events by a specific attribute: startTime or createdTime. The default sorting order is ascending. A - prefix denotes descending order of sorting |

---

#### Create event

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/events`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events?api_token={api_token}
```

**Description**: This API adds an event entry to your help desk portal

**Request Body**:
```json
{
  "departmentId": "<number>",
  "subject": "<string>",
  "startTime": "<string>",
  "duration": "<number>",
  "contactId": "<number>"
}
```

---

#### Update event

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/events/event_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events/event_id?api_token={api_token}
```

**Description**: This API updates the details of an event

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`event_id` | string | Yes | Event ID |

**Request Body**:
```json
{
  "subject": "<string>"
}
```

---

#### List events by ticket

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/events`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/events?from={from}&isCompleted={isCompleted}&isSpam={isSpam}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of events associated with a ticket, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the events must be listed |
|`isCompleted` | boolean | No | Key that denotes if the event was completed or not |
|`isSpam` | boolean | No | Key that denotes whether to fetch spam events or not |
|`limit` | number | No | Number of events to list. Range: 1-100 |
|`sortBy` | string | No | Sort by a specific attribute: startTime or createdTime. Default sorting order is ascending. A - prefix denotes descending order of sorting |
|`include` | string | No | Allowed values are: contacts, assignee, tickets, teams, integInfo. Max chars: 100 |

---

#### Delete events

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/events/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/events/movetotrash?api_token={api_token}
```

**Description**: This API moves event entries to the Recycle Bin of your help desk portal

**Request Body**:
```json
{
  "entityIds": "<array>"
}
```

---

#### Delete spam events

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/events/deletespam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/events/deletespam?api_token={api_token}
```

**Description**: This API deletes the given spam events

**Request Body**:
```json
{
  "eventIds": "<array>"
}
```

---

#### Update many events

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/events/updatemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/events/updatemany?api_token={api_token}
```

**Description**: This API updates multiple events at once

**Request Body**:
```json
{
  "ids": "<array>",
  "fieldName": "<string>"
}
```

---

#### Empty spam events

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/events/emptyspam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/events/emptyspam?api_token={api_token}
```

**Description**: This API deletes all spam events

**Request Body**:
```json
{
  "departmentId": "<number>"
}
```

---

### Category: Events Comments

#### Create a event comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/events/event_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events/event_id/comments?api_token={api_token}
```

**Description**: This API adds a comment to a event

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`event_id` | string | Yes | Event ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update a event comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/events/event_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events/event_id/comments/comment_id?api_token={api_token}
```

**Description**: This API updates an existing event comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`event_id` | string | Yes | Event ID |
|`comment_id` | string | Yes | Comment ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a event comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/events/event_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events/event_id/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes an existing event comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`event_id` | string | Yes | Event ID |
|`comment_id` | string | Yes | Comment ID |

---

#### Get a event comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/events/event_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events/event_id/comments/comment_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a event comment from the portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`event_id` | string | Yes | Event ID |
|`comment_id` | string | Yes | Comment ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | String | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments |

---

#### List all event comments

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/events/event_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/events/event_id/comments?from={from}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on a event, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`event_id` | string | Yes | Event ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the comments must be fetched |
|`limit` | number | Yes | No. of comments to fetch. Default is 50, range is 1-100 |
|`sortBy` | string | No | Sort comments by the commentedTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting. Max chars: 100 |
|`include` | String | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments |

---

### Category: Finance

#### Update estimate status

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/zohofinance/financeservice/estimates/id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/zohofinance/financeservice/estimates/id?api_token={api_token}
```

**Description**: This will update status of estimate

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`financeService` | string | Yes | Finance Service |
|`id` | string | Yes | ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List invoices

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/zohofinance/financeservice/invoices`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/zohofinance/financeservice/invoices?deskEntityId={deskEntityId}&deskModuleName={deskModuleName}&departmentId={departmentId}&status={status}&pageNumber={pageNumber}&api_token={api_token}
```

**Description**: To list invoices

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`financeService` | string | Yes | Finance Service |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deskEntityId` | number | No | To fetch invoice by desk contact or account or ticket id |
|`deskModuleName` | string | Yes | Desk Module Name Contacts or Cases or Accounts |
|`departmentId` | number | No | Department Id |
|`status` | string | No | To fetch invoice by status |
|`pageNumber` | number | No | Page number |

---

#### Update invoice status

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/zohofinance/financeservice/invoices/id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/zohofinance/financeservice/invoices/id?api_token={api_token}
```

**Description**: This will update status of invoice

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`financeService` | string | Yes | Finance Service |
|`id` | string | Yes | ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### MarkAllInvoicesSent

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/zohofinance/financeservice/invoices/markassent`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/zohofinance/financeservice/invoices/markassent?api_token={api_token}
```

**Description**: This will update status of invoice to sent

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`financeService` | string | Yes | Finance Service |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List estimates

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/zohofinance/financeservice/estimates`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/zohofinance/financeservice/estimates?deskEntityId={deskEntityId}&deskModuleName={deskModuleName}&status={status}&pageNumber={pageNumber}&api_token={api_token}
```

**Description**: To list estimates

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`financeService` | string | Yes | Finance Service |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`deskEntityId` | number | No | To fetch invoice by desk contact or account or ticket id |
|`deskModuleName` | string | Yes | Desk Module Name |
|`status` | string | No | To fetch estimates by status |
|`pageNumber` | number | No | Page number |

---

#### Get tickets for invoices

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/finance/invoices/id/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/finance/invoices/id/tickets?api_token={api_token}
```

**Description**: To get associated tickets for invoice id

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`id` | string | Yes | ID |

---

### Category: Groups

#### Create user groups

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/groups`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups?api_token={api_token}
```

**Description**: This API creates a user group in your help center

**Request Body**:
```json
{
  "name": "<string>",
  "helpCenterId": "<number>"
}
```

---

#### Update group

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/groups/group_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups/group_id?api_token={api_token}
```

**Description**: This API helps update the details of a user group

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_Id` | string | Yes | Group ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get details of group

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/groups/group_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups/group_id?api_token={api_token}
```

**Description**: This API fetches the details of a particular user group

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_Id` | string | Yes | Group ID |

---

#### List groups

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/groups`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups?from={from}&limit={limit}&sortBy={sortBy}&searchBy={searchBy}&helpCenterId={helpCenterId}&api_token={api_token}
```

**Description**: This API lists a particular number of groups, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the groups must be fetched |
|`limit` | number | No | Number of groups to list |
|`sortBy` | string | No | Key that sorts the list of groups by a particular attribute: -(createdTime modifiedTime name or count) |
|`searchBy` | string | No | Search keyword to use for finding a particular group The keyword must contain at least two characters |
|`helpCenterId` | number | No | ID of the help center from which the resource must be fetched |

---

#### Delete group

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/groups/group_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups/group_id?api_token={api_token}
```

**Description**: This API deletes a user group from your help center

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_Id` | string | Yes | Group ID |

---

#### Add users to group

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/groups/group_id/users/add`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups/group_id/users/add?api_token={api_token}
```

**Description**: This API adds users to a particular group

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_Id` | string | Yes | Group ID |

**Request Body**:
```json
{
  "users": "<array>"
}
```

---

#### Remove users from group

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/groups/group_id/users/remove`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups/group_id/users/remove?api_token={api_token}
```

**Description**: This API removes particular users from a group

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_Id` | string | Yes | Group ID |

**Request Body**:
```json
{
  "userIds": "<array>"
}
```

---

#### List users in a group

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/groups/group_id/users`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/groups/group_id/users?from={from}&limit={limit}&sortBy={sortBy}&searchBy={searchBy}&api_token={api_token}
```

**Description**: This API lists a particular number of users in a group, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`group_Id` | string | Yes | Group ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the users must be fetched |
|`limit` | number | No | Number of users to list |
|`sortBy` | string | No | Key that sorts the list of users based on a specific attribute: -(addedTime) |
|`searchBy` | string | No | Search keyword to use for finding a particular user |

---

### Category: Help Center

#### List help centers

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/helpcenters`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/helpcenters?api_token={api_token}
```

**Description**: This API lists the help centers configured in your Zoho Desk portal

---

#### Get details of help center

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/helpcenters/helpcenter_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/helpcenters/helpcenter_id?api_token={api_token}
```

**Description**: This API fetches the details of a particular help center

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`helpcenter_id` | string | Yes | Helpcenter ID |

---

#### Update Helpcenter sitemaps

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/helpcenters/helpcenter_id/sitemaps`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/helpcenters/helpcenter_id/sitemaps?api_token={api_token}
```

**Description**: This API will generate sitemaps for the given Helpcenter

---

### Category: HolidayList

#### Create holiday list

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/holidaylist`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/holidaylist?api_token={api_token}
```

**Description**: This API creates a holiday list in your help desk portal

**Request Body**:
```json
{
  "name": "<string>",
  "holidays": "<array>",
  "status": "<string>"
}
```

---

#### Get holiday list

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/holidaylist/holidaylistid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/holidaylist/holidaylistid?api_token={api_token}
```

**Description**: This API fetches the details of a holiday list configured in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`holidayListId` | string | Yes | Holiday List ID |

---

#### Update holiday list

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/holidaylist/holidaylistid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/holidaylist/holidaylistid?api_token={api_token}
```

**Description**: This API updates the details of a holiday list configured in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`holidayListId` | string | Yes | Holiday List ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete holiday list

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/holidaylist/holidaylistid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/holidaylist/holidaylistid?api_token={api_token}
```

**Description**: This API deletes a holiday list from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`holidayListId` | string | Yes | Holiday List ID |

---

#### List holiday lists

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/holidaylist`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/holidaylist?from={from}&limit={limit}&status={status}&api_token={api_token}
```

**Description**: This API lists a particular number of holiday lists, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the holiday lists must be listed |
|`limit` | number | No | Number of holiday lists to list |
|`status` | string | No | Activation status of the holiday list |

---

### Category: Jira

#### Get Linked Tickets by Jira Issue Id

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/jiraissue/issueid/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/jiraissue/issueid/tickets?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches support tickets associated with the Jira issue specified in the API request

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`issueId` | string | Yes | Issue ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Start index |
|`limit` | number | No | Length of the response |

---

### Category: KBCategory

#### Create root category

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbrootcategories`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories?api_token={api_token}
```

**Description**: This API creates a root category in your knowledge base

**Request Body**:
```json
{
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "visibility": "<string>",
  "articleViewType": "<string>",
  "isReviewEnabled": "<boolean>",
  "logoId": "<number>"
}
```

---

#### Upload logo image

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbcategorylogo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbcategorylogo?api_token={api_token}
```

**Description**: This API is used to upload an image to be used as logo

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Create a section

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbsections`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbsections?api_token={api_token}
```

**Description**: This API creates a section in your helpdesk

**Request Body**:
```json
{
  "name": "<string>",
  "parentCategoryId": "<number>"
}
```

---

#### Update a section

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/kbsections/sectionid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbsections/sectionid?api_token={api_token}
```

**Description**: This API updates a section in your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sectionId` | string | Yes | Section ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get a section

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/kbsections/sectionid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbsections/sectionid?include={include}&api_token={api_token}
```

**Description**: This API fetches a section in your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sectionId` | string | Yes | Section ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Include params are publicArticlesCount allArticlesCount |

---

#### Get root category

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/kbrootcategories/rootcategoryid`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories/rootcategoryid?include={include}&api_token={api_token}
```

**Description**: This API fetches the details of a root category

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rootCategoryId` | string | Yes | Root Category ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the category |

---

#### Get a category tree

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/kbrootcategories/rootcategoryid/categorytree`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories/rootcategoryid/categorytree?locale={locale}&sortBy={sortBy}&includeTrash={includeTrash}&include={include}&api_token={api_token}
```

**Description**: This API fetches the full tree of a root category in your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rootCategoryId` | string | Yes | Root Category ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`locale` | string | No | Locale of the translated name |
|`sortBy` | string | No | Sort order of the categories |
|`includeTrash` | boolean | No | Presence flag of the category |
|`include` | string | No | Include params are publicArticlesCount allArticlesCount |

---

#### List root categories

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/kbrootcategories`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories?locale={locale}&sortBy={sortBy}&from={from}&limit={limit}&searchValue={searchValue}&status={status}&isTrashed={isTrashed}&isReviewEnabled={isReviewEnabled}&visibility={visibility}&departmentId={departmentId}&helpcenterId={helpcenterId}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of root categories, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`locale` | string | No | Language of the category |
|`sortBy` | string | No | Key that sorts the categories based on a specific attribute: name or order |
|`from` | number | Yes | Index number starting from which the categories must be fetched |
|`limit` | number | Yes | Number of categories to list |
|`searchValue` | string | No | Keyword for searching for a particular category |
|`status` | string | No | Activation status of the category |
|`isTrashed` | boolean | No | Key that denotes whether the category is deleted or not |
|`isReviewEnabled` | boolean | No | Key that specifies whether the category must be reviewed or not |
|`visibility` | string | No | Visibility setting of the category |
|`departmentId` | string | No | ID of the department associated with the category |
|`helpcenterId` | string | No | ID of the help center to which the category belongs |
|`include` | string | No | Additional information related to the category |

---

#### Get review owners

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/kbrootcategories/rootcategoryid/reviewowners`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories/rootcategoryid/reviewowners?sortBy={sortBy}&from={from}&limit={limit}&searchValue={searchValue}&api_token={api_token}
```

**Description**: This API fetches review owners of a root category in your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rootCategoryId` | string | Yes | Root Category ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sortBy` | string | No | Sort order of the owners |
|`from` | number | Yes | Offset value |
|`limit` | number | Yes | Number of objects |
|`searchValue` | string | No | Search string |

---

#### Add review owner

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbrootcategories/rootcategoryid/reviewowners/add`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories/rootcategoryid/reviewowners/add?api_token={api_token}
```

**Description**: This API adds review owners of a root category in your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rootCategoryId` | string | Yes | Root Category ID |

**Request Body**:
```json
{
  "reviewOwnerIds": "<array>"
}
```

---

#### Remove review owner

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbrootcategories/rootcategoryid/reviewowners/remove`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories/rootcategoryid/reviewowners/remove?api_token={api_token}
```

**Description**: This API removes review owners of a root category in your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rootCategoryId` | string | Yes | Root Category ID |

**Request Body**:
```json
{
  "reviewOwnerIds": "<array>"
}
```

---

#### Add a permalink to a root catgeory

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbrootcategories/rootcategoryid/translations/locale/permalinks/add`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories/rootcategoryid/translations/locale/permalinks/add?api_token={api_token}
```

**Description**: This API adds a permalink to a root category translation

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rootCategoryId` | string | Yes | Root Category ID |
|`locale` | string | Yes | Locale |

**Request Body**:
```json
{
  "permalink": "<string>"
}
```

---

#### Remove a permalink of a root category

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/kbrootcategories/rootcategoryid/translations/locale/permalinks/remove`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/kbrootcategories/rootcategoryid/translations/locale/permalinks/remove?api_token={api_token}
```

**Description**: This API removes a permalink of a root category translation

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`rootCategoryId` | string | Yes | Root Category ID |
|`locale` | string | Yes | Locale |

**Request Body**:
```json
{
  "permalink": "<string>"
}
```

---

### Category: Labels

#### Create label

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/labels`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels?api_token={api_token}
```

**Description**: This API creates a label in your help center

**Request Body**:
```json
{
  "name": "<string>",
  "helpCenterId": "<number>"
}
```

---

#### Update label

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/labels/label_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels/label_id?api_token={api_token}
```

**Description**: This API helps update the details of a label

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | Label ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get details of label

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/labels/label_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels/label_id?api_token={api_token}
```

**Description**: This API fetches the details of a particular label

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | Label ID |

---

#### List labels

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/labels`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels?from={from}&limit={limit}&sortBy={sortBy}&searchBy={searchBy}&helpCenterId={helpCenterId}&api_token={api_token}
```

**Description**: This API lists a particular number of labels, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the labels must be fetched |
|`limit` | number | No | Number of labels to list |
|`sortBy` | string | No | Key that sorts the list of labels by a particular attribute: -(createdTime or modifiedTime or name) |
|`searchBy` | string | No | Search keyword to use for finding a particular label |
|`helpCenterId` | number | No | ID of the help center from which the labels must be fetched |

---

#### Delete label

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/labels/label_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels/label_id?api_token={api_token}
```

**Description**: This API deletes a label from your help center

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | Label ID |

---

#### Delete label by labelIds

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/labels`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels?labelIds={labelIds}&api_token={api_token}
```

**Description**: This API deletes labels, based on the IDs specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`labelIds` | number | No | IDs of the labels to delete |

---

#### Assign label to users

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/labels/label_id/users/add`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels/label_id/users/add?api_token={api_token}
```

**Description**: This API assigns a particular label to multiple users

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | Label ID |

**Request Body**:
```json
{
  "userIds": "<array>"
}
```

---

#### Remove users under a label

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/labels/label_id/users/remove`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels/label_id/users/remove?api_token={api_token}
```

**Description**: This API removes all users under a particular label

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | Label ID |

**Request Body**:
```json
{
  "userIds": "<array>"
}
```

---

#### List users under a label

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/labels/label_id/users`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/labels/label_id/users?from={from}&limit={limit}&sortBy={sortBy}&searchBy={searchBy}&api_token={api_token}
```

**Description**: This API lists a particular number of users under a label, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`label_id` | string | Yes | Label ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the users must be fetched |
|`limit` | number | No | Number of users to list |
|`sortBy` | string | No | Key that sorts the list of users by a specific attribute: -(assignedTime) |
|`searchBy` | string | No | Search keyword to use for finding a particular user |

---

### Category: LayoutRules

#### Get Layout Rule

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/layoutrules/layoutrule_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/layoutrules/layoutrule_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a single rule from your help desk layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |
|`layoutRule_id` | string | Yes | Layout Rule ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the rules. Values allowed are: creator and modifier |

---

#### Get Layout Rules for department or layout

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layoutrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layoutrules?departmentId={departmentId}&layoutId={layoutId}&module={module}&activeLayouts={activeLayouts}&activeRules={activeRules}&executeInHelpCentre={executeInHelpCentre}&from={from}&limit={limit}&searchString={searchString}&include={include}&api_token={api_token}
```

**Description**: Get Layout Rules for department or layout

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | Get the rules of the department |
|`layoutId` | number | No | Get the rules of the layout |
|`module` | string | No | Name of the module for which you want to fetch the layout rules. Allowed values are tickets, contacts, accounts, tasks, timeEntry, contracts, products, calls, events |
|`activeLayouts` | boolean | No | Get the rules for active layouts |
|`activeRules` | boolean | No | Get the rules that are active in the layout |
|`executeInHelpCentre` | boolean | No | Get the rules that can be executed in help centre |
|`from` | number | No | Index number, starting from which the rules must be fetched |
|`limit` | number | No | Number of rules to be fetched. Default is 50 |
|`searchString` | string | No | Get the rules that have this search term |
|`include` | string | No | Additional information related to the rules. Values allowed are: creator and modifier |

---

#### Create Layout Rule

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/layoutrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/layoutrules?include={include}&api_token={api_token}
```

**Description**: This API creates a rule for a field in a layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the rules. Values allowed are: creator and modifier |

**Request Body**:
```json
{
  "name": "<string>",
  "fieldName": "<string>",
  "fieldConditions": "<array>"
}
```

---

#### Update Layout Rule

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/layoutrules/layoutrule_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/layoutrules/layoutrule_id?include={include}&api_token={api_token}
```

**Description**: This API updates the details of an existing layout rule in a particular layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |
|`layoutRule_id` | string | Yes | Layout Rule ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the rules. Values allowed are: creator and modifier |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Layout Rule

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/layoutrules/layoutrule_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/layoutrules/layoutrule_id?api_token={api_token}
```

**Description**: This API deletes a layout rule created for a field from a layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |
|`layoutRule_id` | string | Yes | Layout Rule ID |

---

#### List Criteria Fields For Layout Rules

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/layoutrules/criteriafields`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/layoutrules/criteriafields?category={category}&api_token={api_token}
```

**Description**: This API lists the fields that can be used in criteria of a specified module in layout rules

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category` | string | Yes | Category for getting the field criteria for primary or secondary fields |

---

### Category: Layouts

#### List Layouts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts?module={module}&departmentId={departmentId}&status={status}&from={from}&limit={limit}&layoutName={layoutName}&api_token={api_token}
```

**Description**: This API lists all the layouts configured for a module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | Name of the module whose layouts must be fetched. Values allowed are tickets, contacts, accounts, calls, events, tasks, timeEntry, products, and contracts |
|`departmentId` | number | No | ID of the department in which the layouts are configured |
|`status` | string | Yes | Status of the layout. Values allowed are active, inactive, all |
|`from` | number | Yes | From index |
|`limit` | number | Yes | Number of layouts to be fetched. Default is 100 |
|`layoutName` | string | No | Name of the layout used as the keyword for the search. Max length: 200. |

---

#### Get Layout

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id?api_token={api_token}
```

**Description**: This API fetches a layout configured for a module

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

---

#### Clone Layout

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/clone`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/clone?api_token={api_token}
```

**Description**: This API creates new Layout by cloning existing layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Request Body**:
```json
{
  "layoutName": "<string>",
  "layoutDisplayName": "<string>",
  "isDefaultLayout": "<boolean>"
}
```

---

#### Create Layout

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts?api_token={api_token}
```

**Description**: This API creates the layout

**Request Body**:
```json
{
  "isDefaultLayout": "<boolean>",
  "sections": "<array>",
  "module": "<string>"
}
```

---

#### Update Layout

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id?api_token={api_token}
```

**Description**: This API updates details of an existing layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Layout

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id?api_token={api_token}
```

**Description**: This API deletes a layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

---

#### DeActivate Layout

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/deactivate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/deactivate?api_token={api_token}
```

**Description**: This Api deactivates existing layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Request Body**:
```json
{
  "transferToLayoutId": "<number>"
}
```

---

#### Activate Layout

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/activate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/activate?api_token={api_token}
```

**Description**: This api activates the deactivated Layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

---

#### Get Layout Profiles

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/profiles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/profiles?api_token={api_token}
```

**Description**: This api returns the profiles associated with a layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

---

#### Associate Layout profiles

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/profiles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/profiles?api_token={api_token}
```

**Description**: This api Associates the given profiles to the layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Standard Layout Format

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts/standardlayoutformat`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/standardlayoutformat?module={module}&api_token={api_token}
```

**Description**: This Api provides the standrd layout format for the given module with organisations fields that can be used for create layout

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | Name of the module whose layouts must be fetched. Values allowed are tickets, contacts, accounts , calls , events, tasks, timeEntry, products, and contracts |

---

#### Get MyForm

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/myform`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/myform?layoutId={layoutId}&api_token={api_token}
```

**Description**: This API fetches details of a layout, based on the profile of the current user

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layoutId` | number | No | ID of the layout |

---

#### Replace PickList Value in all Existing Records

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/replacevalues`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/replacevalues?api_token={api_token}
```

**Description**: This API replaces the old value with the new value for the PickList field type in all existing records only

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Request Body**:
```json
{
  "fieldId": "<number>",
  "oldValue": "<string>",
  "newValue": "<string>"
}
```

---

#### Update Layout Field

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/fields/field_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/fields/field_id?api_token={api_token}
```

**Description**: This API updates details of a field in the layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |
|`field_id` | string | Yes | Field ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Remove Field in Layout

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/fields/value/unassociate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/fields/value/unassociate?api_token={api_token}
```

**Description**: This API is to remove fields from a layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

---

*Note: Showing 15 of 17 endpoints in this category.*

---

### Category: Locales

#### List all countries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/countries`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/countries?api_token={api_token}
```

**Description**: This API lists the countries that can be set in the locale field in Zoho Desk

---

#### List all languages

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/languages`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/languages?api_token={api_token}
```

**Description**: This API lists the languages that are available for listing in Zoho Desk

---

#### List all time zones

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/timezones`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/timezones?api_token={api_token}
```

**Description**: This API lists the time zones that are available for listing in Zoho Desk

---

### Category: MailConfigurations

#### List department-level MailConfigurations

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments/department_id/mailconfigurations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/mailconfigurations?api_token={api_token}
```

**Description**: This API lists the MailConfigurations set for a specific department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_Id` | string | Yes | Department ID |

---

#### List organization-level MailConfigurations

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/mailconfigurations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailconfigurations?api_token={api_token}
```

**Description**: This API lists the MailConfigurations set for the entire help desk portal

---

#### Update department-level MailConfigurations

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/departments/department_id/mailconfigurations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/mailconfigurations?api_token={api_token}
```

**Description**: This API updates the MailConfigurations set for a specific department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_Id` | string | Yes | Department ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update organization-level MailConfigurations

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/mailconfigurations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailconfigurations?api_token={api_token}
```

**Description**: This API updates the MailConfigurations set for the entire help desk portal

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: MailReplyAddress

#### Get details of a MailReplyAddress

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/mailreplyaddress/mailreplyaddress_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailreplyaddress/mailreplyaddress_id?api_token={api_token}
```

**Description**: This API fetches the details of a MailReplyAddress

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`mailReplyAddress_id` | string | Yes | Mail Reply Address ID |

---

#### List MailReplyAddresses

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/mailreplyaddress`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailreplyaddress?departmentId={departmentId}&isActive={isActive}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists the mailReplyAddresses configured in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the Department from which the addresses need to be queried |
|`isActive` | boolean | No | Key that returns if the mailReplyAddress is active or not |
|`from` | number | No | Index number, starting from which the mail addresses must be fetched |
|`limit` | number | No | Number of mail addresses to fetch, range: 1-100 |

---

#### Add MailReplyAddress

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/mailreplyaddress`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailreplyaddress?api_token={api_token}
```

**Description**: This API adds a MailReplyAddress to your help desk

**Request Body**:
```json
{
  "departmentId": "<number>",
  "address": "<string>",
  "displayName": "<string>"
}
```

---

#### Update MailReplyAddress

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/mailreplyaddress/mailreplyaddress_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailreplyaddress/mailreplyaddress_id?api_token={api_token}
```

**Description**: This API updates details of an existing MailReplyAddress

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`mailReplyAddress_id` | string | Yes | Mail Reply Address ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete MailReplyAddress

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/mailreplyaddress/mailreplyaddress_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailreplyaddress/mailreplyaddress_id?api_token={api_token}
```

**Description**: This API deletes a MailReplyAddress from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`mailReplyAddress_id` | string | Yes | Mail Reply Address ID |

---

#### Send Verification Mail

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/mailreplyaddress/mailreplyaddress_id/sendverification`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mailreplyaddress/mailreplyaddress_id/sendverification?api_token={api_token}
```

**Description**: This API sends a verification link to the MailReplyAddress configured in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`mailReplyAddress_id` | string | Yes | Mail Reply Address ID |

---

### Category: Modules

#### Get All Modules

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizationmodules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationmodules?api_token={api_token}
```

**Description**: This API fetches all the modules

---

#### Get a Module

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizationmodules/module_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationmodules/module_id?api_token={api_token}
```

**Description**: This API fetches a single Module

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_id` | string | Yes | Module Id |

---

#### Get modules accessible to current user profile

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/myaccessiblemodules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/myaccessiblemodules?api_token={api_token}
```

**Description**: This API fetches a list of modules that are accessible to the current user profile

---

#### Create Custom Module

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/organizationmodules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationmodules?api_token={api_token}
```

**Description**: This API creates a Custom Module

**Request Body**:
```json
{
  "name": "<string>"
}
```

---

#### Edit Custom Module

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v1/organizationmodules/module_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationmodules/module_id?api_token={api_token}
```

**Description**: This API edits a Custom Module

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module_id` | string | Yes | Module Id |

**Request Body**:
```json
{
  "singularLabel": "<string>",
  "pluralLabel": "<string>",
  "departmentIds": "<array>",
  "profileIds": "<array>"
}
```

---

### Category: Notification

#### List email delivery failure alerts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/emailfailurealerts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/emailfailurealerts?department={department}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists the email delivery failure alerts configured in a particular department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department` | string | Yes | ID of the department from which the email delivery failure alerts must be fetched |
|`from` | number | No | Index number, starting from which the alerts must be listed |
|`limit` | number | No | Number of alerts to list |

---

#### Clear email delivery failure alerts

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/emailfailurealerts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/emailfailurealerts?department={department}&api_token={api_token}
```

**Description**: This API deletes all email delivery failure alerts configured in a particular department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department` | string | Yes | ID of the department from which the email delivery failure alerts must be deleted |

---

#### Get my pending approvals

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/mypendingapprovals`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/mypendingapprovals?from={from}&department={department}&limit={limit}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API lists the pending approvals for a given user

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the pending approvals for a give user must be fetched |
|`department` | string | Yes | ID of the department from which pending approvals must be fetched |
|`limit` | number | Yes | Number of pending approvals to list |
|`sortBy` | string | No | The default sorting order is ascending |

---

### Category: OrganizationFields

#### Get organization fields in a module

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizationfields`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields?module={module}&apiNames={apiNames}&departmentId={departmentId}&api_token={api_token}
```

**Description**: This API fetches fields in a module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | The module name within which search is to be done. Value may be tickets, contacts, accounts, tasks, calls, events, timeEntry, products, contracts, agents |
|`apiNames` | string | No | Key that fetches only the fields whose apiNames are given. Multiple values can be passed, separated by commas |
|`departmentId` | number | No | Key that fetches only the fields for the given departmentId |

---

#### Create Field

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/organizationfields`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields?module={module}&api_token={api_token}
```

**Description**: This API creates a field

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | Name of the module whose fields must be fetched. Values allowed are tickets, contacts, accounts, tasks, timeEntry, products , calls , events, and contracts |

**Request Body**:
```json
{
  "displayLabel": "<string>",
  "type": "<string>"
}
```

---

#### Edit Field

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/organizationfields/field_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields/field_id?api_token={api_token}
```

**Description**: This API edits a field

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`field_id` | string | Yes | Field ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get Field

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizationfields/field_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields/field_id?api_token={api_token}
```

**Description**: This API get a field

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`field_id` | string | Yes | Field ID |

---

#### Get Field Permissions

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizationfields/field_id/permissions`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields/field_id/permissions?api_token={api_token}
```

**Description**: This API get a field permissions for all the profiles

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`field_id` | string | Yes | Field ID |

---

#### Update Field Permissions

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/organizationfields/field_id/permissions`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields/field_id/permissions?api_token={api_token}
```

**Description**: This API update field permissions

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`field_id` | string | Yes | Field ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Field

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/organizationfields/field_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields/field_id?api_token={api_token}
```

**Description**: This API delete a custom field

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`field_id` | string | Yes | Field ID |

---

#### Get organization custom fields count in a module

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/customfieldcount`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/customfieldcount?module={module}&api_token={api_token}
```

**Description**: This API returns the custom field count allowed and available in a module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | Name of the module whose allowed and available custom fields must be fetched. Values allowed are tickets, contacts, accounts, tasks, calls, events, timeEntry, products, and contracts |

---

#### Get organization custom fields criteria references

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizationfields/field_id/criteriareferences`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizationfields/field_id/criteriareferences?featureType={featureType}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches criteria references of a custom field

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`field_id` | string | Yes | Field ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`featureType` | string | Yes | Feature name from which criteria references has to be fetched - DirectAssignment, RoundRobin, WorkFlow, SLA, Supervise, BluePrint, CustomView, Report, GameTrophy, GameBadge, LayoutRules, ValidationRules |
|`from` | number | Yes | Index number, starting from which the rules must be listed |
|`limit` | number | Yes | Number of references to fetch |

---

### Category: Organizations

#### Get organization

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id?includeCustomDomain={includeCustomDomain}&api_token={api_token}
```

**Description**: This API fetches the details of an organization from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`includeCustomDomain` | boolean | No | Key that denotes if the customDomain field must be included in the API response |

---

#### Get all organizations

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations?api_token={api_token}
```

**Description**: This API lists all organizations to which the current user belongs

---

#### Get accessible organizations

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accessibleorganizations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accessibleorganizations?api_token={api_token}
```

**Description**: This API lists all organizations which can be accessed using the current Oauth token

---

#### Update organization

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id?api_token={api_token}
```

**Description**: This API updates the details of an organization

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get organization logo

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id/logo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id/logo?no-cache={no-cache}&fileSize={fileSize}&api_token={api_token}
```

**Description**: This API fetches the logo set for an organization/portal in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`no-cache` | string | No | Key that helps avoid browser cache |
|`fileSize` | string | No | Size of the image file to download |

---

#### Get organization favicon

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id/favicon`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id/favicon?no-cache={no-cache}&fileSize={fileSize}&api_token={api_token}
```

**Description**: This API fetches the favicon set for an organization/portal in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`no-cache` | string | No | Key that helps avoid browser cache |
|`fileSize` | string | No | Size of the image file to download |

---

#### Update organization logo

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id/logo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id/logo?api_token={api_token}
```

**Description**: This API updates the logo set for an organization/portal in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update organization favicon

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id/favicon`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id/favicon?api_token={api_token}
```

**Description**: This API updates the favicon set for an organization/portal in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete organization logo

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id/logo`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id/logo?api_token={api_token}
```

**Description**: This API deletes the logo set for an organization/portal in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

---

#### Delete organization favicon

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/organizations/organization_id/favicon`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/organization_id/favicon?api_token={api_token}
```

**Description**: This API updates the favicon set for an organization/portal in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`organization_id` | string | Yes | Organization ID |

---

#### Update default organization

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/organizations/markdefault`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/organizations/markdefault?api_token={api_token}
```

**Description**: This API updates the default organization for the current user in Zoho Desk

**Request Body**:
```json
{
  "id": "<number>"
}
```

---

### Category: Product Attachments

#### List all attachments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/products/product_id/attachments
`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/product_id/attachments
?sortBy={sortBy}&from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: This API lists all attachments in a product

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sortBy` | string | No | Sort by the createdTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`from` | number | No | From Index |
|`limit` | number | No | The number of attachments to be displayed |
|`include` | string | No | Secondary information related to the attachments. Value allowed is creator, which returns the details of users who added the attachments |

---

#### Create an attachment

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/products/product_id/attachments
`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/product_id/attachments
?api_token={api_token}
```

**Description**: This API attaches a file to a product

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete an attachment

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/products/product_id/attachments/attachment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/product_id/attachments/attachment_id?api_token={api_token}
```

**Description**: This API deletes an attachment from a product

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |
|`attachment_id` | string | Yes | Attachment ID |

---

### Category: Products

#### Get product

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/products/product_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/product_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a single product from your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Max chars : 100. Key that fetches secondary information related to the product. Values allowed are: departments and owner. You can pass multiple values by separating them with commas. |

---

#### List products

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/products`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products?viewId={viewId}&from={from}&limit={limit}&departmentId={departmentId}&ownerId={ownerId}&sortBy={sortBy}&fields={fields}&include={include}&api_token={api_token}
```

**Description**: This API lists a specific number of products from your help desk portal, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`viewId` | number | No | ID of the view to apply while fetching the products |
|`from` | number | No | Index number starting from which the products must be fetched |
|`limit` | number | No | No |
|`departmentId` | number | No | ID of the department from which the products must be fetched |
|`ownerId` | number | No | ID of user to whom the product is assigned |
|`sortBy` | string | No | Sort by a specific attribute : productName productCode unitPrice createdTime or modifiedTime |
|`fields` | string | No | Key that returns the values of mentioned fields (both pre-defined and custom) in your portal |
|`include` | array | No | Secondary information related to the contact |

---

#### Create product

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/products`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products?api_token={api_token}
```

**Description**: This API adds a product to your helpdesk

**Request Body**:
```json
{
  "departmentIds": "<array>"
}
```

---

#### List tickets by products

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/products/product_id/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/product_id/tickets?departmentId={departmentId}&from={from}&limit={limit}&sortBy={sortBy}&dueDate={dueDate}&isSpam={isSpam}&include={include}&api_token={api_token}
```

**Description**: This API lists tickets received from a specific products

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department from which the tickets must be fetched |
|`from` | number | No | Index number starting from which the tickets must be fetched |
|`limit` | number | No | Number of tickets to fetch |
|`sortBy` | string | No | Sort by a specific attribute: createdTime or modifiedTime |
|`dueDate` | string | No | Filter by ticket duedate |
|`isSpam` | boolean | No | Filters Spam tickets |
|`include` | string | No | Additional information related to the tickets |

---

#### Update product

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/products/product_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/product_id?api_token={api_token}
```

**Description**: This API updates details of a product in your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Move Products to trash

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/products/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/movetotrash?api_token={api_token}
```

**Description**: This API moves products to the Recycle Bin of your help desk portal

**Request Body**:
```json
{
  "productIds": "<array>"
}
```

---

#### Search for duplicate records

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/products/searchduplicates`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/searchduplicates?from={from}&limit={limit}&productName={productName}&api_token={api_token}
```

**Description**: This API searches for duplicate records of a product

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the products must be fetched |
|`limit` | number | No | No |
|`productName` | string | Yes | Name of the product used as the keyword for the search |

---

#### Associate contacts with a product

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/products/product_id/associatecontacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/products/product_id/associatecontacts?api_token={api_token}
```

**Description**: This API associates contacts with a product

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Request Body**:
```json
{
  "ids": "<array>",
  "associate": "<boolean>"
}
```

---

#### Associate accounts with a product

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/products/product_id/associateaccounts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/products/product_id/associateaccounts?api_token={api_token}
```

**Description**: This API associates accounts with a product

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Request Body**:
```json
{
  "ids": "<array>",
  "associate": "<boolean>"
}
```

---

#### List accounts associated with product

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/products/products_id/accounts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/products/products_id/accounts?from={from}&limit={limit}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API lists the accounts associated with a product

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the accounts must be fetched |
|`limit` | number | No | Number of accounts to fetch |
|`sortBy` | string | No | Key that sorts the accounts by a specific attribute: accountName or createdTime |

---

#### List contacts associated with product

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/products/products_id/contacts`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/products/products_id/contacts?from={from}&limit={limit}&sortBy={sortBy}&include={include}&isSpam={isSpam}&api_token={api_token}
```

**Description**: This API lists the contacts associated with a product

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`product_id` | string | Yes | Product ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the contacts must be listed |
|`limit` | number | No | Number of accounts to fetch |
|`sortBy` | string | No | Parameter that sorts contacts |
|`include` | array | No | Key that fetches secondary information related to the contact |
|`isSpam` | boolean | No | Filters Spam contacts |

---

### Category: Profiles

#### List profiles

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/profiles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/profiles?visible={visible}&default={default}&searchStr={searchStr}&api_token={api_token}
```

**Description**: This API lists a particular number of user profiles, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`visible` | boolean | No | Key that filters profiles according to their visibility in the UI |
|`default` | boolean | No | Key that denotes whether the profiles must be default profiles or custom profiles |
|`searchStr` | string | No | String to search for profile by name or description |

---

#### Get profile count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/profiles/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/profiles/count?visible={visible}&default={default}&api_token={api_token}
```

**Description**: This API fetches the number of profiles configured in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`visible` | boolean | No | Key that filters profiles according to their visibility in the UI |
|`default` | boolean | No | Key that denotes whether the profiles must be default profiles or custom profiles |

---

#### Get profile

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/profiles/profile_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/profiles/profile_id?api_token={api_token}
```

**Description**: This API fetches the details of a particular profile

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`profile_id` | string | Yes | Profile ID |

---

#### Clone profile

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/profiles/profile_id/clone`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/profiles/profile_id/clone?api_token={api_token}
```

**Description**: This API replicates an existing profile

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`profile_id` | string | Yes | Profile ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update profile

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/profiles/profile_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/profiles/profile_id?api_token={api_token}
```

**Description**: This API updates the details of an existing profile

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`profile_id` | string | Yes | Profile ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete profile

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/profiles/profile_id/delete`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/profiles/profile_id/delete?api_token={api_token}
```

**Description**: This API deletes a profile from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`profile_id` | string | Yes | Profile ID |

**Request Body**:
```json
{
  "transferToProfileId": "<number>"
}
```

---

#### Get my profile details

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/myprofile`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/myprofile?api_token={api_token}
```

**Description**: This API fetches the configuration details and permissions defined for the profile of the currently logged in user

---

#### Get my profile permissions

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/myprofilepermissions`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/myprofilepermissions?api_token={api_token}
```

**Description**: This API fetches the permissions associated with the profile of the currently logged in user

---

#### List agents by profile

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/profiles/profile_id/agents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/profiles/profile_id/agents?active={active}&confirmed={confirmed}&api_token={api_token}
```

**Description**: This API lists agents mapped to a particular profile

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`profile_id` | string | Yes | Profile ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`active` | boolean | No | Activation status of the agents to list |
|`confirmed` | boolean | No | Confirmation status of the agents to list |

---

#### Get light agent profile

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/lightagentprofile`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/lightagentprofile?api_token={api_token}
```

**Description**: This API fetches the different permissions configured for the light agent profile

---

### Category: Recycle Bin

#### List deleted resources

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/recyclebin`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/recyclebin?from={from}&limit={limit}&departmentId={departmentId}&sortBy={sortBy}&include={include}&module={module}&api_token={api_token}
```

**Description**: This API lists a particular number of deleted resources, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the resources must be fetched |
|`limit` | number | No | Number of resources to list |
|`departmentId` | number | No | ID of the department to which the deleted resources belong |
|`sortBy` | string | No | Sort by a specific attribute: name, type, department, deletedBy, or deletedTime |
|`include` | string | No | Additional information related to the resources |
|`module` | string | No | Filter by a specific module: accounts, contacts, tickets, tasks, timeEntry, calls, events, contracts, products, topics, or solutions |

---

#### Restore deleted resources

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/recyclebin/restore`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/recyclebin/restore?api_token={api_token}
```

**Description**: This API restores the deleted resources specified in the API request

**Request Body**:
```json
{
  "ids": "<list>"
}
```

---

#### Restore all resources from Recycle Bin

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/recyclebin/restoreall`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/recyclebin/restoreall?api_token={api_token}
```

**Description**: This API restores all deleted resources from the Recycle Bin

---

#### Delete resources from Recycle Bin

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/recyclebin/delete`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/recyclebin/delete?api_token={api_token}
```

**Description**: This API permanently deletes the resources specified in the API request

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Delete all resources from Recycle Bin

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/recyclebin/deleteall`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/recyclebin/deleteall?api_token={api_token}
```

**Description**: This API permanently deletes all resources from the Recycle Bin

---

### Category: Roles

#### List roles

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/roles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles?from={from}&limit={limit}&isVisible={isVisible}&isDefault={isDefault}&searchStr={searchStr}&api_token={api_token}
```

**Description**: This API lists a particular number of roles, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the roles must be listed |
|`limit` | number | No | Number of roles to display |
|`isVisible` | boolean | No | Key that filters roles according to their visibility in the UI |
|`isDefault` | boolean | No | Key that denotes whether the roles must be default roles or custom roles |
|`searchStr` | string | No | String to search for roles by name or description |

---

#### List agents by role

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/roles/role_id/agents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles/role_id/agents?api_token={api_token}
```

**Description**: This API lists agents mapped to a particular role

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`role_id` | string | Yes | Role ID |

---

#### Create role

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/roles`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles?api_token={api_token}
```

**Description**: This API creates a role in your help desk

**Request Body**:
```json
{
  "name": "<string>",
  "shareDataWithPeers": "<boolean>"
}
```

---

#### Update role

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/roles/role_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles/role_id?api_token={api_token}
```

**Description**: This API updates details of an existing role

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`role_id` | string | Yes | Role ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete role

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/roles/role_id/delete`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles/role_id/delete?api_token={api_token}
```

**Description**: This API deletes a role from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`role_id` | string | Yes | Role ID |

**Request Body**:
```json
{
  "transferToRoleId": "<number>"
}
```

---

#### Get role

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/roles/role_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles/role_id?api_token={api_token}
```

**Description**: This API fetches the details of a particular role

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`role_id` | string | Yes | Role ID |

---

#### Get role count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/roles/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles/count?isVisible={isVisible}&isDefault={isDefault}&api_token={api_token}
```

**Description**: This API fetches the number of roles configured in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`isVisible` | boolean | No | Key that filters roles according to their visibility in the UI |
|`isDefault` | boolean | No | Key that denotes whether the roles must be default roles or custom roles |

---

#### Get personal role

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/personalrole`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/personalrole?api_token={api_token}
```

**Description**: This API fetches the details of the personal role configured in your help desk

---

#### List roles by role IDs

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/rolesbyids`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/rolesbyids?roleIds={roleIds}&api_token={api_token}
```

**Description**: This API lists details of the roles whose IDs are passed in the API request

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`roleIds` | number | Yes | Comma separated role ids |

---

### Category: RoutingPreference

#### Get Routing Preferences

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/routingpreferences`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/routingpreferences?departmentId={departmentId}&api_token={api_token}
```

**Description**: This API is used to Get the Routing Preferences for a Department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the Department |

---

#### Update Routing Preferences

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/routingpreferences`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/routingpreferences?api_token={api_token}
```

**Description**: This API is used to Update the Routing Preferences for a Department

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: Search

#### Search across modules

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/search?searchStr={searchStr}&module={module}&departmentId={departmentId}&from={from}&limit={limit}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API returns information from all modules or a specific module, based on the value of the module query param

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`searchStr` | string | No | Keyword or phrase to search |
|`module` | string | No | Module to search in: tickets accounts contacts or tasks |
|`departmentId` | number | No | ID of the department from which the resource must be fetched |
|`from` | number | No | Index number starting from which the resources must be searched |
|`limit` | number | No | Number of resources to return in the search result |
|`sortBy` | string | No | Sort by a specific attribute: relevance or modifiedTime |

---

#### Tickets Search API

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/search?from={from}&limit={limit}&departmentId={departmentId}&id={id}&ticketNumber={ticketNumber}&subject={subject}&description={description}&status={status}&priority={priority}&email={email}&phone={phone}&channel={channel}&category={category}&assigneeId={assigneeId}&contactId={contactId}&accountId={accountId}&productId={productId}&contactName={contactName}&accountName={accountName}&productName={productName}&tag={tag}&_all={_all}&customField1={customField1}&customField2={customField2}&customField3={customField3}&customField4={customField4}&customField5={customField5}&customField6={customField6}&customField7={customField7}&customField8={customField8}&customField9={customField9}&customField10={customField10}&customerResponseTimeRange={customerResponseTimeRange}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&dueDateRange={dueDateRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for tickets in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index, starts from 0 |
|`limit` | number | No | No. of entities to fetch |
|`departmentId` | number | No | ID of the department from which the entity must be fetched |
|`id` | number | No | ID of the ticket exact match |
|`ticketNumber` | string | No | Serial number of the ticket in the help desk exact match |
|`subject` | string | No | subject of the ticket in the help desk wildcard search |
|`description` | string | No | description of the ticket in the help desk wildcard search |
|`status` | string | No | Status of the ticket. Includes the custom statuses that exist in your help desk exact match |
|`priority` | string | No | Priority of the ticket exact match |
|`email` | string | No | Email ID in the ticket wildcard search, empty check, not empty check |
|`phone` | string | No | Phone number in the ticket wildcard search, empty check, not empty check |
|`channel` | string | No | Channel through which the ticket was received exact match, empty check, not empty check |
|`category` | string | No | Category in the ticket wildcard search, empty check, not empty check |
|`assigneeId` | number | No | ID of the agent assigned to resolve the ticket exact match |
|`contactId` | number | No | ID of the contact who raised the ticket exact match |
|`accountId` | number | No | ID of the account associated with the ticket exact match |
|`productId` | number | No | ID of the product associated with the ticket exact match |
|`contactName` | string | No | Name of the contact who raised the ticket wildcard search |
|`accountName` | string | No | Name of the account associated with the ticket wildcard search, empty check, not empty check |
|`productName` | string | No | Name of the product associated with the ticket wildcard search, empty check, not empty check |
|`tag` | string | No | Tag in the ticket wildcard search, empty check, not empty check |
|`_all` | string | No | Search throughout the ticket wildcard search |
|`customField1` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField2` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField3` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField4` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField5` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField6` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField7` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField8` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField9` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customField10` | string | No | Custom field in the ticket wildcard search, empty check, not empty check |
|`customerResponseTimeRange` | string | No | Key that filters tickets in which customer responses were recorded in a particular period of time |
|`createdTimeRange` | string | No | Key that filters tickets created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters tickets modified in a particular period of time |
|`dueDateRange` | string | No | Key that filters tickets due in a particular period of time |
|`sortBy` | string | No | SortBy can be:relevance, modifiedTime, createdTime,customerResponseTime |

---

#### Search accounts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/accounts/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/accounts/search?from={from}&limit={limit}&id={id}&accountName={accountName}&_all={_all}&customField1={customField1}&customField2={customField2}&customField3={customField3}&customField4={customField4}&customField5={customField5}&customField6={customField6}&customField7={customField7}&customField8={customField8}&customField9={customField9}&customField10={customField10}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for accounts in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index, starts from 0 |
|`limit` | number | No | No. of entities to fetch |
|`id` | number | No | ID of the account exact match |
|`accountName` | string | No | Name of the account wildcard search |
|`_all` | string | No | Search throughout the account wildcard search |
|`customField1` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField2` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField3` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField4` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField5` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField6` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField7` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField8` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField9` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`customField10` | string | No | Custom field in the account wildcard search, empty check, not empty check |
|`createdTimeRange` | string | No | Key that filters account created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters account modified in a particular period of time |
|`sortBy` | string | No | SortBy can be:relevance, modifiedTime, createdTime, accountName |

---

#### Search Contacts

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/contacts/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/contacts/search?from={from}&limit={limit}&id={id}&fullName={fullName}&firstName={firstName}&lastName={lastName}&email={email}&phone={phone}&mobile={mobile}&accountName={accountName}&_all={_all}&customField1={customField1}&customField2={customField2}&customField3={customField3}&customField4={customField4}&customField5={customField5}&customField6={customField6}&customField7={customField7}&customField8={customField8}&customField9={customField9}&customField10={customField10}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for contacts in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index, starts from 0 |
|`limit` | number | No | No. of entities to fetch |
|`id` | number | No | ID of the ticket exact match |
|`fullName` | string | No | Full name of the contact wildcard search |
|`firstName` | string | No | subject of the ticket in the help desk wildcard search, empty check, not empty check |
|`lastName` | string | No | Last name of the contact wildcard search |
|`email` | string | No | Email ID of the contact wildcard search, empty check, not empty check |
|`phone` | string | No | Phone number of the contact wildcard search, empty check, not empty check |
|`mobile` | string | No | Mobile number of the contact wildcard search, empty check, not empty check |
|`accountName` | string | No | Name of the account associated with the Contact wildcard search, empty check, not empty check |
|`_all` | string | No | Search throughout the contact wildcard search |
|`customField1` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField2` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField3` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField4` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField5` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField6` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField7` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField8` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField9` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`customField10` | string | No | Custom field in the Contact wildcard search, empty check, not empty check |
|`createdTimeRange` | string | No | Key that filters contacts created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters contacts modified in a particular period of time |
|`sortBy` | string | No | SortBy can be: relevance, modifiedTime, createdTime,lastName, firstName |

---

#### Article Search API

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/articles/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/articles/search?from={from}&limit={limit}&departmentId={departmentId}&id={id}&title={title}&categoryName={categoryName}&categoryId={categoryId}&tag={tag}&_all={_all}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for help articles in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index, starts from 0 |
|`limit` | number | No | No. of entities to fetch |
|`departmentId` | number | No | ID of the department from which the entity must be fetched |
|`id` | number | No | ID of the articles exact match |
|`title` | string | No | title of the help article wildcard search |
|`categoryName` | string | No | Name of the Category wildcard search |
|`categoryId` | number | No | ID of the Category |
|`tag` | string | No | Tag in the articles wildcard search, empty check, not empty check |
|`_all` | string | No | Key that includes all article details for the search wildcard search |
|`createdTimeRange` | string | No | Key that filters articles created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters articles modified in a particular period of time |
|`sortBy` | string | No | SortBy can be:relevance, modifiedTime, createdTime |

---

#### Search Tasks

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/search?from={from}&limit={limit}&departmentId={departmentId}&id={id}&subject={subject}&ticketNumber={ticketNumber}&status={status}&priority={priority}&assigneeId={assigneeId}&_all={_all}&customField1={customField1}&customField2={customField2}&customField3={customField3}&customField4={customField4}&customField5={customField5}&customField6={customField6}&customField7={customField7}&customField8={customField8}&customField9={customField9}&customField10={customField10}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&dueDateRange={dueDateRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for tasks in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index, starts from 0 |
|`limit` | number | No | No. of entities to fetch |
|`departmentId` | number | No | ID of the department from which the entity must be fetched if not passed then searches in permitted departments exact match |
|`id` | number | No | ID of the task exact match |
|`subject` | string | No | subject of the task in the help desk wildcard search |
|`ticketNumber` | string | No | ticket Number of the ticket that associated with the task exact match |
|`status` | string | No | status of the task exact match |
|`priority` | string | No | Priority of the task exact match |
|`assigneeId` | number | No | ID of the agent assigned to resolve the task exact match |
|`_all` | string | No | Search throughout the task wildcard search |
|`customField1` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField2` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField3` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField4` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField5` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField6` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField7` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField8` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField9` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`customField10` | string | No | Custom field in the task wildcard search, empty check, not empty check |
|`createdTimeRange` | string | No | Key that filters tasks created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters tasks modified in a particular period of time |
|`dueDateRange` | string | No | Key that filters tasks due in a particular period of time |
|`sortBy` | string | No | SortBy can be:relevance, modifiedTime, createdTime |

---

#### Call Search API

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/calls/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/calls/search?from={from}&limit={limit}&departmentId={departmentId}&id={id}&subject={subject}&ticketNumber={ticketNumber}&status={status}&priority={priority}&assigneeId={assigneeId}&_all={_all}&customField1={customField1}&customField2={customField2}&customField3={customField3}&customField4={customField4}&customField5={customField5}&customField6={customField6}&customField7={customField7}&customField8={customField8}&customField9={customField9}&customField10={customField10}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&startDateRange={startDateRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for calls in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the calls must be fetched |
|`limit` | number | No | Number of calls to fetch |
|`departmentId` | number | No | ID of the department from which the call must be fetched |
|`id` | number | No | ID of the call exact match |
|`subject` | string | No | subject of the call wildcard search |
|`ticketNumber` | string | No | Ticket number of the ticket associated with the call exact match |
|`status` | string | No | Status of the call exact match |
|`priority` | string | No | Priority of the call exact match |
|`assigneeId` | number | No | ID of the agent assigned to handle the call exact match |
|`_all` | string | No | Key that includes all call details for the search wildcard search |
|`customField1` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField2` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField3` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField4` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField5` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField6` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField7` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField8` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField9` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`customField10` | string | No | Custom field in the call wildcard search, empty check, not empty check |
|`createdTimeRange` | string | No | Key that filters calls recorded in the help desk in a particular period |
|`modifiedTimeRange` | string | No | Key that filters calls whose details were modified in a particular period |
|`startDateRange` | string | No | Key that filters calls that were made in a particular period |
|`sortBy` | string | No | SortBy can be:relevance, modifiedTime, createdTime |

---

#### Event Search API

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/events/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/events/search?from={from}&limit={limit}&departmentId={departmentId}&id={id}&subject={subject}&ticketNumber={ticketNumber}&status={status}&priority={priority}&assigneeId={assigneeId}&_all={_all}&customField1={customField1}&customField2={customField2}&customField3={customField3}&customField4={customField4}&customField5={customField5}&customField6={customField6}&customField7={customField7}&customField8={customField8}&customField9={customField9}&customField10={customField10}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&startDateRange={startDateRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for events in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the events must be fetched, starts from 0 |
|`limit` | number | No | Number of events to fetch |
|`departmentId` | number | No | ID of the department from which the event must be fetched |
|`id` | number | No | ID of the event exact match |
|`subject` | string | No | Subject of the event wildcard search |
|`ticketNumber` | string | No | Ticket number of the ticket associated with the event exact match |
|`status` | string | No | Status of the event exact match |
|`priority` | string | No | Priority of the event exact match |
|`assigneeId` | number | No | ID of the agent assigned to handle the event exact match |
|`_all` | string | No | Key that includes all event details for the search wildcard search |
|`customField1` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField2` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField3` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField4` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField5` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField6` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField7` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField8` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField9` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`customField10` | string | No | Custom field in the event wildcard search, empty check, not empty check |
|`createdTimeRange` | string | No | Key that filters events recorded in the help desk in a particular period |
|`modifiedTimeRange` | string | No | Key that filters events whose details were modified in a particular period |
|`startDateRange` | string | No | Key that filters events that were made in a particular period |
|`sortBy` | string | No | SortBy can be:relevance, modifiedTime, createdTime |

---

#### Products Search API

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/products/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/products/search?from={from}&limit={limit}&departmentId={departmentId}&id={id}&productName={productName}&productCode={productCode}&contactId={contactId}&accountId={accountId}&_all={_all}&customField1={customField1}&customField2={customField2}&customField3={customField3}&customField4={customField4}&customField5={customField5}&customField6={customField6}&customField7={customField7}&customField8={customField8}&customField9={customField9}&customField10={customField10}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for products in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | From index, starts from 0 |
|`limit` | number | No | No. of entities to fetch |
|`departmentId` | number | No | ID of the department from which the entity must be fetched if not passed then searches in permitted departments exact match |
|`id` | number | No | ID of the Product exact match |
|`productName` | string | No | Name of the Product wildcard search |
|`productCode` | string | No | Code of the product wildcard search, empty check, not empty check |
|`contactId` | number | No | ID of the contact associated with the product exact match |
|`accountId` | number | No | ID of the account associated with the product exact match |
|`_all` | string | No | Search throughout the product wildcard search |
|`customField1` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField2` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField3` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField4` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField5` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField6` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField7` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField8` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField9` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`customField10` | string | No | Custom field in the Product wildcard search, empty check, not empty check |
|`createdTimeRange` | string | No | Key that filters products created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters products modified in a particular period of time |
|`sortBy` | string | No | SortBy can be:relevance, modifiedTime, createdTime, productName |

---

#### Search Activities

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/activities/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/activities/search?from={from}&limit={limit}&departmentId={departmentId}&id={id}&subject={subject}&ticketNumber={ticketNumber}&status={status}&priority={priority}&assigneeId={assigneeId}&_all={_all}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API searches for activities in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the activities must be fetched, starts from 0 |
|`limit` | number | No | Number of activities to list |
|`departmentId` | number | No | ID of the department from which the activity must be fetched. If you do not pass a value for this parameter, the search is performed in all permitted departments Exact match |
|`id` | number | No | ID of the activity Exact match |
|`subject` | string | No | Subject of the activity Wildcard search |
|`ticketNumber` | string | No | Serial number of the ticket associated with the activity Exact match |
|`status` | string | No | Completion status of the activity Exact match |
|`priority` | string | No | Priority of the activity Exact match |
|`assigneeId` | number | No | ID of the agent assigned to handle the activity Exact match |
|`_all` | string | No | Key that searches across all fields in all activities Wildcard search |
|`createdTimeRange` | string | No | Key that filters activities created in a particular period of time Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, createdTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z |
|`modifiedTimeRange` | string | No | Key that filters activities whose details were modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ; for example, modifiedTimeRange=2017-11-05T00:00:00.000Z,2018-09-05T23:59:00.000Z |
|`sortBy` | string | No | SortBy can be: relevance, modifiedTime, createdTime |

---

### Category: SkillConfiguration

#### Get Skill Configuration

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/skillconfiguration`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skillconfiguration?departmentId={departmentId}&api_token={api_token}
```

**Description**: This API gets Configuration of Skill in a Department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | Department Id |

---

#### Update Skill Configuration

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/skillconfiguration`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skillconfiguration?api_token={api_token}
```

**Description**: This API updates Configuration of Skill in a Department

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: SkillTypes

#### Create Skill Type

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/skilltypes`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skilltypes?api_token={api_token}
```

**Description**: This API Creates a Skill Type

**Request Body**:
```json
{
  "name": "<string>",
  "departmentId": "<number>"
}
```

---

#### View Skill Type

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/skilltypes/skiltype_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skilltypes/skiltype_id?api_token={api_token}
```

**Description**: This API Gets the details of a Skill Type

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`skilType_id` | string | Yes | Skil Type ID |

---

#### Update a Skill Type

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/skilltypes/skiltype_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skilltypes/skiltype_id?api_token={api_token}
```

**Description**: This API Updates a Skill Type

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`skilType_id` | string | Yes | Skil Type ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a Skill Type

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/skilltypes/skiltype_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skilltypes/skiltype_id?api_token={api_token}
```

**Description**: This API Deletes a Skill Type

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`skilType_id` | string | Yes | Skil Type ID |

---

#### List all Skill Types

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/skilltypes`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skilltypes?departmentId={departmentId}&from={from}&limit={limit}&mappedSkillsStatus={mappedSkillsStatus}&api_token={api_token}
```

**Description**: This API Lists all Skill Types in a department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | Department Id |
|`from` | number | No | Index number, starting from which the skills must be listed |
|`limit` | number | No | Number of skilltypes to list |
|`mappedSkillsStatus` | string | No | Filter skill types by associated skills status |

---

### Category: Skills

#### Create skill

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/skills`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills?api_token={api_token}
```

**Description**: This API Creates a skill

**Request Body**:
```json
{
  "name": "<string>",
  "status": "<string>",
  "skillTypeId": "<number>",
  "criteria": "<array>"
}
```

---

#### View skill

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/skills/skill_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills/skill_id?api_token={api_token}
```

**Description**: This API Gets the details of a skill

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`skill_id` | string | Yes | skill ID |

---

#### Update skill

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/skills/skill_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills/skill_id?api_token={api_token}
```

**Description**: This API Updates a skill

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`skill_id` | string | Yes | skill ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete skill

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/skills/skill_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills/skill_id?api_token={api_token}
```

**Description**: This API deletes a skill from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`skill_id` | string | Yes | skill ID |

---

#### List all skills

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/skills`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills?departmentId={departmentId}&from={from}&limit={limit}&status={status}&searchString={searchString}&skillTypeId={skillTypeId}&api_token={api_token}
```

**Description**: This API lists all skills in a department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | Department Id |
|`from` | number | No | Index number, starting from which the skills must be listed |
|`limit` | number | No | Number of skills to list |
|`status` | string | No | Active inactive filter for Skills. Values allowed are ACTIVE and INACTIVE |
|`searchString` | string | No | Search string. Used to filter skills by name starting with this string |
|`skillTypeId` | number | No | Skill Type Id. Used to filter skills by SkillType |

---

#### List associated automation rules

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/skills/skill_id/relatedrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills/skill_id/relatedrules?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of automation rules that include a skill,based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`skill_id` | string | Yes | skill ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the related rules must be listed |
|`limit` | number | No | Number of rules to list |

---

#### Reorder Skills in a Department

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/skills/order`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills/order?api_token={api_token}
```

**Description**: This API lists reorders Skills in a Department

**Request Body**:
```json
{
  "skillIds": "<array>",
  "departmentId": "<number>"
}
```

---

#### Get Skills of an Agent

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/skills`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/skills?departmentIds={departmentIds}&api_token={api_token}
```

**Description**: Returns skills mapped with an agent by department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentIds` | number | Yes | List of Department Ids separated by commas. Maximum 10 department ids allowed |

---

#### Map Skills in a Department with an Agent

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/mapskills`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/mapskills?api_token={api_token}
```

**Description**: This API modifies skills mapped for an agent in a department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

**Request Body**:
```json
{
  "departmentId": "<number>"
}
```

---

#### Get Criteria Fields for Skill in a Department

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/skills/criteriafields`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/skills/criteriafields?departmentId={departmentId}&module={module}&api_token={api_token}
```

**Description**: This API returns list of fields supported in criteria for Skills by module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | Department Id |
|`module` | string | Yes | Module |

---

### Category: Subject Access Requests

#### List subject access requests

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/subjectaccessrequests`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/subjectaccessrequests?from={from}&limit={limit}&contactEmailId={contactEmailId}&status={status}&duration={duration}&startTime={startTime}&endTime={endTime}&requestType={requestType}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of subject access requests, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the requests must be fetched |
|`limit` | number | No | Number of requests to list. The default value is 10 and the maximum value supported is 100. |
|`contactEmailId` | string | No | Email ID of the contact who made the request. |
|`status` | string | No | Processing status of the request |
|`duration` | string | No | Period in which the requests were made |
|`startTime` | string | No | Starting time of the time range in which the requests should have been created |
|`endTime` | string | No | Ending time of the time range in which the requests should have been created |
|`requestType` | string | No | Filter by type of the request |
|`include` | string | No | Additional information related to the requests |

---

#### Get subject access request

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/subjectaccessrequests/subjectaccessrequest_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/subjectaccessrequests/subjectaccessrequest_id?include={include}&api_token={api_token}
```

**Description**: This API fetches the details of a particular SAR

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`subjectAccessRequest_id` | string | Yes | Subject Access Request ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the request |

---

#### List resources related to subject

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/subjectaccessrequests/entities`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/subjectaccessrequests/entities?api_token={api_token}
```

**Description**: This API lists a particular number of resources related to the subject, based on the limit specified

**Request Body**:
```json
{
  "module": "<string>",
  "contactEmailId": "<string>"
}
```

---

#### Get count of resources related to request

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/subjectaccessrequests/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/subjectaccessrequests/count?api_token={api_token}
```

**Description**: This API returns the number of resources related to a subject access request

**Request Body**:
```json
{
  "module": "<string>",
  "contactEmailId": "<string>"
}
```

---

#### Export all subject data from Zoho Desk

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/subjectaccessrequests/exportall`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/subjectaccessrequests/exportall?api_token={api_token}
```

**Description**: This API exports data related to the subject, from your Zoho Desk portal

**Request Body**:
```json
{
  "module": "<string>",
  "contactEmailId": "<string>"
}
```

---

#### Export specific resources

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/subjectaccessrequests/export`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/subjectaccessrequests/export?api_token={api_token}
```

**Description**: This API exports specific resources related to a subject access request

**Request Body**:
```json
{
  "ids": "<array>",
  "contactEmailId": "<string>"
}
```

---

#### Get fields and conditions

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/subjectaccessrequests/fieldsandconditions`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/subjectaccessrequests/fieldsandconditions?module={module}&api_token={api_token}
```

**Description**: This API fetchs possible fileds list and conditions

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | Name of the modules from which the resources must be fetched |

---

#### Erase all subject data from Zoho Desk

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/subjectaccessrequests/eraseall`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/subjectaccessrequests/eraseall?api_token={api_token}
```

**Description**: This API erases data related to the subject, from your Zoho Desk portal

**Request Body**:
```json
{
  "module": "<string>",
  "contactEmailId": "<string>"
}
```

---

#### Erase specific resources

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/subjectaccessrequests/erase`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/subjectaccessrequests/erase?api_token={api_token}
```

**Description**: This API erases specific resources related to a subject access request

**Request Body**:
```json
{
  "ids": "<array>",
  "contactEmailId": "<string>"
}
```

---

### Category: SupportEmailAddress

#### Get details of a SupportEmailAddress

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/supportemailaddress/supportemailaddress_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/supportemailaddress/supportemailaddress_id?api_token={api_token}
```

**Description**: This API fetches the details of a SupportEmailAddress

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`supportEmailAddress_id` | string | Yes | Support Email Address ID |

---

#### List SupportEmailAddresses

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/supportemailaddress`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/supportemailaddress?departmentId={departmentId}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists the SupportEmailAddresses configured in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the department(s) from which the SupportEmailAddresses must be fetched |
|`from` | number | No | Index number, starting from which the mail addresses must be fetched |
|`limit` | number | No | Number of mail addresses to fetch, range: 1-100 |

---

#### Add SupportEmailAddress

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/supportemailaddress`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/supportemailaddress?api_token={api_token}
```

**Description**: This API adds a SupportEmailAddress to your help desk

**Request Body**:
```json
{
  "departmentId": "<number>",
  "friendlyName": "<string>",
  "address": "<string>"
}
```

---

#### Update SupportEmailAddress

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/supportemailaddress/supportemailaddress_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/supportemailaddress/supportemailaddress_id?api_token={api_token}
```

**Description**: This API updates details of an existing SupportEmailAddress

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`supportEmailAddress_id` | string | Yes | Support Email Address ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete SupportEmailAddress

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/supportemailaddress/supportemailaddress_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/supportemailaddress/supportemailaddress_id?api_token={api_token}
```

**Description**: This API deletes a SupportEmailAddress from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`supportEmailAddress_id` | string | Yes | Support Email Address ID |

---

### Category: SupportEmailDomain

#### Update SupportEmailAddress SubDomain

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/supportemaildomain`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/supportemaildomain?api_token={api_token}
```

**Description**: This API updates the subdomain (the "mycompany" part) of the support email address

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get SupportEmailAddress SubDomain

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/supportemaildomain`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/supportemaildomain?api_token={api_token}
```

**Description**: This API fetches the subdomain of the support email address

---

### Category: Task TimeEntry

#### Get a Task Time Entry

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timeentry/timeentry_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timeentry/timeentry_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a time entry recorded for a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |
|`timeEntry_id` | string | Yes | Time Entry ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the time entry. Value supported is owner |

---

#### List Task Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timeentry`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timeentry?from={from}&limit={limit}&orderBy={orderBy}&include={include}&billStatus={billStatus}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&api_token={api_token}
```

**Description**: This API lists the time entries associated with a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the time entries must be fetched |
|`limit` | number | No | Number of time entries to fetch. Range: 1-100 |
|`orderBy` | string | No | Key that sorts the time entries in ascending or descending order, based on the executedTime attribute. Values allowed are ASC (default) and DESC. |
|`include` | string | No | Secondary information related to the time entry. Value supported is owner. Max chars: 100 |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |
|`createdTimeRange` | string | No | Key that filters time entries created in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ |
|`modifiedTimeRange` | string | No | Key that filters time entries whose details were modified in a particular period of time. Enter the from and to dates in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ |

---

#### Add a Task Time Entry

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timeentry`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timeentry?api_token={api_token}
```

**Description**: This API creates a time entry in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Request Body**:
```json
{
  "executedTime": "<string>"
}
```

---

#### Update a Task Time Entry

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timeentry/timeentry_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timeentry/timeentry_id?api_token={api_token}
```

**Description**: This API updates details of an existing time entry

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |
|`timeEntry_id` | string | Yes | Time Entry ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a Task Time Entry

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timeentry/timeentry_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timeentry/timeentry_id?api_token={api_token}
```

**Description**: This API deletes a time entry recorded for a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |
|`timeEntry_id` | string | Yes | Time Entry ID |

---

#### Get summation of Task Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timeentrysummation`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timeentrysummation?billStatus={billStatus}&api_token={api_token}
```

**Description**: This API fetches the sum of time entries associated with a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable, billable, or billed |

---

### Category: Task Timer

#### Get Task Timer

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timer`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timer?api_token={api_token}
```

**Description**: This API fetches the time elapsed in the task timer, along with the current state

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

---

#### Performs Task Timer actions

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/timer`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/timer?action={action}&api_token={api_token}
```

**Description**: This API performs timer-related actions, such as START, STOP, PAUSE and RESUME

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`action` | string | Yes | Action of the timer. Supported actions are START, STOP, PAUSE, and RESUME |

---

### Category: Tasks

#### Get task

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/task_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a task from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the task |

---

#### List tasks

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks?include={include}&from={from}&limit={limit}&departmentId={departmentId}&departmentIds={departmentIds}&viewId={viewId}&assignee={assignee}&dueDate={dueDate}&isCompleted={isCompleted}&sortBy={sortBy}&api_token={api_token}
```

**Description**: This API fetches a particular number of tasks, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the task |
|`from` | number | No | Index number starting from which the tasks must be fetched |
|`limit` | number | No | Number of tasks to list |
|`departmentId` | number | No | ID of the department from which the tasks must be fetched |
|`departmentIds` | number | No | Departments from which the tasks need to be queried |
|`viewId` | number | No | ID of the view to apply while fetching the resources |
|`assignee` | number | No | Key that filters tickets by assignee |
|`dueDate` | string | No | Due date for completing the task |
|`isCompleted` | boolean | No | Key that denotes whether the task is completed or not |
|`sortBy` | string | No | Key that sorts the tasks by a specific attribute: dueDate or createdTime |

---

#### Create task

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks?api_token={api_token}
```

**Description**: This API creates a task in your help desk portal

**Request Body**:
```json
{
  "departmentId": "<number>",
  "subject": "<string>"
}
```

---

#### Update task

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tasks/task_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id?api_token={api_token}
```

**Description**: This API helps update the details of a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete tasks

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/movetotrash?api_token={api_token}
```

**Description**: This API moves task entries to the Recycle Bin of your help desk portal

**Request Body**:
```json
{
  "entityIds": "<array>"
}
```

---

#### Delete spam tasks

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks/deletespam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/deletespam?api_token={api_token}
```

**Description**: This API deletes the given spam tasks

**Request Body**:
```json
{
  "taskIds": "<array>"
}
```

---

#### List tasks by ticket

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/tasks`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/tasks?from={from}&isCompleted={isCompleted}&isSpam={isSpam}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists all tasks associated with a particular ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the tasks must be fetched |
|`isCompleted` | boolean | No | Key that denotes whether the task is completed or not |
|`isSpam` | boolean | No | Key that denotes whether to fetch spam tasks or not |
|`limit` | number | No | Number of tasks to list |
|`sortBy` | string | No | Key that sorts the tasks by a specific attribute: dueDate or createdTime |
|`include` | string | No | Additional information related to the task |

---

#### List all tasks count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/count`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/count?viewId={viewId}&departmentId={departmentId}&assignee={assignee}&dueDate={dueDate}&api_token={api_token}
```

**Description**: This API returns the number of tasks in your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`viewId` | number | Yes | ID of the view to apply while fetching the resources |
|`departmentId` | number | Yes | ID of the department from which the task count must be fetched |
|`assignee` | string | No | Key that filters tasks by assignee |
|`dueDate` | string | No | Filter by task duedate |

---

#### Update many tasks

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks/updatemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/updatemany?api_token={api_token}
```

**Description**: This API updates multiple tasks at once

**Request Body**:
```json
{
  "ids": "<array>",
  "fieldName": "<string>"
}
```

---

#### Empty spam tasks

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks/emptyspam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/emptyspam?api_token={api_token}
```

**Description**: This API deletes all spam tasks

**Request Body**:
```json
{
  "departmentId": "<number>"
}
```

---

### Category: Tasks Attachments

#### List Task attachments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/attachments?sortBy={sortBy}&from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: This API lists the files attached to a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sortBy` | string | No | Sort by the createdTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`from` | number | No | Index number, starting from which the attachments must be fetched |
|`limit` | number | No | Number of attachments to fetch. Range: 1-100 |
|`include` | string | No | Secondary information related to the attachments. Value allowed is creator, which returns the details of users who added the attachments |

---

#### Create Task attachment

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/attachments?api_token={api_token}
```

**Description**: This API attaches a file to a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Task attachment

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/tasks/task_id/attachments/attachment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tasks/task_id/attachments/attachment_id?api_token={api_token}
```

**Description**: This API removes an attachment from a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task ID |
|`attachment_id` | string | Yes | Attachment ID |

---

### Category: Tasks Comments

#### Create a task comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tasks/task_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tasks/task_id/comments?api_token={api_token}
```

**Description**: This API adds a comment to a task

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task Id |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update a task comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/tasks/task_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tasks/task_id/comments/comment_id?api_token={api_token}
```

**Description**: This API updates an existing task comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task Id |
|`comment_id` | string | Yes | Comment Id |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete a task comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/tasks/task_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tasks/task_id/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes an existing task comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task Id |
|`comment_id` | string | Yes | Comment Id |

---

#### Get a task comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tasks/task_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tasks/task_id/comments/comment_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a task comment from the portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task Id |
|`comment_id` | string | Yes | Comment Id |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments |

---

#### List all task comments

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tasks/task_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tasks/task_id/comments?from={from}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on a task, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`task_id` | string | Yes | Task Id |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Range: >=0, Index number starting from which the comments must be fetched |
|`limit` | number | Yes | Default: 50, range: 1-100, No. of comments to fetch |
|`sortBy` | string | No | Max chars: 100, Sort comments by the commentedTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`include` | string | No | Secondary information related to the comments. Value allowed is mentions, which returns the details of users mentioned in the comments |

---

### Category: Teams

#### Create team

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/teams`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/teams?api_token={api_token}
```

**Description**: This API creates a team in your help desk portal

**Request Body**:
```json
{
  "name": "<String>",
  "departmentId": "<number>"
}
```

---

#### Update team

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/teams/team_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/teams/team_id?api_token={api_token}
```

**Description**: This API updates details of an existing team

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete team

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/teams/team_id/deleteteam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/teams/team_id/deleteteam?api_token={api_token}
```

**Description**: This API deletes an existing team from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |

**Request Body**:
```json
{
  "ticketNewTeam": "<number>",
  "ticketNewAgent": "<number>",
  "taskNewTeam": "<number>",
  "taskNewAgent": "<number>"
}
```

---

#### Get team

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/teams/team_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/teams/team_id?api_token={api_token}
```

**Description**: This API fetches the details of a team

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |

---

#### List teams from all associated departments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/teams`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/teams?api_token={api_token}
```

**Description**: This API fetches details of all teams created in all departments to which the current user belongs

---

#### List details of team members

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/teams/team_id/members`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/teams/team_id/members?include={include}&api_token={api_token}
```

**Description**: This API fetches details of all the members of a particular team

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | Yes | Secondary information related to the team |

---

#### List associable teams

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/teams/team_id/associables`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/teams/team_id/associables?api_token={api_token}
```

**Description**: This API lists the other teams that can be added as sub-teams to the current team

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`team_id` | string | Yes | Team ID |

---

#### List associated teams of agent

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agents/agent_id/teams`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agents/agent_id/teams?api_token={api_token}
```

**Description**: This API fetches details of all the teams to which an agent belongs

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`agent_id` | string | Yes | Agent ID |

---

#### List associated teams for a role

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/roles/role_id/teams`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/roles/role_id/teams?api_token={api_token}
```

**Description**: This API fetches details of all the teams associated with a particular role

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`role_id` | string | Yes | Role ID |

---

#### List teams in department

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/departments/department_id/teams`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/departments/department_id/teams?api_token={api_token}
```

**Description**: This API fetches details of all the teams in a particular department

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`department_id` | string | Yes | Department ID |

---

### Category: TemplateFolders

#### Adding a Template Folder

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/templatefolders`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templatefolders?api_token={api_token}
```

**Description**: Adding a Template Folder

**Request Body**:
```json
{
  "folderName": "<string>",
  "folderDesc": "<string>",
  "folderAccessDetails": "<object>"
}
```

---

#### Getting a single Template Folder

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/templatefolders/templatefolder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templatefolders/templatefolder_id?api_token={api_token}
```

**Description**: Listing a particular Template Folder

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`templateFolder_id` | string | Yes | Template Folder ID |

---

#### Updating a Template Folder

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/templatefolders/templatefolder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templatefolders/templatefolder_id?api_token={api_token}
```

**Description**: Updating a Template Folder

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`templateFolder_id` | string | Yes | Template Folder ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Template Folder

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/templatefolders/templatefolder_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templatefolders/templatefolder_id?api_token={api_token}
```

**Description**: Delete a Template Folder

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`templateFolder_id` | string | Yes | Template Folder ID |

---

#### Listing Template Folders

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/templatefolders`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/templatefolders?departmentId={departmentId}&from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: List all Template Folders in alphabetical order

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | The corresponding department to be fetched |
|`from` | number | Yes | From index, default is 1, range: 1-1000 |
|`limit` | number | Yes | Number of folders to be retrieved, default is 1000, range: 1-1000 |
|`include` | string | No | Meta information related to the template folder |

---

### Category: Threads

#### Get a thread

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/threads/thread_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/threads/thread_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a single thread from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`thread_id` | string | Yes | Thread ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Content of the thread in plain text format |

---

#### Get Original Mail Content

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/threads/thread_id/originalcontent`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/threads/thread_id/originalcontent?inline={inline}&api_token={api_token}
```

**Description**: This API get the orginal mail content including mail headers

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`thread_id` | string | Yes | Thread ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`inline` | boolean | No | set this param as true if attachment is to be rendered |

---

#### Get Latest thread

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/latestthread`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/latestthread?needPublic={needPublic}&needIncomingThread={needIncomingThread}&include={include}&threadStatus={threadStatus}&api_token={api_token}
```

**Description**: This API fetches the most recent thread recorded in a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`needPublic` | boolean | No | Key that denotes if the thread must be a public thread |
|`needIncomingThread` | boolean | No | Key that denotes if the thread must be an incoming threads only |
|`include` | string | No | Content of the thread in plain text format |
|`threadStatus` | string | No | Receipt status of the thread |

---

#### Send For Review

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/threads/thread_id/sendforreview`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/threads/thread_id/sendforreview?api_token={api_token}
```

**Description**: This API saves drafts of agent's responses to customers and sends them to a manager/senior agent for review

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`thread_id` | string | Yes | Thread ID |

---

#### List all threads

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/threads`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/threads?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists all threads in your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the threads must be fetched |
|`limit` | number | No | Number of threads to fetch |

---

#### List conversations

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/conversations`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/conversations?from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists a particular number of threads and comments recorded on a ticket, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the conversations must be fetched |
|`limit` | number | Yes | Number of conversations to fetch |

---

#### Send Forum Reply

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/sendreply`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/sendreply?api_token={api_token}
```

**Description**: This API sends a reply to a comment on a forum post

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

#### Draft Forum Reply

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/draftreply`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/draftreply?api_token={api_token}
```

**Description**: This API drafts a reply to a forum post

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

#### Update Draft

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/draftreply/thread_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/draftreply/thread_id?api_token={api_token}
```

**Description**: This API updates a draft thread created via the EMAIL, FACEBOOK, or FORUM channel

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`thread_id` | string | Yes | Thread ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete attachment

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/threads/thread_id/attachments/attachment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/threads/thread_id/attachments/attachment_id?api_token={api_token}
```

**Description**: This API deletes an attachment from a draft thread

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`thread_id` | string | Yes | Thread ID |
|`attachment_id` | string | Yes | Attachment ID |

---

### Category: Ticket Approvals

#### List approvals

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/approvals`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/approvals?from={from}&limit={limit}&status={status}&api_token={api_token}
```

**Description**: This API lists the approvals submitted in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the approvals must be fetched |
|`limit` | number | No | Number of approvals to fetch |
|`status` | string | No | Key that filters the approvals by status |

---

#### Get approval

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/approvals/approval_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/approvals/approval_id?api_token={api_token}
```

**Description**: This API fetches the details of an approval

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`approval_id` | string | Yes | Approval ID |

---

#### Create approval

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/approvals`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/approvals?api_token={api_token}
```

**Description**: This API creates an approval in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "approverIds": "<array>",
  "subject": "<string>"
}
```

---

#### Update approval

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/approvals/approval_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/approvals/approval_id?api_token={api_token}
```

**Description**: This API updates the details of an existing ticket approval

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`approval_id` | string | Yes | Approval ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: Ticket Attachments

#### List ticket attachments

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/attachments?sortBy={sortBy}&from={from}&limit={limit}&isPublic={isPublic}&include={include}&api_token={api_token}
```

**Description**: This API lists the files attached to a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`sortBy` | string | No | Sort by the createdTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting. |
|`from` | number | No | Index number, starting from which the attachments must be fetched |
|`limit` | number | No | Number of attachments to fetch. Range: 1-100 |
|`isPublic` | boolean | No | Key that returns if the attachment is public or not |
|`include` | string | No | Secondary information related to the attachments. Value allowed is creator, which returns the details of users who added the attachments. Max chars: 100 |

---

#### Create Ticket attachment

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/attachments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/attachments?api_token={api_token}
```

**Description**: This API attaches a file to a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update Ticket attachment

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/attachments/attachment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/attachments/attachment_id?api_token={api_token}
```

**Description**: This API updates an existing attachment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`attachment_id` | string | Yes | Attachment ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Ticket attachment

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/attachments/attachment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/attachments/attachment_id?api_token={api_token}
```

**Description**: This API deletes an attachment from a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`attachment_id` | string | Yes | Attachment ID |

---

### Category: Ticket Count

#### Get ticket count

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/ticketscount`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/ticketscount?departmentId={departmentId}&assigneeId={assigneeId}&contactId={contactId}&category={category}&customField1={customField1}&customField2={customField2}&customField3={customField3}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&api_token={api_token}
```

**Description**: This API returns the ticket count of your help desk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department from which ticket count must be fetched |
|`assigneeId` | number | No | ID of the agent assigned to resolve the ticket |
|`contactId` | number | No | ID of the contact who raised the ticket |
|`category` | string | No | Category of the ticket |
|`customField1` | string | No | User-defined field in the ticket |
|`customField2` | string | No | User-defined field in the ticket |
|`customField3` | string | No | User-defined field in the ticket |
|`createdTimeRange` | string | No | Key that filters tickets created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters tickets modified in a particular period of time |

---

#### Get ticket count by field

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/ticketscountbyfieldvalues`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/ticketscountbyfieldvalues?departmentId={departmentId}&assigneeId={assigneeId}&contactId={contactId}&accountId={accountId}&category={category}&customField1={customField1}&customField2={customField2}&customField3={customField3}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&field={field}&api_token={api_token}
```

**Description**: This API returns the ticket count of your help desk, filtered by a specific field

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department from which ticket count must be fetched |
|`assigneeId` | number | No | ID of the agent assigned to resolve the ticket |
|`contactId` | number | No | ID of the contact who raised the ticket |
|`accountId` | number | No | ID of the account to which the ticket is mapped |
|`category` | string | No | Category of the ticket |
|`customField1` | string | No | User-defined field in the ticket |
|`customField2` | string | No | User-defined field in the ticket |
|`customField3` | string | No | User-defined field in the ticket |
|`createdTimeRange` | string | No | Key that filters tickets created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters tickets modified in a particular period of time |
|`field` | string | Yes | Field by which the ticket count must be filtered |

---

### Category: Ticket Followers

#### Add ticket followers

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/addfollowers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/addfollowers?api_token={api_token}
```

**Description**: This API adds one or more users to the followers list of a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "followerIds": "<array>"
}
```

---

#### Remove ticket followers

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/removefollowers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/removefollowers?api_token={api_token}
```

**Description**: This API removes one or more users from the followers list of a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "followerIds": "<array>"
}
```

---

#### Get ticket followers

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/followers`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/followers?api_token={api_token}
```

**Description**: This API fetches the list of users following a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

### Category: Ticket Tags

#### Search tags

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tags/search`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tags/search?from={from}&limit={limit}&departmentId={departmentId}&searchVal={searchVal}&api_token={api_token}
```

**Description**: This API searches for tags added in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the tags must be fetched |
|`limit` | number | No | Number of tags to fetch. Range: 1-100 |
|`departmentId` | number | Yes | ID of the department from which the tags must be fetched |
|`searchVal` | string | No | Search keyword related to the tag |

---

#### List ticket tags

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickettags`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickettags?departmentId={departmentId}&sortBy={sortBy}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API lists the ticket tags added in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the department from which the tags must be fetched |
|`sortBy` | string | No | Key that sorts tags by a specific attribute: createdTime or count. The default sorting order is descending. Max chars: 100 |
|`from` | number | No | Index number, starting from which the tags must be fetched |
|`limit` | number | No | Number of tags to fetch. Range: 1-100 |

---

#### List tickets by tag

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tags/tag_id/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tags/tag_id/tickets?from={from}&limit={limit}&assignee={assignee}&channel={channel}&status={status}&receivedInDays={receivedInDays}&priority={priority}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists tickets containing the tag specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tag_id` | string | Yes | Tag ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which tickets must be fetched |
|`limit` | number | No | Number of tickets to list. Range: 1-100 |
|`assignee` | string | No | User assigned to resolve the ticket. Values allowed are Unassigned or a valid assigneeId. You can pass multiple assigneeIds as comma-separated values. Max chars: 100 |
|`channel` | string | No | Channel through which the tickets were received. You can pass multiple values by separating them with commas. Max chars: 100 |
|`status` | string | No | Resolution status of the tickets. You can pass multiple values by separating them with commas. Max chars: 100 |
|`receivedInDays` | number | No | Number of days since the tickets were received. Values allowed are 15, 30, 90. |
|`priority` | string | No | Priority of the tickets. You can pass multiple values by separating them with commas. Max chars: 100 |
|`sortBy` | string | No | Key that sorts the tickets by a specific attribute: dueDate, recentThread, createdTime, or ticketNumber. The default sorting order is ascending. A - prefix denotes a descending order of sorting. Max chars: 100 |
|`include` | string | No | Additional information related to the tickets. Values allowed are: contacts, products, departments, team, isRead and assignee. You can pass multiple values by separating them with commas. Max chars: 100 |

---

#### Associate Tag

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/associatetag`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/associatetag?api_token={api_token}
```

**Description**: This API adds a single tag or multiple tags to a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "tags": "<array>"
}
```

---

#### Dissociate Tag

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/dissociatetag`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/dissociatetag?api_token={api_token}
```

**Description**: This API removes a single tag or multiple tags from a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "tags": "<array>"
}
```

---

#### List tags in a ticket

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/tags`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/tags?api_token={api_token}
```

**Description**: This API lists tags associated with a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

#### List recent tags

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/recenttickettags`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/recenttickettags?departmentId={departmentId}&api_token={api_token}
```

**Description**: This API lists the five most recent tags associated with tickets

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the department from which the tags must be fetched |

---

#### Update recent tags

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/recenttickettags/tag_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/recenttickettags/tag_id?api_token={api_token}
```

**Description**: This API adds a tag to the list of recently viewed tags. tag_id is a mandatory parameter in the API request

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tag_id` | string | Yes | Tag ID |

---

#### Replace the specified tags

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tags/tag_id/replace`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tags/tag_id/replace?api_token={api_token}
```

**Description**: This API replaces a tag to the specified tag. tag_id is a mandatory parameter in the API request

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`tag_id` | string | Yes | Tag ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: Ticket Templates

#### Create ticket template

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tickettemplates`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickettemplates?api_token={api_token}
```

**Description**: This API helps create a ticket template in your help desk portal

**Request Body**:
```json
{
  "ticketTemplateName": "<string>",
  "ticketTemplateValues": "<array>"
}
```

---

#### Get ticket template

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickettemplates/tickettemplates_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickettemplates/tickettemplates_id?include={include}&api_token={api_token}
```

**Description**: This API fetches the details of a particular ticket template

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticketTemplates_id` | string | Yes | Ticket Templates ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the template. Values allowed are: contacts, products, departments, team, and assignee. You can pass multiple values by separating them using commas in the API request |

---

#### List ticket templates

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickettemplates`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickettemplates?from={from}&departmentId={departmentId}&layoutId={layoutId}&limit={limit}&showInCustomerPortal={showInCustomerPortal}&searchStr={searchStr}&api_token={api_token}
```

**Description**: This API lists a particular number of ticket templates, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the templates must be fetched |
|`departmentId` | number | No | ID of the department from which templates must be fetched |
|`layoutId` | number | No | ID of the layout from which templates must be fetched for the given department ID |
|`limit` | number | No | Number of templates to list. The default value is 10 and the maximum value supported is 100 |
|`showInCustomerPortal` | boolean | No | Visibility of the templates in the help center |
|`searchStr` | string | No | String to search for ticket templates by ticket template name |

---

#### Update ticket template

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/tickettemplates/tickettemplates_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickettemplates/tickettemplates_id?api_token={api_token}
```

**Description**: This API helps update the details of a particular ticket template

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticketTemplates_id` | string | Yes | Ticket Templates ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete ticket template

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tickettemplates/deletemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickettemplates/deletemany?api_token={api_token}
```

**Description**: This API deletes a ticket template from your help desk portal

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

### Category: Ticket TimeEntry

#### Get Ticket Time Entry

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timeentry/timeentry_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timeentry/timeentry_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a time entry recorded for a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`timeEntry_id` | string | Yes | Time Entry ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the time entry |

---

#### List Ticket Time Entries

**Method**: `GET` | **LowCodeAPI Path**: ` /api/v1/tickets/ticket_id/timeentry`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk /api/v1/tickets/ticket_id/timeentry?module={module}&from={from}&limit={limit}&orderBy={orderBy}&include={include}&billStatus={billStatus}&createdTimeRange={createdTimeRange}&modifiedTimeRange={modifiedTimeRange}&api_token={api_token}
```

**Description**: This API lists the time entries associated with a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module from which the time entries must be fetched |
|`from` | number | No | Index number, starting from which the time entries must be fetched |
|`limit` | number | No | Number of time entries to fetch |
|`orderBy` | String | No | Key that sorts the time entries in ascending or descending order, based on the executedTime attribute |
|`include` | string | No | Secondary information related to the time entry |
|`billStatus` | String | No | Key that filters time entries, based on their billing status: nonBillable , billable or billed |
|`createdTimeRange` | string | No | Key that filters time entries created in a particular period of time |
|`modifiedTimeRange` | string | No | Key that filters time entries whose details were modified in a particular period of time |

---

#### Add Ticket Time Entry

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timeentry`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timeentry?api_token={api_token}
```

**Description**: This API adds a time entry in your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update Ticket Time Entry

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timeentry/timeentry_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timeentry/timeentry_id?api_token={api_token}
```

**Description**: This API updates an existing ticket time entry

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`timeEntry_id` | string | Yes | Time Entry ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Ticket Time Entry

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timeentry/timeentry_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timeentry/timeentry_id?api_token={api_token}
```

**Description**: This API deletes a time entry recorded for a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`timeEntry_id` | string | Yes | Time Entry ID |

---

#### Get summation of Ticket Time Entries

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timeentrysummation`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timeentrysummation?module={module}&billStatus={billStatus}&api_token={api_token}
```

**Description**: This API fetches the sum of time entries associated with a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | No | Module from which the time entries must be fetched |
|`billStatus` | string | No | Key that filters time entries, based on their billing status: nonBillable , billable or billed |

---

#### Get Ticket Time Entries by Billing Type

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timeentrybybillingtype`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timeentrybybillingtype?billingType={billingType}&include={include}&from={from}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches time entries for a ticket created after recently modified time of the given billing type from your help desk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`billingType` | String | Yes | Allowed values are FIXED_COST_FOR_TICKETS FIXED_COST_FOR_AGENTS SPECIFIC_COST_PER_AGENT SPECIFIC_COST_PER_PROFILE |
|`include` | string | No | Secondary information related to the time entry. Allowed value is : owner |
|`from` | number | No | Index number, starting from which the time entries must be fetched |
|`limit` | number | No | Number of time entries to fetch |

---

### Category: Ticket Timer

#### Get Ticket Timer

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timer`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timer?api_token={api_token}
```

**Description**: This API fetches the time elapsed in the ticket timer, along with the current state

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

#### Performs Ticket Timer actions

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/timer`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/timer?api_token={api_token}
```

**Description**: This API performs timer-related actions, such as START, STOP, PAUSE and RESUME 

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "action": "<string>"
}
```

---

### Category: Tickets

#### Get a ticket

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a single ticket from your helpdesk

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Key that fetches secondary information related to the ticket |

---

#### List all tickets

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets?from={from}&limit={limit}&departmentIds={departmentIds}&teamIds={teamIds}&viewId={viewId}&assignee={assignee}&channel={channel}&status={status}&sortBy={sortBy}&receivedInDays={receivedInDays}&include={include}&fields={fields}&priority={priority}&api_token={api_token}
```

**Description**: This API lists a particular number of tickets, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the tickets must be fetched |
|`limit` | number | No | Number of tickets to fetch |
|`departmentIds` | number | No | Departments from which the tickets need to be queried |
|`teamIds` | String | No | Key that filters tickets by Teams |
|`viewId` | number | No | ID of the view to apply while fetching the resources |
|`assignee` | string | No | assignee - Key that filters tickets by assignee |
|`channel` | string | No | Filter by channel through which the tickets originated |
|`status` | string | No | Filter by resolution status of the ticket |
|`sortBy` | string | No | Sort by a specific attribute: responseDueDate or customerResponseTime or createdTime |
|`receivedInDays` | number | No | Fetches recent tickets, based on customer response time. Values allowed are 15, 30 , 90 |
|`include` | string | No | Additional information related to the tickets |
|`fields` | string | No | Key that returns the values of mentioned fields (both pre-defined and custom) in your portal |
|`priority` | string | No | Key that filters tickets by priority |

---

#### Get Archived Ticket List

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/tickets/archivedtickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/archivedtickets?from={from}&limit={limit}&departmentId={departmentId}&viewType={viewType}&include={include}&api_token={api_token}
```

**Description**: This API gets the archived tickets list in given department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the tickets must be fetched |
|`limit` | number | No | Number of tickets to fetch |
|`departmentId` | number | No | ID of the department from which the tickets must be fetched |
|`viewType` | number | No | View Type - Supported Values 1 for Compact view , 2 for Classic view ,4 for Table View |
|`include` | string | No | Key that returns additional information related to a ticket |

---

#### List all associated tickets

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/associatedtickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/associatedtickets?from={from}&limit={limit}&departmentId={departmentId}&assignee={assignee}&status={status}&follower={follower}&commenter={commenter}&sharedDepartmentId={sharedDepartmentId}&isShared={isShared}&receivedInDays={receivedInDays}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of tickets that are associated to you from your help desk, based on the limit specified

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the tickets must be listed |
|`limit` | number | No | Number of tickets to fetch |
|`departmentId` | number | No | ID of the department from which the tickets must be fetched |
|`assignee` | string | No | assignee - Key that filters tickets by assignee |
|`status` | string | No | Filter by resolution status of the ticket |
|`follower` | string | No | Filter by followers of the ticket. Values allowed : a valid agentId |
|`commenter` | string | No | Filter by commenters of the ticket |
|`sharedDepartmentId` | number | No | Fetches only the tickets shared from departmentId to sharedDepartmentId |
|`isShared` | boolean | No | Filter all shared tickets actually belonging to departmentId if isShared is true |
|`receivedInDays` | number | No | Fetches recent tickets, based on customer response time |
|`include` | string | No | Key that returns additional information related to a ticket |

---

#### Create a ticket

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets?api_token={api_token}
```

**Description**: This API creates a ticket in your helpdesk

**Request Body**:
```json
{
  "subject": "<string>",
  "departmentId": "<number>"
}
```

---

#### Update a ticket

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id?api_token={api_token}
```

**Description**: This API updates an existing ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Move Tickets to trash

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/movetotrash`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/movetotrash?api_token={api_token}
```

**Description**: This API moves tickets to the Recycle Bin

**Request Body**:
```json
{
  "ticketIds": "<array>"
}
```

---

#### Delete spam tickets

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/deletespam`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/deletespam?api_token={api_token}
```

**Description**: This API deletes the given spam tickets

**Request Body**:
```json
{
  "ticketIds": "<array>"
}
```

---

#### Merge two tickets

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/merge`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/merge?api_token={api_token}
```

**Description**: This API merges two different tickets

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Move ticket

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/move`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/move?api_token={api_token}
```

**Description**: This API helps move a ticket from one department to another

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Split tickets

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/ticket_id/threads/thread_id/split`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/ticket_id/threads/thread_id/split?api_token={api_token}
```

**Description**: This API splits an incoming ticket thread into a new ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

#### Bulk update tickets

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/tickets/updatemany`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/tickets/updatemany?api_token={api_token}
```

**Description**: This API updates multiple tickets at once

**Request Body**:
```json
{
  "ids": "<array>",
  "fieldName": "<string>"
}
```

---

#### Closed many tickets

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/closetickets`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/closetickets?api_token={api_token}
```

**Description**: This API closes multiple tickets at once

**Request Body**:
```json
{
  "ids": "<array>"
}
```

---

#### Mark as read

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/markasread`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/markasread?api_token={api_token}
```

**Description**: This API marks a ticket as read by the user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

#### Mark as unread

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/markasunread`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/markasunread?api_token={api_token}
```

**Description**: This API marks a ticket as unread by the user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

---

*Note: Showing 15 of 28 endpoints in this category.*

---

### Category: Tickets Comments

#### Create ticket comment

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/comments?api_token={api_token}
```

**Description**: This API adds a comment to a ticket

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Update ticket comment

**Method**: `PATCH` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/comments/comment_id?api_token={api_token}
```

**Description**: This API modifies an existing comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`comment_id` | string | Yes | Comment ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete ticket comment

**Method**: `DELETE` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/comments/comment_id?api_token={api_token}
```

**Description**: This API deletes a comment

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`comment_id` | string | Yes | Comment ID |

---

#### Get ticket comment

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/comments/comment_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/comments/comment_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a ticket comment from your help desk portal

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`comment_id` | string | Yes | Comment ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Secondary information related to the comments. The allowed values are mentions and plainText. In the API request, you can pass mention, plainText, or both by using commas to separate them |

---

#### List all ticket comments

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/comments`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/comments?from={from}&limit={limit}&sortBy={sortBy}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of comments recorded on a ticket, based on the limit specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the comments must be fetched |
|`limit` | number | Yes | Number of comments to fetch |
|`sortBy` | string | No | Sort by the commentedTime attribute. The default sorting order is ascending. A - prefix denotes descending order of sorting |
|`include` | string | No | Secondary information related to the comments. The allowed values are mentions and plainText. In the API request, you can pass mention, plainText, or both by using commas to separate them |

---

#### Get a ticket comment history

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/tickets/ticket_id/comments/comment_id/history`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/tickets/ticket_id/comments/comment_id/history?from={from}&include={include}&limit={limit}&api_token={api_token}
```

**Description**: This API fetches the history of comments recorded on a ticket, including instances of adding and editing the comments

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ticket_id` | string | Yes | Ticket ID |
|`comment_id` | string | Yes | Comment ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number, starting from which the comment activities must be fetched |
|`include` | string | No | Secondary information related to the comments. The allowed values are mentions and plainText. In the API request, you can pass mention, plainText, or both by using commas to separate them |
|`limit` | number | Yes | Number of comment activities to fetch |

---

### Category: Timetracking

#### Create TimeTrackSettings

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/timetracksettings`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/timetracksettings?api_token={api_token}
```

**Description**: This API adds a TimeTracking configuration to your helpdesk

**Request Body**:
```json
{
  "isTimeTracking": "<boolean>",
  "depId": "<number>"
}
```

---

#### Update TimeTrackSettings

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v1/timetracksettings`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/timetracksettings?api_token={api_token}
```

**Description**: This API updates an existing TimeTracking configuration

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get TimeTrack Settings

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/timetracksettings`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/timetracksettings?depId={depId}&api_token={api_token}
```

**Description**: This API fetches the details of the TimeTrack Settings configured in your helpdesk

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`depId` | number | Yes | ID of the department |

---

#### List history details of billing TimeTrack Settings

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/timetrackhistory`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/timetrackhistory?depId={depId}&from={from}&limit={limit}&include={include}&api_token={api_token}
```

**Description**: This API fetches the history of changes made to the billing preferences in time tracking settings

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`depId` | number | Yes | ID of the department from which the history must be fetched |
|`from` | number | No | Index number starting from which the events must be fetched |
|`limit` | number | No | Number of events to be fetched |
|`include` | string | No | Secondary information related to the time entry |

---

### Category: Uploads

#### Upload file

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/uploads`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/uploads?api_token={api_token}
```

**Description**: This API uploads a file

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: Users

#### List help center users

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/users`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users?from={from}&limit={limit}&searchBy={searchBy}&sortBy={sortBy}&status={status}&helpCenterId={helpCenterId}&include={include}&api_token={api_token}
```

**Description**: This API lists a particular number of help center users, based on the limit defined

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the users must be fetched |
|`limit` | number | No | Number of users to list |
|`searchBy` | string | No | Search keyword to use for finding a particular user |
|`sortBy` | string | No | Key that sorts the list of users by a particular attribute: -(email or modifiedTime) |
|`status` | string | No | Activation status of the users to list |
|`helpCenterId` | number | No | ID of the help center from which the users must be fetched |
|`include` | string | No | Additional information related to the user |

---

#### Get details of user

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/users/user_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id?include={include}&helpCenterId={helpCenterId}&api_token={api_token}
```

**Description**: This API fetches the details of a particular help center user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to the user |
|`helpCenterId` | number | No | ID of the help center from which the user must be fetched |

---

#### Update details of user

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/users/user_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id?api_token={api_token}
```

**Description**: This API helps update the details of a particular help center user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Anonymize user

**Method**: `POST` | **LowCodeAPI Path**: `api/v1/users/user_id/anonymize`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/users/user_id/anonymize?api_token={api_token}
```

**Description**: This API permanently deletes all identifying information about a user from your help center

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List user groups

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/users/user_id/groups`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/groups?from={from}&limit={limit}&searchBy={searchBy}&sortBy={sortBy}&helpCenterId={helpCenterId}&api_token={api_token}
```

**Description**: This API lists a particular number of user groups in a help center, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the groups must be fetched |
|`limit` | number | No | Number of groups to list |
|`searchBy` | string | No | Search keyword to use for finding a particular user |
|`sortBy` | string | No | Key that sorts the list of user groups by a particular attribute: -(addedTime) |
|`helpCenterId` | number | No | ID of the help center from which the groups must be fetched |

---

#### Add user to groups

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/users/user_id/groups/associate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/groups/associate?api_token={api_token}
```

**Description**: This API adds a user to the groups specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "groups": "<array>"
}
```

---

#### Remove user from groups

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/users/user_id/groups/dissociate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/groups/dissociate?api_token={api_token}
```

**Description**: This API removes a user from the groups specified

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "groupIds": "<array>"
}
```

---

#### List labels of user

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/users/user_id/labels`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/labels?isPrimary={isPrimary}&from={from}&limit={limit}&sortBy={sortBy}&searchBy={searchBy}&helpCenterId={helpCenterId}&api_token={api_token}
```

**Description**: This API lists a particular number of labels associated with a user, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`isPrimary` | boolean | No | Key that filters the primary label assigned to the user |
|`from` | number | No | Index number starting from which the labels must be fetched |
|`limit` | number | No | Number of labels to list |
|`sortBy` | String | No | Key that sorts the list of labels by a particular attribute: -(assignedTime) |
|`searchBy` | string | No | Search keyword to use for finding a particular user |
|`helpCenterId` | number | No | ID of the help center from which the labels must be fetched |

---

#### Assign labels to user

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/users/user_id/labels/assign`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/labels/assign?api_token={api_token}
```

**Description**: This API assigns the labels you specify to a particular user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "labels": "<array>"
}
```

---

#### Remove labels from user

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/users/user_id/labels/remove`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/labels/remove?api_token={api_token}
```

**Description**: This API removes the labels you specify from a particular user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "labelIds": "<array>"
}
```

---

#### List User badges

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/users/value/badges`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/value/badges?from={from}&limit={limit}&type={type}&sortBy={sortBy}&startTime={startTime}&endTime={endTime}&api_token={api_token}
```

**Description**: This API lists user's default and custom badges, based on the limit defined

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`value` | string | Yes | Possible Values : ([0-9]+) |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`from` | number | No | Index number starting from which the badges must be fetched |
|`limit` | number | No | Number of badges to list |
|`type` | string | No | Type of badge: default or custom |
|`sortBy` | string | No | Sort by the createdTime attribute |
|`startTime` | string | No | Start time should be in GMT time zone |
|`endTime` | string | No | End time should be in GMT time zone |

---

#### Add Badges to a user

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/users/user_id/badges/associate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/badges/associate?api_token={api_token}
```

**Description**: This API adds specified badges to user

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "badgeIds": "<array>"
}
```

---

#### Remove Badges from user

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/users/user_id/badges/dissociate`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/users/user_id/badges/dissociate?api_token={api_token}
```

**Description**: This API removes specified badges from the users

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`user_id` | string | Yes | User ID |

**Request Body**:
```json
{
  "badgeIds": "<array>"
}
```

---

### Category: ValidationRules

#### Get Layout Validation Rule

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/validationrules/validationrule_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/validationrules/validationrule_id?include={include}&api_token={api_token}
```

**Description**: This API fetches a validation rule configured for your layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |
|`validationRule_id` | string | Yes | Validation Rule ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`include` | string | No | Additional information related to rules. Values allowed are: creator, modifier |

---

#### Get Layout Validation Rules for department or layout

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/validationrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/validationrules?departmentId={departmentId}&layoutId={layoutId}&module={module}&activeLayouts={activeLayouts}&activeRules={activeRules}&from={from}&limit={limit}&searchString={searchString}&executeInHelpCentre={executeInHelpCentre}&include={include}&api_token={api_token}
```

**Description**: This API fetches all the validation rules configured for your department/layout

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | Get the rules of the department |
|`layoutId` | number | No | Get the rules of the layout |
|`module` | string | No | Name of the module for which you want to fetch the layout rules. Allowed values are tickets, contacts, accounts, tasks, timeEntry, contracts, products, calls, events |
|`activeLayouts` | boolean | No | Get the rules for active layouts |
|`activeRules` | boolean | No | Get the rules that are active in the layout |
|`from` | number | No | Index number, starting from which the rules must be fetched. Default is 0 |
|`limit` | number | Yes | Number of rules to be fetched. Default is 50. Range: 1-50 |
|`searchString` | string | No | Get the rules that have this search term |
|`executeInHelpCentre` | boolean | No | Get the rules that can be executed in help centre |
|`include` | string | No | Additional information related to the rules. Values allowed are: creator and modifier |

---

#### Create Layout Validation Rule

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/validationrules`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/validationrules?api_token={api_token}
```

**Description**: This API creates a validation rule for a field in a layout

**Request Body**:
```json
{
  "fieldName": "<string>",
  "fieldConditions": "<array>"
}
```

---

#### Update Layout Validation Rule

**Method**: `PATCH` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/validationrules/validationrule_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/validationrules/validationrule_id?api_token={api_token}
```

**Description**: This API updates the details of an existing validation rule in a particular layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |
|`validationRule_id` | string | Yes | Validation Rule ID |

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Delete Validation Rule

**Method**: `DELETE` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/validationrules/validationrule_id`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/validationrules/validationrule_id?api_token={api_token}
```

**Description**: This API deletes a validation rule created for a field from a layout

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |
|`validationRule_id` | string | Yes | Validation Rule ID |

---

#### List Criteria Fields For Layout Validation Rules

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/layouts/layout_id/validationrules/criteriafields`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/layouts/layout_id/validationrules/criteriafields?category={category}&api_token={api_token}
```

**Description**: This API lists the fields that can be used in criteria of a specified module in validation rules

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`layout_id` | string | Yes | Layout ID |

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`category` | string | Yes | Category for getting the field criteria for primary or secondary fields |

---

### Category: Views

#### List Views

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/views`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/views?module={module}&departmentId={departmentId}&api_token={api_token}
```

**Description**: This API lists the different views configured for a specific module or for all modules in your help desk portal

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | Module Name (for which the view configured and need to be fetched) |
|`departmentId` | number | No | Allowed values are : Valid Department Id |

---

#### Add Star View

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/views/view_id/star`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/views/view_id/star?api_token={api_token}
```

**Description**: This API stars a view, enabling quick access to the view

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Remove Star View

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/starredviews/view_id/unstar`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/starredviews/view_id/unstar?api_token={api_token}
```

**Description**: This API unstars a view, disabling quick access to the view

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### List Starred Views

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/starredviews`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/starredviews?module={module}&departmentId={departmentId}&api_token={api_token}
```

**Description**: This API lists the starred views in a module

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`module` | string | Yes | Module associated with the view |
|`departmentId` | number | No | ID of the department in which the view(s) is (are) configured |

---

#### Starred Views Reorder

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v1/starredviews/order`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/starredviews/order?api_token={api_token}
```

**Description**: This API helps reorder the starred views in a module

**Request Body**:
```json
{
  "module": "<string>",
  "starredViewIds": "<array>"
}
```

---

#### Get Last Accessed View

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/lastaccessedview`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/lastaccessedview?departmentId={departmentId}&module={module}&api_token={api_token}
```

**Description**: This API fetches the view last accessed by the user in the module and department specified in the request

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | No | ID of the department in which the view(s) is (are) configured |
|`module` | string | Yes | Module associated with the view |

---

#### Update Last Accessed View

**Method**: `PUT` | **LowCodeAPI Path**: `/api/v1/lastaccessedview/value`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/lastaccessedview/value?api_token={api_token}
```

**Description**: This API updates the view last accessed by the user in the module and department specified in the request

**Path Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`value` | string | Yes | Possible Values : ([0-9]+) |

**Request Body**:
```json
{
  "key": "value"
}
```

---

### Category: agentAvailability

#### Update Agent Availability Configuration

**Method**: `POST` | **LowCodeAPI Path**: `/api/v1/agentavailabilityconfig`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agentavailabilityconfig?api_token={api_token}
```

**Description**: This API updates the agent availability setting configured in your help desk portal

**Request Body**:
```json
{
  "key": "value"
}
```

---

#### Get Agent Availability Configuration

**Method**: `GET` | **LowCodeAPI Path**: `/api/v1/agentavailabilityconfig`

**Full URL**:
```
https://api.lowcodeapi.com/zohodesk/api/v1/agentavailabilityconfig?api_token={api_token}
```

**Description**: This API fetches the agent availability setting configured in your help desk portal

---

#### Get Current Availability

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/agentavailability`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/agentavailability?departmentId={departmentId}&include={include}&limit={limit}&from={from}&api_token={api_token}
```

**Description**: This API lists the current availability of agents in a particular department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the department from which the availability details should be fetched |
|`include` | string | No | Key that includes additional, channel-specific information |
|`limit` | number | Yes | Number of agents to list |
|`from` | number | Yes | Index number, starting from which the agents must be fetched |

---

#### Get Online Agents

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/onlineagents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/onlineagents?departmentId={departmentId}&include={include}&limit={limit}&api_token={api_token}
```

**Description**: This API lists the agents who are currently online in a particular department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the department from which the availability details should be fetched |
|`include` | string | No | Key that includes additional, channel-specific information |
|`limit` | number | Yes | Number of agents to list |

---

#### Get Offline Agents

**Method**: `GET` | **LowCodeAPI Path**: `api/v1/offlineagents`

**Full URL**:
```
https://api.lowcodeapi.com/zohodeskapi/v1/offlineagents?departmentId={departmentId}&include={include}&limit={limit}&api_token={api_token}
```

**Description**: This API lists the agents who are currently offline in a particular department

**Query Parameters**:

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`departmentId` | number | Yes | ID of the department from which the availability details should be fetched |
|`include` | string | No | Key that includes additional, channel-specific information |
|`limit` | number | Yes | Number of agents to list |

---

## Complete Endpoint Reference

For a complete list of all 719 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohodesk/definition`
- **Official Provider Documentation**: https://desk.zoho.com/support/APIDocument.do