# Zoho Mail Integration via LowCodeAPI
**Last Updated**: February 11, 2026
## Overview
Email service
The Zoho Mail API provides access to:
- **Zoho Suite** - Related functionality
## Base Endpoint
```
https://api.lowcodeapi.com/zohomail/
```
**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Zoho Mail](https://www.zoho.com/mail)
2. **Get your credentials** from [credential page](https://accounts.zoho.com/developerconsole)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
The `api_token` is your LowCodeAPI authentication token. LowCodeAPI will automatically:
- Fetch your provider credentials (API keys, OAuth tokens, etc.)
- Apply them to each request
- Handle token refresh for OAuth providers
**Auth Type**: OAUTH2.0
## URL Format (Important)
LowCodeAPI supports **two URL formats** for endpoints with path parameters. **Always try New Format first**, and only fall back to Old Format if it doesn't work.
### New Format (Priority) - Dynamic Path Parameters
- **Path parameters stay in the URL path** - Do NOT convert to query parameters
- **Provider name is always in the URL path** after `api.lowcodeapi.com/`
- Pattern: `https://api.lowcodeapi.com/{provider}/{path_with_params}?api_token={api_token}`
**Example**:
```bash
# New Format - Path parameter stays in the URL path
https://api.lowcodeapi.com/zohomail/resource/{RESOURCE_ID}?api_token=YOUR_API_TOKEN
```
### Old Format (Fallback) - Sanitized Path + Query Parameters
- **Path parameters become query parameters**
- **Provider name is always in the URL path**
- Pattern: `https://api.lowcodeapi.com/{provider}/{sanitized_path}?{path_params}&api_token={api_token}`
**Example**:
```bash
# Old Format - Path parameter becomes a query parameter
https://api.lowcodeapi.com/zohomail/resource/id?id=RESOURCE_ID&api_token=YOUR_API_TOKEN
```
### Decision Flow for AI Agents
1. Always use **New Format first** - Keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider
## API Categories
- **Accounts** - 2 endpoints
- **Bookmarks** - 12 endpoints
- **Bookmarks (Group)** - 13 endpoints
- **Domain** - 6 endpoints
- **Email Messages** - 12 endpoints
- **Folder** - 5 endpoints
- **Groups** - 8 endpoints
- **Label** - 5 endpoints
- **Notes** - 15 endpoints
- **Notes (Group)** - 14 endpoints
- **Organization** - 12 endpoints
- **Tasks** - 13 endpoints
- **Tasks (Group)** - 9 endpoints
- **Threads** - 1 endpoints
- **Users** - 1 endpoints
- **Users (Organization)** - 6 endpoints
## Common Endpoints
### Category: Accounts
#### User account details Accounts
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id?accountId={accountId}&api_token={api_token}
```
**Description**: User account details Accounts
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountId` | string | Yes | This parameter is used to identify the account whose details are retrieved. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [User account details Accounts](https://www.zoho.com/mail/help/api/get-user-account-details.html)
---
#### Delete Vacation Reply (Using User Authentication)
**Method**: `PUT` | **LowCodeAPI Path**: `/api/accounts/<account_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id?accountId={accountId}&api_token={api_token}
```
**Description**: Delete Vacation Reply (Using User Authentication)
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountId` | string | Yes | This parameter is used to identify the account whose details are retrieved. |
**Request Body**:
```json
{
"mode": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mode` | string | Yes | This parameter represents the type of operation that is to be performed. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Vacation Reply (Using User Authentication)](https://www.zoho.com/mail/help/api/put-delete-vacation-reply.html)
---
### Category: Bookmarks
#### Get all Bookmarks
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/me`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me?after={after}&fields={fields}&limit={limit}&api_token={api_token}
```
**Description**: Get all Bookmarks
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | number | No | he bookmark number from which the retrieval has to be done |
| `fields` | string | No | The details associated with the bookmark that you wish to retrieve. |
| `limit` | number | No | The number of bookmarks that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/me?after=VALUE&fields=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Bookmarks](https://www.zoho.com/mail/help/api/get-all-bookmarks.html)
---
#### Add a new Bookmark
**Method**: `POST` | **LowCodeAPI Path**: `/api/links/me`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me?collectionId={collectionId}&link={link}&summary={summary}&title={title}&api_token={api_token}
```
**Description**: Add a new Bookmark
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collectionId` | number | No | The unique ID of collection you want to add the bookmark to |
| `link` | string | Yes | The link that you want to add as a bookmark |
| `summary` | string | No | The summary of the bookmark that is being added |
| `title` | string | No | The title of the bookmark that is being added |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/links/me?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a new Bookmark](https://www.zoho.com/mail/help/api/add-bookmark.html)
---
#### Get a Bookmark
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/entity_id?entity_id={entity_id}&fields={fields}&api_token={api_token}
```
**Description**: Get a Bookmark
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | The details about the bookmark that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>?fields=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a Bookmark](https://www.zoho.com/mail/help/api/get-bookmark-details.html)
---
#### Edit a Bookmark
**Method**: `PUT` | **LowCodeAPI Path**: `/api/links/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Edit a Bookmark
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `collectionId` | number | No | The unique ID of the collection of the bookmark |
| `link` | string | No | The link that you want for the edited bookmark |
| `summary` | string | No | The summary for the bookmark that is being edited |
| `title` | string | No | The title for the bookmark that is being edited |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a Bookmark](https://www.zoho.com/mail/help/api/edit-bookmark.html)
---
#### Mark a Bookmark as favorite
**Method**: `PUT` | **LowCodeAPI Path**: `/api/links/me/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/entity_id/favorite?entity_id={entity_id}&api_token={api_token}
```
**Description**: Mark a Bookmark as favorite
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Mark a Bookmark as favorite](https://www.zoho.com/mail/help/api/put-favorite-bookmark.html)
---
#### Unmark a Bookmark as favorites
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/links/me/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/entity_id/favorite?entity_id={entity_id}&api_token={api_token}
```
**Description**: Unmark a Bookmark as favorites
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Unmark a Bookmark as favorites](https://www.zoho.com/mail/help/api/unmark-fav-bookmark.html)
---
#### Delete a Bookmark
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/links/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Delete a Bookmark
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/links/me/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Bookmark](https://www.zoho.com/mail/help/api/delete-bookmark.html)
---
#### Get all collections
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/me/collections`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections?api_token={api_token}
```
**Description**: Get all collections
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/me/collections?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all collections](https://www.zoho.com/mail/help/api/get-all-collections.html)
---
#### Create a collection
**Method**: `POST` | **LowCodeAPI Path**: `/api/links/me/collections`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections?api_token={api_token}
```
**Description**: Create a collection
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/links/me/collections?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a collection](https://www.zoho.com/mail/help/api/post-create-collection.html)
---
#### Edit a collection
**Method**: `PUT` | **LowCodeAPI Path**: `/api/links/me/collections/<collection_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections/<collection_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections/collection_id?collection_id={collection_id}&api_token={api_token}
```
**Description**: Edit a collection
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier used for each bookmark collection. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/links/me/collections/<collection_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a collection](https://www.zoho.com/mail/help/api/put-edit-collection.html)
---
#### Delete a collection
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/links/me/collections/<collection_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections/<collection_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections/collection_id?collection_id={collection_id}&api_token={api_token}
```
**Description**: Delete a collection
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | number | Yes | The unique identifier assigned to each bookmark collection |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/links/me/collections/<collection_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a collection](https://www.zoho.com/mail/help/api/delete-collection.html)
---
#### Get all Bookmarks in a collection
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/me/collections/<collection_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections/<collection_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/me/collections/collection_id?collection_id={collection_id}&after={after}&fields={fields}&limit={limit}&api_token={api_token}
```
**Description**: Get all Bookmarks in a collection
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | number | Yes | The unique identifier used for each bookmark collection. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | number | No | The bookmark number from which the retrieval has to be done |
| `fields` | string | No | The details associated with the bookmark that you wish to retrieve. |
| `limit` | number | No | The number of bookmarks that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/me/collections/<collection_id>?after=VALUE&fields=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Bookmarks in a collection](https://www.zoho.com/mail/help/api/get-bookmarks-in-collection.html)
---
### Category: Bookmarks (Group)
#### Get all Groups
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/groups`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups?api_token={api_token}
```
**Description**: Get all Groups
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/groups?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Groups](https://www.zoho.com/mail/help/api/get-all-link-groups.html)
---
#### Get all Bookmarks for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id?group_id={group_id}&after={after}&fields={fields}&limit={limit}&api_token={api_token}
```
**Description**: Get all Bookmarks for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | number | No | he bookmark number from which the retrieval has to be done |
| `fields` | string | No | The details associated with the bookmark that you wish to retrieve. |
| `limit` | number | No | The number of bookmarks that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>?after=VALUE&fields=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Bookmarks for Group](https://www.zoho.com/mail/help/api/get-all-bookmarks.html)
---
#### Add a new Bookmark for Group
**Method**: `POST` | **LowCodeAPI Path**: `/api/links/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomailapi/links/groups/group_id?group_id={group_id}&collectionId={collectionId}&link={link}&summary={summary}&title={title}&api_token={api_token}
```
**Description**: Add a new Bookmark for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collectionId` | number | No | The unique ID of collection you want to add the bookmark to |
| `link` | string | Yes | The link that you want to add as a bookmark |
| `summary` | string | No | The summary of the bookmark that is being added |
| `title` | string | No | The title of the bookmark that is being added |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a new Bookmark for Group](https://www.zoho.com/mail/help/api/add-bookmark.html)
---
#### Get a Bookmark for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&fields={fields}&api_token={api_token}
```
**Description**: Get a Bookmark for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | The details about the bookmark that you want to retrieve. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>?fields=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a Bookmark for Group](https://www.zoho.com/mail/help/api/get-bookmark-details.html)
---
#### Edit a Bookmark for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Edit a Bookmark for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `collectionId` | number | No | The unique ID of the collection of the bookmark |
| `link` | string | No | The link that you want for the edited bookmark |
| `summary` | string | No | The summary for the bookmark that is being edited |
| `title` | string | No | The title for the bookmark that is being edited |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a Bookmark for Group](https://www.zoho.com/mail/help/api/edit-bookmark.html)
---
#### Mark a Bookmark as favorite for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/entity_id/favorite?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Mark a Bookmark as favorite for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Mark a Bookmark as favorite for Group](https://www.zoho.com/mail/help/api/put-favorite-bookmark.html)
---
#### Unmark a Bookmark as favorites for Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/entity_id/favorite?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Unmark a Bookmark as favorites for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Unmark a Bookmark as favorites for Group](https://www.zoho.com/mail/help/api/unmark-fav-bookmark.html)
---
#### Delete a Bookmark for Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Delete a Bookmark for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the bookmark. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Bookmark for Group](https://www.zoho.com/mail/help/api/delete-bookmark.html)
---
#### Get all collections for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/collections`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/collections?group_id={group_id}&api_token={api_token}
```
**Description**: Get all collections for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all collections for Group](https://www.zoho.com/mail/help/api/get-all-collections.html)
---
#### Create a collection for Group
**Method**: `POST` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/collections`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/collections?collectionName={collectionName}&group_id={group_id}&api_token={api_token}
```
**Description**: Create a collection for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collectionName` | string | Yes | The name of the collection you want to create. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a collection for Group](https://www.zoho.com/mail/help/api/post-create-collection.html)
---
#### Edit a collection for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/collections/<collection_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections/<collection_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/collections/collection_id?collection_id={collection_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Edit a collection for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | string | Yes | The unique identifier used for each bookmark collection. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"collectionName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `collectionName` | string | Yes | The name you wish to give the collection that is edited |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections/<collection_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a collection for Group](https://www.zoho.com/mail/help/api/put-edit-collection.html)
---
#### Delete a collection for Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/collections/<collection_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections/<collection_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/collections/collection_id?collection_id={collection_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Delete a collection for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | number | Yes | The unique identifier assigned to each bookmark collection |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections/<collection_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a collection for Group](https://www.zoho.com/mail/help/api/delete-collection.html)
---
#### Get all Bookmarks in a collection for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/links/groups/<group_id>/collections/<collection_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections/<collection_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/links/groups/group_id/collections/collection_id?collection_id={collection_id}&group_id={group_id}&after={after}&fields={fields}&limit={limit}&api_token={api_token}
```
**Description**: Get all Bookmarks in a collection for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `collection_id` | number | Yes | The unique identifier used for each bookmark collection. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | number | No | The bookmark number from which the retrieval has to be done |
| `fields` | string | No | The details associated with the bookmark that you wish to retrieve. |
| `limit` | number | No | The number of bookmarks that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/links/groups/<group_id>/collections/<collection_id>?after=VALUE&fields=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Bookmarks in a collection for Group](https://www.zoho.com/mail/help/api/get-bookmarks-in-collection.html)
---
### Category: Domain
#### All Domain Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/domains`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/domains?zo_id={zo_id}&api_token={api_token}
```
**Description**: All Domain Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identified for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [All Domain Details](https://www.zoho.com/mail/help/api/get-all-domains.html)
---
#### Retrieve details about a single Domain
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/domains/<domain_name>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/domains/domain_name?domain_name={domain_name}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Retrieve details about a single Domain
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_name` | string | Yes | The name of the domain to get information. Ex |
| `zo_id` | number | No | The unique Zoho Organization Identified for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Retrieve details about a single Domain](https://www.zoho.com/mail/help/api/get-single-domain.html)
---
#### Add domain to an Organization
**Method**: `POST` | **LowCodeAPI Path**: `/api/organization/<zo_id>/domains`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/domains?zo_id={zo_id}&api_token={api_token}
```
**Description**: Add domain to an Organization
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | No | The unique Zoho Organization Identifier for the organization |
**Request Body**:
```json
{
"domainName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `domainName` | string | Yes | The domain which should be added to the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add domain to an Organization](https://www.zoho.com/mail/help/api/post-add-domain-to-org.html)
---
#### Verify the Domain added to the Organization
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>/domains/<domain_name>/verifyDomain`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>/verifyDomain?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/domains/domain_name/verifydomain?domain_name={domain_name}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Verify the Domain added to the Organization
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_name` | string | Yes | Name of the domain which has to be verified |
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Request Body**:
```json
{
"mode": "<String>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mode` | String | Yes | Provide the appropriate mode of verification |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>/verifyDomain?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Verify the Domain added to the Organization](https://www.zoho.com/mail/help/api/put-verify-domain.html)
---
#### To verify MX Record
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>/domains/<domain_name>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/domains/domain_name?domain_name={domain_name}&zo_id={zo_id}&api_token={api_token}
```
**Description**: To verify MX Record
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_name` | string | Yes | Name of the domain for which you want to verify MX record. |
| `zo_id` | number | Yes | The unique Zoho Organization Identifier of your organization |
**Request Body**:
```json
{
"mode": "<String>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mode` | String | Yes | To verify if you have Zoho MX record added to your domain |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [To verify MX Record](https://www.zoho.com/mail/help/api/put-verify-mx-record.html)
---
#### Remove domain from Organization
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/organization/<zo_id>/domains/<domain_name>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/domains/domain_name?domain_name={domain_name}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Remove domain from Organization
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain_name` | string | Yes | The domain which should be removed from the organization. |
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/domains/<domain_name>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove domain from Organization](https://www.zoho.com/mail/help/api/delete-domain-org.html)
---
### Category: Email Messages
#### Save Draft / Template
**Method**: `POST` | **LowCodeAPI Path**: `/api/accounts/<account_id>/messages`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/messages?account_id={account_id}&api_token={api_token}
```
**Description**: Save Draft / Template
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account identifier associated with the particular account |
**Request Body**:
```json
{
"fromAddress": "<string>",
"mode": "<string>",
"toAddress": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bccAddress` | string | No | Recipient email address for the Bcc field |
| `ccAddress` | string | No | Recipient email address for the Cc field |
| `content` | string | No | The content that should be saved as a draft or template |
| `fromAddress` | string | Yes | Sender's email address for the From field (associated to the authenticated account) |
| `mode` | string | Yes | Whether the content should be saved as a draft or a template |
| `subject` | string | No | Subject of the email that should be sent |
| `toAddress` | string | Yes | Recipient email address for the To field |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Save Draft / Template](https://www.zoho.com/mail/help/api/post-save-draft-template.html)
---
#### Get all/ view based emails in a folder
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/messages/view`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/view?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/messages/view?account_id={account_id}&attachedMails={attachedMails}&fields={fields}&flagid={flagid}&folderId={folderId}&includearchive={includearchive}&includesent={includesent}&inlinedMails={inlinedMails}&labelidTo={labelidTo}&limit={limit}&sortBy={sortBy}&sortorder={sortorder}&start={start}&status={status}&api_token={api_token}
```
**Description**: Get all/ view based emails in a folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachedMails` | boolean | No | To retrieve only the emails with attachments |
| `fields` | string | No | The list of fields that need to included in the retrieved list or not |
| `flagid` | number | No | To retrieve emails based on a specific flag |
| `folderId` | number | No | Folder Id of the folder for which the emails need to be retrieved |
| `includearchive` | boolean | No | Whether the Archived emails need to be included or not on the list of emails retrieved. |
| `includesent` | boolean | No | Whether Sent emails need to be included or not on the list of emails retrieved |
| `inlinedMails` | boolean | No | To retrieve only the emails with inlines.
flaggedMails |
| `labelidTo` | number | No | retrieve emails based on a specific label |
| `limit` | number | No | The number of emails to be retrieved from the start value mentioned. The default value is 10 |
| `sortBy` | string | No | The list of emails can be sort by date messageid or size. The default sort order is date |
| `sortorder` | boolean | No | The sort order of the retrieved list whether ascending or descending need to be specified here.
includeto |
| `start` | number | No | The start sequence number of the emails to be retrieved to retrieve a specific set of emails. The default value is 1 |
| `status` | string | No | To retrieve emails by read or unread status |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/view?attachedMails=VALUE&fields=VALUE&flagid=VALUE&folderId=VALUE&includearchive=VALUE&includesent=VALUE&inlinedMails=VALUE&labelidTo=VALUE&limit=VALUE&sortBy=VALUE&sortorder=VALUE&start=VALUE&status=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all/ view based emails in a folder](https://www.zoho.com/mail/help/api/get-emails-list.html)
---
#### Get emails based on search conditions
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/messages/search`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/search?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/messages/search?account_id={account_id}&fields={fields}&includeto={includeto}&limit={limit}&receivedTime={receivedTime}&searchKey={searchKey}&start={start}&api_token={api_token}
```
**Description**: Get emails based on search conditions
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | The list of fields that need to included in the retrieved list or not |
| `includeto` | boolean | No | Whether the To details need to be included or not |
| `limit` | number | No | The number of emails to be retrieved from the start value mentioned |
| `receivedTime` | number | No | By default the value is before 2 minutes |
| `searchKey` | string | Yes | To search for new emails provide the searchKey as newMails |
| `start` | number | No | The start sequence number of the emails to be retrieved to retrieve a specific set of emails |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/search?fields=VALUE&includeto=VALUE&limit=VALUE&receivedTime=VALUE&searchKey=VALUE&start=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get emails based on search conditions](https://www.zoho.com/mail/help/api/get-search-emails.html)
---
#### Get meta data of a particular email
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/details`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/details?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders/folder_id/messages/message_id/details?account_id={account_id}&folder_id={folder_id}&message_id={message_id}&api_token={api_token}
```
**Description**: Get meta data of a particular email
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Identifier for a specific account of a user |
| `folder_id` | number | Yes | Folder Id of the folder for which the emails need to be retrieved |
| `message_id` | number | Yes | The unique ID associated with the particular email. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/details?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get meta data of a particular email](https://www.zoho.com/mail/help/api/get-email-meta-data.html)
---
#### Get attachment info
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders/folderid/messages/<message_id>/attachmentinfo`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/folderid/messages/<message_id>/attachmentinfo?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders/folderid/messages/message_id/attachmentinfo?account_id={account_id}&folder_id={folder_id}&message_id={message_id}&api_token={api_token}
```
**Description**: Get attachment info
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | This parameter is used to identify the specific account to fetch details. |
| `folder_id` | number | Yes | This parameter is used to identify the specific folder for which the emails need to be retrieved. |
| `message_id` | number | Yes | This parameter is the unique ID associated with the particular email. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/folderid/messages/<message_id>/attachmentinfo?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get attachment info](https://www.zoho.com/mail/help/api/get-attach-info.html)
---
#### Get email attachment content
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/attachments/<attachment_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders/folder_id/messages/message_id/attachments/attachment_id?account_id={account_id}&attachment_id={attachment_id}&folder_id={folder_id}&message_id={message_id}&api_token={api_token}
```
**Description**: Get email attachment content
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account |
| `attachment_id` | number | Yes | The attachment id of the particular attachment. |
| `folder_id` | number | Yes | The unique identification number associated with the folder |
| `message_id` | number | Yes | The unique Message ID associated with the particular email |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get email attachment content](https://www.zoho.com/mail/help/api/get-attachment-content.html)
---
#### Get email headers
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/header`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/header?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders/folder_id/messages/message_id/header?account_id={account_id}&folder_id={folder_id}&message_id={message_id}&api_token={api_token}
```
**Description**: Get email headers
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account |
| `folder_id` | number | Yes | The unique identification number associated with the folder |
| `message_id` | number | Yes | The unique Message ID associated with the particular email. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>/messages/<message_id>/header?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get email headers](https://www.zoho.com/mail/help/api/get-email-header.html)
---
#### Mark email as not spam
**Method**: `PUT` | **LowCodeAPI Path**: `/api/accounts/<account_id>/updatemessage`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/updatemessage?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/updatemessage?account_id={account_id}&api_token={api_token}
```
**Description**: Mark email as not spam
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | This parameter is used to identify the specific account to fetch details. |
**Request Body**:
```json
{
"messageId": "<array>",
"mode": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `folderId` | number | No | The unique identifier of the respective folder |
| `isFolderSpecific` | boolean | No | This parameter specifies whether this action is folder-specific. |
| `messageId` | array | Yes | The unique identifier for the respective email |
| `mode` | string | Yes | This parameter represents the type of operation that is to be performed. |
| `threadId` | array | No | This parameter should be passed as an array containing one or more thread IDs which should be marked as not spam. A thread ID is a unique identifier for an email thread. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/updatemessage?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Mark email as not spam](https://www.zoho.com/mail/help/api/mark-email-not-spam.html)
---
#### Upload attachment
**Method**: `POST` | **LowCodeAPI Path**: `/api/accounts/<account_id>/messages/attachments`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/attachments?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/messages/attachments?account_id={account_id}&api_token={api_token}
```
**Description**: Upload attachment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | This parameter is used to identify the specific account to fetch details. |
**Request Body**:
```json
{
"fileName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `fileName` | string | Yes | Name of the file that is to be attached to the email |
| `isInline` | boolean | No | The value for this key parameter should be True if you want to attach an inline image. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/attachments?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Upload attachment](https://www.zoho.com/mail/help/api/post-upload-attachments.html)
---
#### Reply to an email
**Method**: `POST` | **LowCodeAPI Path**: `/api/accounts/<account_id>/messages/<message_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/<message_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/messages/message_id?account_id={account_id}&api_token={api_token}
```
**Description**: Reply to an email
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account.
messageId |
**Request Body**:
```json
{
"fromAddress": "<string>",
"toAddress": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `action` | string | No | Specifies what action you would like to perform with the message |
| `askReceipt` | string | No | Whether you need to request Read receipt from the recipient |
| `bccAddress` | string | No | Recipient email address for the Bcc field |
| `ccAddress` | string | No | Recipient email address for the Cc field |
| `encoding` | string | No | The encoding which should be used in the email content |
| `fromAddress` | string | Yes | Sender's email address for the From field (associated to the authenticated account) |
| `mailFormat` | string | No | Whether the email should be sent in HTML format or in plain text. The default value is html |
| `subject` | string | No | Subject of the email that should be sent |
| `toAddress` | string | Yes | Recipient email address for the To field |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/<message_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Reply to an email](https://www.zoho.com/mail/help/api/post-reply-to-an-email.html)
---
#### Delete email
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders<folder_id>/messages`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders<folder_id>/messages?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/foldersfolder_id/messages?account_id={account_id}&folder_id={folder_id}&api_token={api_token}
```
**Description**: Delete email
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | This parameter is used to identify the specific account to fetch details. |
| `folder_id` | number | Yes | The unique identification number associated with the folder |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders<folder_id>/messages?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete email](https://www.zoho.com/mail/help/api/delete-email.html)
---
#### Get original message
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/messages/<message_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/<message_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/messages/message_id?account_id={account_id}&api_token={api_token}
```
**Description**: Get original message
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | This parameter is used to identify the specific account to fetch details. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/messages/<message_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get original message](https://www.zoho.com/mail/help/api/get-original-message.html)
---
### Category: Folder
#### Get all Folder Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders?account_id={account_id}&api_token={api_token}
```
**Description**: Get all Folder Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Identifier for a specific account of an user. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Folder Details](https://www.zoho.com/mail/help/api/get-all-folder-details.html)
---
#### Get Details of a Single Folder
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders/<folder_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders/folder_id?account_id={account_id}&folder_id={folder_id}&api_token={api_token}
```
**Description**: Get Details of a Single Folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Identifier for a specific account of an user |
| `folder_id` | number | Yes | The unique Identifier for a specific folder in the user account. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Details of a Single Folder](https://www.zoho.com/mail/help/api/get-single-folder-details.html)
---
#### Create a new Folder
**Method**: `POST` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders?account_id={account_id}&api_token={api_token}
```
**Description**: Create a new Folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account Identifier under which a new folder should be created |
**Request Body**:
```json
{
"folderName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `folderName` | string | Yes | Specify the unique name of the folder which should be created in the particular account |
| `parentFolderId` | number | No | Provide the folder ID of the parent folder under which the new folder should be created. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a new Folder](https://www.zoho.com/mail/help/api/post-create-new-folder.html)
---
#### Empty Folder
**Method**: `PUT` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders/<folder_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders/folder_id?account_id={account_id}&folder_id={folder_id}&api_token={api_token}
```
**Description**: Empty Folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account |
| `folder_id` | number | Yes | The Folder ID of the specific folder which should be emptied. |
**Request Body**:
```json
{
"mode": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mode` | string | Yes | The mode should be passed as emptyFolder to delete all the emails in the folder |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Empty Folder](https://www.zoho.com/mail/help/api/put-delete-folder-emails.html)
---
#### Delete Folder
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/accounts/<account_id>/folders/<folder_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/folders/folder_id?account_id={account_id}&api_token={api_token}
```
**Description**: Delete Folder
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account. folderID |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/folders/<folder_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Folder](https://www.zoho.com/mail/help/api/delete-folder.html)
---
### Category: Groups
#### Details of all the groups
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups?zo_id={zo_id}&fields={fields}&limit={limit}&searchKey={searchKey}&start={start}&api_token={api_token}
```
**Description**: Details of all the groups
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | This parameter denotes the unique Zoho Organization Identifier for the organization. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | By default all fields will be retrieved. To get only specific fields specify the field names separated by comma in this parameter. |
| `limit` | number | No | To retrieve a specific number of groups to display in the page specify the count in this parameter. Default and the maximum value is 25 |
| `searchKey` | string | No | To get the details of group which matches a specific SearchKey specify the searchKey String in this parameter |
| `start` | number | No | To retrieve the groups in a specific range. Specify the group index from which you want to retrieve here. Default value is 1 |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups?fields=VALUE&limit=VALUE&searchKey=VALUE&start=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Details of all the groups](https://www.zoho.com/mail/help/api/get-all-group-details.html)
---
#### Single group details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups/group_id?group_id={group_id}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Single group details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | This parameter is used to identify the group from which the data has to be retrieved. This is generated during group addition. |
| `zo_id` | number | Yes | This parameter denotes the unique Zoho Organization Identifier for the organization. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Single group details](https://www.zoho.com/mail/help/api/get-single-group-details.html)
---
#### Add group
**Method**: `POST` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups?zo_id={zo_id}&api_token={api_token}
```
**Description**: Add group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | This parameter denotes the unique Zoho Organization Identifier for the organization. |
**Request Body**:
```json
{
"emailID": "<string>",
"name": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `accessType` | string | No | Mention the group type as if it is a public group/ organization group/ moderated group/ private group |
| `emailID` | string | Yes | Email Address of the group to be created |
| `mailGroupMemberList` | string | No | The list of members to be added to the group as moderators. |
| `name` | string | Yes | Unique Name of the group |
| `streamsEnabled` | boolean | No | Whether Streams is enabled for the group or not |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add group](https://www.zoho.com/mail/help/api/post-create-group.html)
---
#### Remove group email alias
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups/group_id?group_id={group_id}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Remove group email alias
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | This parameter is used to identify the group from which the data has to be retrieved. This is generated during group addition. |
| `zo_id` | number | Yes | This parameter denotes the unique Zoho Organization Identifier for the organization. |
**Request Body**:
```json
{
"aliasList": "<array>",
"mode": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `aliasList` | array | Yes | JSON Array with list of email aliases to be removed from the gorup. |
| `mode` | string | Yes | delete an email alias to the group email account |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove group email alias](https://www.zoho.com/mail/help/api/put-remove-group-email-alias.html)
---
#### Get emails for moderation
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups/<group_id>/messages`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>/messages?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups/group_id/messages?group_id={group_id}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Get emails for moderation
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | This key is used to identify the group from which the data has to be retrieved. This is generated during group addition.. |
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>/messages?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get emails for moderation](https://www.zoho.com/mail/help/api/get-moderation-emails.html)
---
#### Get moderation email content
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups/<group_id>/messages/<message_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>/messages/<message_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups/group_id/messages/message_id?group_id={group_id}&message_id={message_id}&zo_id={zo_id}&groupId={groupId}&zoid={zoid}&api_token={api_token}
```
**Description**: Get moderation email content
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | This key is used to identify the group from which the data has to be retrieved. This is generated during group addition. |
| `message_id` | number | Yes | This parameter is a unique identifier assigned to a message or email. |
| `zo_id` | number | Yes | This parameter denotes the unique Zoho Organization Identifier for the organization. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `groupId` | number | No | The unique identifier of the group for which the moderation email content should be retrieved
messageId |
| `zoid` | number | No | The unique Identifier for the specific organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>/messages/<message_id>?groupId=VALUE&zoid=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get moderation email content](https://www.zoho.com/mail/help/api/get-moderation-email-content.html)
---
#### Moderate group email
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups/<group_id>/messages`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>/messages?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups/group_id/messages?group_id={group_id}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Moderate group email
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier of the group for which the moderation needs to be enabled. |
| `zo_id` | number | Yes | The unique Identifier for the specific organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>/messages?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Moderate group email](https://www.zoho.com/mail/help/api/put-moderate-group-email.html)
---
#### Delete group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/organization/<zo_id>/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/groups/group_id?group_id={group_id}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Delete group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique Id of the group which should be deleted. |
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/groups/<group_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete group](https://www.zoho.com/mail/help/api/delete-group.html)
---
### Category: Label
#### Get all Label Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/labels`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/labels?account_id={account_id}&api_token={api_token}
```
**Description**: Get all Label Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Identifier for a specific account of an user. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Label Details](https://www.zoho.com/mail/help/api/get-all-label-details.html)
---
#### Get Single Label Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/accounts/<account_id>/labels/<label_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels/<label_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/labels/label_id?account_id={account_id}&label_id={label_id}&api_token={api_token}
```
**Description**: Get Single Label Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Identifier for a specific account of an user |
| `label_id` | number | Yes | The unique Identifier for a specific label in the user account. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels/<label_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get Single Label Details](https://www.zoho.com/mail/help/api/get-single-label-details.html)
---
#### Create a new Label
**Method**: `POST` | **LowCodeAPI Path**: `/pi/accounts/<account_id>/labels`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/pi/accounts/<account_id>/labels?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/pi/accounts/account_id/labels?account_id={account_id}&api_token={api_token}
```
**Description**: Create a new Label
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account Identifier under which a new folder should be created |
**Request Body**:
```json
{
"displayName": "<String>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `color` | string | No | Provide the hex value of the color which you want to associate with the created Label |
| `displayName` | String | Yes | Specify the unique name of the Label which should be created in the particular account. |
| `sequence` | number | No | Provide the order or the sequnce number of the Label where the new Label should be created |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/pi/accounts/<account_id>/labels?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a new Label](https://www.zoho.com/mail/help/api/post-create-new-label.html)
---
#### Update a Label
**Method**: `PUT` | **LowCodeAPI Path**: `/api/accounts/<account_id>/labels/<label_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels/<label_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/labels/label_id?account_id={account_id}&label_id={label_id}&api_token={api_token}
```
**Description**: Update a Label
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account |
| `label_id` | number | Yes | The Label ID of the specific label which should be updated. |
**Request Body**:
```json
{
"displayName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `color` | string | No | Provide the color of the label in the hex Value. |
| `displayName` | string | Yes | Provide the name for the Label |
| `sequence` | number | No | Provide the order or the sequence in which the Label should appear among the group of Labels |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels/<label_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update a Label](https://www.zoho.com/mail/help/api/put-update-label.html)
---
#### Delete Label
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/accounts/<account_id>/labels/<label_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels/<label_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/labels/label_id?account_id={account_id}&label_id={label_id}&api_token={api_token}
```
**Description**: Delete Label
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | The unique Zoho Account number associated with the particular account |
| `label_id` | number | Yes | The Label ID of the specific Label which should be deleted. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/labels/<label_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete Label](https://www.zoho.com/mail/help/api/delete-label.html)
---
### Category: Notes
#### Get all Groups (Notes)
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/groups`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups?api_token={api_token}
```
**Description**: Get all Groups (Notes)
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/groups?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Groups (Notes)](https://www.zoho.com/mail/help/api/get-all-groups.html)
---
#### Create a Note
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/me`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me?bookId={bookId}&color={color}&content={content}&title={title}&api_token={api_token}
```
**Description**: Create a Note
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bookId` | number | No | The unique ID of book you want to add the note to |
| `color` | number | Yes | The unique identifier used to denote the color of a note |
| `content` | string | Yes | The content of the note that is being added |
| `title` | string | No | The title of the note that is being added |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/me?bookId=VALUE&color=VALUE&content=VALUE&title=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a Note](https://www.zoho.com/mail/help/api/post-create-notes.html)
---
#### Get a Note
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Get a Note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the note. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a Note](https://www.zoho.com/mail/help/api/get-note-details.html)
---
#### Edit a note
**Method**: `PUT` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Edit a note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for a note. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a note](https://www.zoho.com/mail/help/api/put-edit-note.html)
---
#### Get an attachment
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>/attachments/<attachment_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id/attachments/attachment_id?attachment_id={attachment_id}&entity_id={entity_id}&fileName={fileName}&api_token={api_token}
```
**Description**: Get an attachment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | number | Yes | Attach files as a part of multipart form data |
| `entity_id` | number | Yes | The unique identifier used for the note |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileName` | string | No | The name of the attachment in the note. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/attachments/<attachment_id>?fileName=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get an attachment](https://www.zoho.com/mail/help/api/get-attachments.html)
---
#### Add an attachment to a note
**Method**: `POST` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>/attachments/`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/attachments/?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id/attachments/?entity_id={entity_id}&api_token={api_token}
```
**Description**: Add an attachment to a note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the note. |
**Request Body**:
```json
{
"attach": "<file>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `attach` | file | Yes | This parameter attaches files as a part of multipart form data. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/attachments/?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add an attachment to a note](https://www.zoho.com/mail/help/api/post-add-attachments.html)
---
#### Delete an attachment
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>/attachments/<attachment_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id/attachments/attachment_id?attachment_id={attachment_id}&entity_id={entity_id}&api_token={api_token}
```
**Description**: Delete an attachment
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | number | Yes | The unique identifier assigned to each attachment |
| `entity_id` | number | Yes | The unique identifier assigned to each bookmark |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an attachment](https://www.zoho.com/mail/help/api/delete-attachments.html)
---
#### Delete a Note
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Delete a Note
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each note. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Note](https://www.zoho.com/mail/help/api/delete-notes.html)
---
#### Get all Books
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/me/books`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books?defaultProject={defaultProject}&api_token={api_token}
```
**Description**: Get all Books
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `defaultProject` | number | Yes | Specifies whether the default book should be highlighted in the response. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/me/books?defaultProject=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Books](https://www.zoho.com/mail/help/api/get-all-books.html)
---
#### Create a new Book
**Method**: `POST` | **LowCodeAPI Path**: `/api/notes/me/books`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books?api_token={api_token}
```
**Description**: Create a new Book
**Request Body**:
```json
{
"bookName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bookName` | string | Yes | The name of the Book you want to create in Notes |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/notes/me/books?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a new Book](https://www.zoho.com/mail/help/api/post-create-book.html)
---
#### Edit a Book
**Method**: `PUT` | **LowCodeAPI Path**: `/api/notes/me/books/<book_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books/<book_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books/book_id?book_id={book_id}&api_token={api_token}
```
**Description**: Edit a Book
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `book_id` | number | Yes | The unique identifier used for each Book in Notes |
**Request Body**:
```json
{
"bookName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bookName` | string | Yes | The name you wish to give the Book that is edited. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/notes/me/books/<book_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a Book](https://www.zoho.com/mail/help/api/put-edit-book.html)
---
#### Delete a Book
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/me/books/<book_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books/<book_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books/book_id?bookId={bookId}&api_token={api_token}
```
**Description**: Delete a Book
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bookId` | number | Yes | The unique identifier assigned to each book in Notes. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/me/books/<book_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Book](https://www.zoho.com/mail/help/api/delete-book.html)
---
#### Get all Notes in a Book
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/me/books/<book_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books/<book_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/books/book_id?book_id={book_id}&after={after}&fields={fields}&isPrev={isPrev}&limit={limit}&api_token={api_token}
```
**Description**: Get all Notes in a Book
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `book_id` | number | Yes | The unique identifier used for each Book in Notes |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | number | No | The note number from which the retrieval has to be done |
| `fields` | string | No | This parameter specifies the details associated with the note that you wish to retrieve. |
| `isPrev` | boolean | No | This parameter specifies whether the retrieval should be in ascending or descending order based on created time. |
| `limit` | number | No | The number of notes that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/me/books/<book_id>?after=VALUE&fields=VALUE&isPrev=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Notes in a Book](https://www.zoho.com/mail/help/api/get-notes-in-book.html)
---
#### Mark a note as favourite
**Method**: `PUT` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id/favorite?entity_id={entity_id}&api_token={api_token}
```
**Description**: Mark a note as favourite
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each note. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Mark a note as favourite](https://www.zoho.com/mail/help/api/put-mark-as-favorite.html)
---
#### Unmark a note a favorite
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/me/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/me/entity_id/favorite?entity_id={entity_id}&api_token={api_token}
```
**Description**: Unmark a note a favorite
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each note. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/me/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Unmark a note a favorite](https://www.zoho.com/mail/help/api/delete-unmark-as-favorite.html)
---
### Category: Notes (Group)
#### Create a Note for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id?group_id={group_id}&bookId={bookId}&color={color}&content={content}&title={title}&api_token={api_token}
```
**Description**: Create a Note for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bookId` | number | No | The unique ID of book you want to add the note to |
| `color` | number | Yes | The unique identifier used to denote the color of a note |
| `content` | string | Yes | The content of the note that is being added |
| `title` | string | No | The title of the note that is being added |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>?bookId=VALUE&color=VALUE&content=VALUE&title=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a Note for Group](https://www.zoho.com/mail/help/api/post-create-notes.html)
---
#### Get a Note for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Get a Note for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the note. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get a Note for Group](https://www.zoho.com/mail/help/api/get-note-details.html)
---
#### Edit a note for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Edit a note for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for a note. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a note for Group](https://www.zoho.com/mail/help/api/put-edit-note.html)
---
#### Get an attachment for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>/attachments/<attachment_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id/attachments/attachment_id?attachment_id={attachment_id}&entity_id={entity_id}&group_id={group_id}&fileName={fileName}&api_token={api_token}
```
**Description**: Get an attachment for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | number | Yes | Attach files as a part of multipart form data |
| `entity_id` | number | Yes | The unique identifier used for the note |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fileName` | string | No | The name of the attachment in the note. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/attachments/<attachment_id>?fileName=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get an attachment for Group](https://www.zoho.com/mail/help/api/get-attachments.html)
---
#### Add an attachment to a note for Group
**Method**: `POST` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>/attachments/`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/attachments/?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id/attachments/?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Add an attachment to a note for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier used for the note |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/attachments/?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add an attachment to a note for Group](https://www.zoho.com/mail/help/api/post-add-attachments.html)
---
#### Delete an attachment for Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>/attachments/<attachment_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id/attachments/attachment_id?attachment_id={attachment_id}&entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Delete an attachment for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attachment_id` | number | Yes | The unique identifier assigned to each attachment |
| `entity_id` | number | Yes | The unique identifier assigned to each bookmark |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/attachments/<attachment_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete an attachment for Group](https://www.zoho.com/mail/help/api/delete-attachments.html)
---
#### Delete a Note for Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Delete a Note for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each note. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Note for Group](https://www.zoho.com/mail/help/api/delete-notes.html)
---
#### Get all Books for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/books`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/books?group_id={group_id}&api_token={api_token}
```
**Description**: Get all Books for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Books for Group](https://www.zoho.com/mail/help/api/get-all-books.html)
---
#### Create a new Book for Group
**Method**: `POST` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/books`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/books?group_id={group_id}&api_token={api_token}
```
**Description**: Create a new Book for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"bookName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bookName` | string | Yes | The name of the Book you want to create in Notes |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Create a new Book for Group](https://www.zoho.com/mail/help/api/post-create-book.html)
---
#### Edit a Book for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/books/<book_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books/<book_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/books/book_id?book_id={book_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Edit a Book for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `book_id` | number | Yes | The unique identifier used for each Book in Notes |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"bookName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bookName` | string | Yes | The name you wish to give the Book that is edited. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books/<book_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a Book for Group](https://www.zoho.com/mail/help/api/put-edit-book.html)
---
#### Delete a Book for Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/books/<book_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books/<book_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/books/book_id?book_id={book_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Delete a Book for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `book_id` | number | Yes | The unique identifier assigned to each book in Notes. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books/<book_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Book for Group](https://www.zoho.com/mail/help/api/delete-book.html)
---
#### Get all Notes in a Book for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/books/<book_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books/<book_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/books/book_id?book_id={book_id}&group_id={group_id}&after={after}&fields={fields}&isPrev={isPrev}&limit={limit}&api_token={api_token}
```
**Description**: Get all Notes in a Book for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `book_id` | number | Yes | The unique identifier used for each Book in Notes |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `after` | number | No | The note number from which the retrieval has to be done |
| `fields` | string | No | This parameter specifies the details associated with the note that you wish to retrieve. |
| `isPrev` | boolean | No | This parameter specifies whether the retrieval should be in ascending or descending order based on created time. |
| `limit` | number | No | The number of notes that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/books/<book_id>?after=VALUE&fields=VALUE&isPrev=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Notes in a Book for Group](https://www.zoho.com/mail/help/api/get-notes-in-book.html)
---
#### Mark a note as favourite for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id/favorite?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Mark a note as favourite for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each note. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Mark a note as favourite for Group](https://www.zoho.com/mail/help/api/put-mark-as-favorite.html)
---
#### Unmark a note a favorite for Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/notes/groups/<group_id>/<entity_id>/favorite`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/notes/groups/group_id/entity_id/favorite?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Unmark a note a favorite for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each note. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/notes/groups/<group_id>/<entity_id>/favorite?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Unmark a note a favorite for Group](https://www.zoho.com/mail/help/api/delete-unmark-as-favorite.html)
---
### Category: Organization
#### Add child organization to a Partner Portal
**Method**: `POST` | **LowCodeAPI Path**: `/api/organization`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization?api_token={api_token}
```
**Description**: Add child organization to a Partner Portal
**Request Body**:
```json
{
"domainName": "<string>",
"emailId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"password": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `domainName` | string | Yes | he domain of the child organization that needs to be added |
| `emailId` | string | Yes | The contact email address of the child organization owner |
| `firstName` | string | Yes | The First Name of the Super Admin of the child organization |
| `lastName` | string | Yes | The Last Name of the Super Admin of the child organization |
| `orgName` | string | No | The name of the child organization that needs to be added |
| `password` | string | Yes | The password of the Super Admin account of the child organization |
| `planName` | string | No | Provide the enrolled plan type of the child organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/organization?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add child organization to a Partner Portal](https://www.zoho.com/mail/help/api/post-add-child-org.html)
---
#### Organization details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zoid>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zoid>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zoid?zo_id={zo_id}&api_token={api_token}
```
**Description**: Organization details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zoid>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Organization details](https://www.zoho.com/mail/help/api/get-org-details.html)
---
#### Organization Subscription Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/storage`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/storage?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/storage?limit={limit}&start={start}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Organization Subscription Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | Used to get the storage details of users in batches.Specify the number of users for which the details of storage need to be retrieved |
| `start` | number | No | Used to get the storage details of users in batches.Specify the order number from which the data retrieval should start. Works better when used with limit parameter. |
| `zo_id` | number | Yes | The unique Zoho Organization Identified for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/storage?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Organization Subscription Details](https://www.zoho.com/mail/help/api/get-org-subscription.html)
---
#### User Storage Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/storage/<zu_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/storage/<zu_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/storage/zu_id?zo_id={zo_id}&zu_id={zu_id}&api_token={api_token}
```
**Description**: User Storage Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
| `zu_id` | number | Yes | The unique Zoho User Identifier for the user |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/storage/<zu_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [User Storage Details](https://www.zoho.com/mail/help/api/get-user-subs.html)
---
#### Update Storage for a User
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>/storage/<zu_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/storage/<zu_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/storage/zu_id?zo_id={zo_id}&zu_id={zu_id}&api_token={api_token}
```
**Description**: Update Storage for a User
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
| `zu_id` | number | Yes | The unique Zoho User Identifier for the user |
**Request Body**:
```json
{
"mode": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `addonType` | string | No | You can allocate multiple add-on storage units to the user by passing the storage unit and the number of unit values as JSON Array. |
| `mode` | string | Yes | To update the Base Storage of the user. Use planType parameter with this mode.To update the Extra Storage for the user. Use addOnType parameter with this mode |
| `planType` | string | No | Provide the plan value subscribed by the Organization as the plan type |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/storage/<zu_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Storage for a User](https://www.zoho.com/mail/help/api/put-user-storage.html)
---
#### Update Organization Spam Processing Type
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id?zo_id={zo_id}&api_token={api_token}
```
**Description**: Update Organization Spam Processing Type
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Request Body**:
```json
{
"SpamVO": "<object>",
"mode": "<string>",
"zoid": "<number>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `SpamVO` | object | Yes | Array containing the type and value parameters |
| `mode` | string | Yes | To modify the Spam Process Type for the Organization |
| `zoid` | number | Yes | Provide the Organization ID for which the Spam Process Type should be updated |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Update Organization Spam Processing Type](https://www.zoho.com/mail/help/api/put-org-spam-type.html)
---
#### Organization Spam Listing Info
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/antispam/data`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/antispam/data?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/antispam/data?zo_id={zo_id}&limit={limit}&mode={mode}&spamCategory={spamCategory}&start={start}&api_token={api_token}
```
**Description**: Organization Spam Listing Info
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The zoid of the organization that can be fetched using the GET Organization details API. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | This parameter is used to get the Spam listing details of the organization in batches. You need to specify the number of items to be retrieved in each batch.The maximum allowed value is 500 |
| `mode` | string | Yes | This is the parameter to denote the mode of action that is performed by the API |
| `spamCategory` | string | Yes | Use this parameter to specify the type of Spam Listing to be retrieved |
| `start` | number | No | You can use this parameter to fetch the Spam listing details of the organization in batches. You need to specify the order number from which the data retrieval should start.This parameter works better when used with the limit parameter |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/antispam/data?limit=VALUE&mode=VALUE&spamCategory=VALUE&start=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Organization Spam Listing Info](https://www.zoho.com/mail/help/api/get-org-spam-info.html)
---
#### Add/ Update Organization Spam Listing Info
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>/antispam/data`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/antispam/data?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/antispam/data?zo_id={zo_id}&api_token={api_token}
```
**Description**: Add/ Update Organization Spam Listing Info
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The zoid of the organization that can be fetched using the GET Organization details API. |
**Request Body**:
```json
{
"Value": "<array>",
"spamCategory": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `Value` | array | Yes | The values such as emails ids domains and IP addresses need to be given as value for this parameter. |
| `spamCategory` | string | Yes | Use this parameter to specify the type of Spam Listing that needs to be added/ updated |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/antispam/data?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add/ Update Organization Spam Listing Info](https://www.zoho.com/mail/help/api/put-org-spam-info.html)
---
#### Remove Organization Spam Listing Info
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/organization/<zo_id>/antispam/data`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/antispam/data?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/antispam/data?zo_id={zo_id}&Value={Value}&spamCategory={spamCategory}&api_token={api_token}
```
**Description**: Remove Organization Spam Listing Info
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The zoid of the organization that can be fetched using the GET Organization details API. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `Value` | array | Yes | The values such as emails ids domains and IP addresses need to be given as value for this parameter |
| `spamCategory` | string | Yes | Use this parameter to specify the type of Spam Listing that needs to be removed |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/antispam/data?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Remove Organization Spam Listing Info](https://www.zoho.com/mail/help/api/remove-spam-info.html)
---
#### Add Allowed IPs
**Method**: `POST` | **LowCodeAPI Path**: `/api/organization/<zo_id>/allowedIps`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/allowedIps?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/allowedips?zo_id={zo_id}&api_token={api_token}
```
**Description**: Add Allowed IPs
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The zoid of the organization that can be fetched using the GET Organization details API. |
**Request Body**:
```json
{
"fromIpRange": "<string>",
"roleId": "<number>",
"toIpRange": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `fromIpRange` | string | Yes | The fromIpRange denotes the start of the IP address range that's allowed for your users to access their accounts. |
| `roleId` | number | Yes | The roleId helps you to assign the allowed IP range to different users in your organization |
| `toIpRange` | string | Yes | The toIpRange denotes the end of the IP address range that's allowed for your users to access their accounts |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/allowedIps?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add Allowed IPs](https://www.zoho.com/mail/help/api/add-allowed-ips-api.html)
---
#### Allowed IPs list
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/allowedIps`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/allowedIps?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/allowedips?zo_id={zo_id}&api_token={api_token}
```
**Description**: Allowed IPs list
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The zoid of the organization that can be fetched using the GET Organization details API. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/allowedIps?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Allowed IPs list](https://www.zoho.com/mail/help/api/get-allowed-ips-api.html)
---
#### Allowed IPs API
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/organization/<zo_id>/allowedIps`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/allowedIps?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/allowedips?zo_id={zo_id}&fromIpRange={fromIpRange}&ipId={ipId}&roleId={roleId}&toIpRange={toIpRange}&api_token={api_token}
```
**Description**: Allowed IPs API
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The zoid of the organization that can be fetched using the GET Organization details API. |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fromIpRange` | string | Yes | The fromIpRange denotes the start of the IP address range that's allowed for your users to access their accounts |
| `ipId` | string | Yes | The ipId denotes the ID assigned to the IP ranges added to certain users in the organization and can be fetched using the GET Allowed IPs API |
| `roleId` | number | Yes | The roleId helps you to assign the allowed IP range to different users in your organization |
| `toIpRange` | string | Yes | The toIpRange denotes the end of the IP address range that's allowed for your users to access their accounts |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/allowedIps?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Allowed IPs API](https://www.zoho.com/mail/help/api/delete-allowed-ips-api.html)
---
### Category: Tasks
#### Get all Tasks with given status
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id?group_id={group_id}&from={from}&limit={limit}&status={status}&api_token={api_token}
```
**Description**: Get all Tasks with given status
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | number | No | The task number from which retrieval has to be done |
| `limit` | number | No | The number of tasks that you would like to retrieve |
| `status` | string | Yes | The status of completion of the given task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>?from=VALUE&limit=VALUE&status=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Tasks with given status](https://www.zoho.com/mail/help/api/get-tasks-with-given-status.html)
---
#### Get personal Tasks
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/me`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me?from={from}&limit={limit}&api_token={api_token}
```
**Description**: Get personal Tasks
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | number | No | The task number from which retrieval has to be done. |
| `limit` | number | No | The number of tasks that you would like to retrieve |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/me?from=VALUE&limit=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get personal Tasks](https://www.zoho.com/mail/help/api/get-personal-tasks.html)
---
#### Get all Tasks created by you
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks?action={action}&from={from}&limit={limit}&view={view}&api_token={api_token}
```
**Description**: Get all Tasks created by you
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `action` | string | Yes | To specify that the action performed is a view action. |
| `from` | number | No | The task number from which retrieval has to be done |
| `limit` | number | No | The number of tasks that you would like to retrieve |
| `view` | string | Yes | To get the tasks that have been created by you |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks?action=VALUE&from=VALUE&limit=VALUE&view=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Tasks created by you](https://www.zoho.com/mail/help/api/get-tasks-created-by-me.html)
---
#### Get single Task
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Get single Task
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifer assigned to each task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get single Task](https://www.zoho.com/mail/help/api/get-single-task.html)
---
#### Get single Task for Group
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Get single Task for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifer assigned to each task |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get single Task for Group](https://www.zoho.com/mail/help/api/get-single-task.html)
---
#### Get all subtasks
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/me/<entity_id>/subtasks`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>/subtasks?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me/entity_id/subtasks?entity_id={entity_id}&api_token={api_token}
```
**Description**: Get all subtasks
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifer assigned to each task. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>/subtasks?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all subtasks](https://www.zoho.com/mail/help/api/get-subtasks.html)
---
#### Get all subtasks for Groups
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/<entity_id>/subtasks`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>/subtasks?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/entity_id/subtasks?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Get all subtasks for Groups
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifer assigned to each task. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>/subtasks?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all subtasks for Groups](https://www.zoho.com/mail/help/api/get-subtasks.html)
---
#### Add a new group Task
**Method**: `POST` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id?group_id={group_id}&api_token={api_token}
```
**Description**: Add a new group Task
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"Assignee": "<number>",
"Title": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `Assignee` | number | Yes | The zuid of the member to whom the task is assigned |
| `Description` | string | No | The task description |
| `Priority` | string | No | The priority to be given for the task |
| `Recurring type` | string | No | The recurrence pattern for the task |
| `Status` | string | No | The status of completion of the task |
| `Title` | string | Yes | The title for the task that is being added |
| `accountId` | number | No | Specifies the account identifier for a specific account of a particular user |
| `allowComments` | boolean | No | If comments for the task can be allowed or not |
| `attachPath` | array | No | The path specified for the uploaded attachment |
| `attachStoreName` | array | No | The StoreName for the uploaded attachment |
| `dueDate` | string | No | The due date that you want to set for the task |
| `dueDateRemindersEnabled` | boolean | No | Whether reminders on the date when the task is due is enabled or disabled |
| `emailReminder` | boolean | No | If reminders need to be sent via email |
| `followers` | array | No | The members who need to follow this task |
| `lockInvites` | boolean | No | If the permission to invite members has to be enabled or disabled |
| `messageId` | number | No | Specifies the unique key used to identify a specific email |
| `popupReminder` | boolean | No | If reminder notifications need be sent |
| `projectId` | number | No | The unique identifer assigned to each project created for group tasks |
| `recurDailyOnlyOnWeekdays` | boolean | No | If the task has to recur everyday in the weekdays |
| `recurFor` | number | No | The number of times the task has to recur |
| `recurFrom` | string | No | The date from which recurrence has to start |
| `recurMonthlyOnDayOfMonth` | number | No | The day of the month when the task has to recur every month |
| `recurMonthlyOnDayOfWeek` | number | No | The day of the week when the task has to recur every month |
| `recurMonthlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every month |
| `recurUntil` | string | No | The date until which the task has to recur |
| `recurWeeklyOn` | number | No | The day of the week when the task has to recur every week |
| `recurYearlyOnDayOfMonth` | number | No | The date of the month when the task has to recur every year |
| `recurYearlyOnDayOfWeek` | number | No | The day of the week when the task has to recur every year |
| `recurYearlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every year |
| `recurYearlyOnMonth` | number | No | The month when the task has to recur for that year |
| `recurringFrequency` | number | No | The frequency at which the task has to recur |
| `remindAssignee` | boolean | No | If the member to whom the task is assigned needs to be reminded |
| `remindOwner` | boolean | No | If the task owner needs to reminded |
| `reminderDate` | string | No | The date when you want to be reminded about the task |
| `subtask` | object | No | The details of the subtask that has to be added as a task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a new group Task](https://www.zoho.com/mail/help/api/post-group-task.html)
---
#### Add a new personal Task
**Method**: `POST` | **LowCodeAPI Path**: `/api/tasks/me`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me?api_token={api_token}
```
**Description**: Add a new personal Task
**Request Body**:
```json
{
"Assignee": "<number>",
"Title": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `Assignee` | number | Yes | The zuid of the member to whom the task is assigned |
| `Description` | string | No | The task description |
| `Priority` | string | No | The priority to be given for the task |
| `Recurring type` | string | No | The recurrence pattern for the task |
| `Status` | string | No | The status of completion of the task |
| `Title` | string | Yes | The title for the task that is being added |
| `accountId` | number | No | Specifies the account identifier for a specific account of a particular user |
| `allowComments` | boolean | No | If comments for the task can be allowed or not |
| `attachPath` | array | No | The path specified for the uploaded attachment |
| `attachStoreName` | array | No | The StoreName for the uploaded attachment |
| `dueDate` | string | No | The due date that you want to set for the task |
| `dueDateRemindersEnabled` | boolean | No | Whether reminders on the date when the task is due is enabled or disabled |
| `emailReminder` | boolean | No | If reminders need to be sent via email |
| `followers` | array | No | The members who need to follow this task |
| `lockInvites` | boolean | No | If the permission to invite members has to be enabled or disabled |
| `messageId` | number | No | Specifies the unique key used to identify a specific email |
| `popupReminder` | boolean | No | If reminder notifications need be sent |
| `projectId` | number | No | The unique identifer assigned to each project created for group tasks |
| `recurDailyOnlyOnWeekdays` | boolean | No | If the task has to recur everyday in the weekdays |
| `recurFor` | number | No | The number of times the task has to recur |
| `recurFrom` | string | No | The date from which recurrence has to start |
| `recurMonthlyOnDayOfMonth` | number | No | The day of the month when the task has to recur every month |
| `recurMonthlyOnDayOfWeek` | number | No | The day of the week when the task has to recur every month |
| `recurMonthlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every month |
| `recurUntil` | string | No | The date until which the task has to recur |
| `recurWeeklyOn` | number | No | The day of the week when the task has to recur every week |
| `recurYearlyOnDayOfMonth` | number | No | The date of the month when the task has to recur every year |
| `recurYearlyOnDayOfWeek` | number | No | The day of the week when the task has to recur every year |
| `recurYearlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every year |
| `recurYearlyOnMonth` | number | No | The month when the task has to recur for that year |
| `recurringFrequency` | number | No | The frequency at which the task has to recur |
| `remindAssignee` | boolean | No | If the member to whom the task is assigned needs to be reminded |
| `remindOwner` | boolean | No | If the task owner needs to reminded |
| `reminderDate` | string | No | The date when you want to be reminded about the task |
| `subtask` | object | No | The details of the subtask that has to be added as a task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/tasks/me?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a new personal Task](https://www.zoho.com/mail/help/api/post-add-new-task.html)
---
#### Change or set recurring Task
**Method**: `PUT` | **LowCodeAPI Path**: `/api/tasks/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Change or set recurring Task
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each task. |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `recurDailyOnlyOnWeekdays` | boolean | No | If the task has to recur everyday in the weekdays |
| `recurFor` | string | No | The number of times the task has to recur |
| `recurMonthlyOnDayOfMonth` | number | No | The day of the month when the task has to recur every month |
| `recurMonthlyOnDayOfWeek` | number | No | The day of the week when the task has to recur every month |
| `recurMonthlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every month |
| `recurUntil` | string | No | The date until which the task has to recur |
| `recurWeeklyOn` | number | No | Specifies the day of the week when the task has to recur every week |
| `recurYearlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every year |
| `recurringFrequency` | number | No | The frequency at which the task has to recur |
| `recurringType` | String | No | Specifies the recurrence pattern for the task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Change or set recurring Task](https://www.zoho.com/mail/help/api/put-change-recurring-task-details.html)
---
#### Change Task priority
**Method**: `PUT` | **LowCodeAPI Path**: `/api/tasks/me/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomailapi/tasks/me/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Change Task priority
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each task |
**Request Body**:
```json
{
"priority": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `priority` | string | Yes | The new priority that you want to give for the task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/tasks/me/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Change Task priority](https://www.zoho.com/mail/help/api/put-change-task-priority.html)
---
#### Delete a Task assigned to you/ created by you
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/tasks/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/entity_id?entity_id={entity_id}&api_token={api_token}
```
**Description**: Delete a Task assigned to you/ created by you
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/tasks/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a Task assigned to you/ created by you](https://www.zoho.com/mail/help/api/delete-personal-task.html)
---
#### Get all groups
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/groups/`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/?api_token={api_token}
```
**Description**: Get all groups
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/groups/?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all groups](https://www.zoho.com/mail/help/api/get-group-details.html)
---
### Category: Tasks (Group)
#### Get all Tasks in a project with a given status
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/projects/<project_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects/<project_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/projects/project_id?group_id={group_id}&from={from}&limit={limit}&status={status}&api_token={api_token}
```
**Description**: Get all Tasks in a project with a given status
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization
projectId |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | number | No | The task number from which the retrieval has to be done |
| `limit` | number | No | The number of tasks that you would like to retrieve |
| `status` | string | Yes | The status of completion of the given task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects/<project_id>?from=VALUE&limit=VALUE&status=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all Tasks in a project with a given status](https://www.zoho.com/mail/help/api/get-tasks-in-project-given-status.html)
---
#### Set/ change Task Reminder for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Set/ change Task Reminder for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each task. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"reminderDate": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `emailReminder` | boolean | No | you want to be reminded through email |
| `popupReminder` | boolean | No | Whether you want to be reminded through popup notification |
| `reminderDate` | string | Yes | The date when you want to be reminded |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Set/ change Task Reminder for Group](https://www.zoho.com/mail/help/api/put-change-task-reminder.html)
---
#### Change or set recurring Task for Group
**Method**: `PUT` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Change or set recurring Task for Group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each task. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"key": "value"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `recurDailyOnlyOnWeekdays` | boolean | No | If the task has to recur everyday in the weekdays |
| `recurFor` | string | No | The number of times the task has to recur |
| `recurMonthlyOnDayOfMonth` | number | No | The day of the month when the task has to recur every month |
| `recurMonthlyOnDayOfWeek` | number | No | The day of the week when the task has to recur every month |
| `recurMonthlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every month |
| `recurUntil` | string | No | The date until which the task has to recur |
| `recurWeeklyOn` | number | No | Specifies the day of the week when the task has to recur every week |
| `recurYearlyOnDayOfWeekInMonth` | number | No | The day of the week in a particular month when the task has to recur every year |
| `recurringFrequency` | number | No | The frequency at which the task has to recur |
| `recurringType` | String | No | Specifies the recurrence pattern for the task |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Change or set recurring Task for Group](https://www.zoho.com/mail/help/api/put-change-recurring-task-details.html)
---
#### Delete a group Task
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/<entity_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/entity_id?entity_id={entity_id}&group_id={group_id}&api_token={api_token}
```
**Description**: Delete a group Task
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entity_id` | number | Yes | The unique identifier assigned to each task. |
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/<entity_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a group Task](https://www.zoho.com/mail/help/api/delete-group-task.html)
---
#### Get all projects in a group
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/projects`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/projects?group_id={group_id}&api_token={api_token}
```
**Description**: Get all projects in a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get all projects in a group](https://www.zoho.com/mail/help/api/get-projects-in-group.html)
---
#### Add a new project
**Method**: `POST` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/projects`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/projects?group_id={group_id}&api_token={api_token}
```
**Description**: Add a new project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Request Body**:
```json
{
"projectName": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `projectName` | string | Yes | The name that you want to give this project |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add a new project](https://www.zoho.com/mail/help/api/post-add-new-project.html)
---
#### Edit a project
**Method**: `PUT` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/projects/<project_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects/<project_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/projects/project_id?group_id={group_id}&api_token={api_token}
```
**Description**: Edit a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization
projectId |
**Request Body**:
```json
{
"projectName": "<\u200bstring>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `projectName` | string | Yes | The new name that you want to give this project |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects/<project_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Edit a project](https://www.zoho.com/mail/help/api/put-edit-tasks-project.html)
---
#### Delete a project
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/projects/<project_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects/<project_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/projects/project_id?group_id={group_id}&project_id={project_id}&api_token={api_token}
```
**Description**: Delete a project
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
| `project_id` | number | Yes | The unique identifier assigned to each project created for a group task. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/projects/<project_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete a project](https://www.zoho.com/mail/help/api/delete-tasks-project.html)
---
#### Get member details in a group
**Method**: `GET` | **LowCodeAPI Path**: `/api/tasks/groups/<group_id>/members`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/members?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/tasks/groups/group_id/members?group_id={group_id}&api_token={api_token}
```
**Description**: Get member details in a group
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | number | Yes | The unique identifier used for groups in the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/tasks/groups/<group_id>/members?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Get member details in a group](https://www.zoho.com/mail/help/api/get-group-member-details.html)
---
### Category: Threads
#### Mark thread as not spam
**Method**: `PUT` | **LowCodeAPI Path**: `/api/accounts/<account_id>/updatethread`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/updatethread?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id/updatethread?account_id={account_id}&api_token={api_token}
```
**Description**: Mark thread as not spam
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | number | Yes | This is the unique identifier for a particular user account. |
**Request Body**:
```json
{
"mode": "<string>",
"threadId": "<array>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `folderId` | number | No | FolderId of the folder in which a thread is to be marked as not spam |
| `isArchive` | boolean | No | If the email thread is archived or not |
| `isFolderSpecific` | boolean | No | If a thread that needs to be marked as not spam is folder specific folderId is mandatory. |
| `mode` | string | Yes | Provide the mode as markNotSpam to mark a thread as not spam |
| `threadId` | array | Yes | Single or Multiple Thread Ids that need(s) to be marked as not spam |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>/updatethread?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Mark thread as not spam](https://www.zoho.com/mail/help/api/put-mark-thread-as-not-spam.html)
---
### Category: Users
#### Change POP Status (Using User Authentication)
**Method**: `PUT` | **LowCodeAPI Path**: `/api/accounts/<account_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/accounts/account_id?accountId={accountId}&api_token={api_token}
```
**Description**: Change POP Status (Using User Authentication)
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountId` | string | Yes | This parameter is used to identify the account of the user whose POP status is updated. |
**Request Body**:
```json
{
"mode": "<string>",
"updatePOPStatus": "<boolean>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mode` | string | Yes | This parameter represents the type of operation that is to be performed. |
| `updatePOPStatus` | boolean | Yes | This parameter specifies whether to enable/disable user's POP status. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/accounts/<account_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Change POP Status (Using User Authentication)](https://www.zoho.com/mail/help/api/put-change-pop-status-user.html)
---
### Category: Users (Organization)
#### To Disable User
**Method**: `PUT` | **LowCodeAPI Path**: `/api/organization/<zo_id>/accounts/<account_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts/<account_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/accounts/account_id?accountId={accountId}&zoid={zoid}&api_token={api_token}
```
**Description**: To Disable User
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accountId` | string | Yes | This parameter is the identifier for the user account to be disabled. |
| `zoid` | string | Yes | This parameter is the unique Zoho Organization Identifier for the organization. |
**Request Body**:
```json
{
"mode": "<string>",
"zuid": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `blockIncoming` | boolean | No | This parameter specifies whether to block the incoming for the account. |
| `mode` | string | Yes | This parameter represents the type of operation that is to be performed. |
| `removeGroupMembership` | boolean | No | This parameter specifies whether to remove the user from all groups. |
| `removeMailforward` | boolean | No | TThis parameter specifies whether to remove all forwarding action added to this user account |
| `zuid` | string | Yes | This parameter is the unique identifier for each user in an organization. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X PUT "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts/<account_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [To Disable User](https://www.zoho.com/mail/help/api/put-to-disable-user.html)
---
#### User Account Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/accounts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/accounts?zo_id={zo_id}&limit={limit}&start={start}&api_token={api_token}
```
**Description**: User Account Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | number | No | This parameter is used to get the user details of in batches. |
| `start` | number | No | This parameter is used to get the user details of in batches |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts?limit=VALUE&start=VALUE&api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [User Account Details](https://www.zoho.com/mail/help/api/get-org-users-details.html)
---
#### Add User to Organization
**Method**: `POST` | **LowCodeAPI Path**: `/api/organization/<zo_id>/accounts`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/accounts?zo_id={zo_id}&api_token={api_token}
```
**Description**: Add User to Organization
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Request Body**:
```json
{
"employeeId": "<string>",
"lastName": "<string>",
"password": "<string>",
"primaryEmailAddress": "<string>"
}
```
**Request Body Fields**:
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country` | string | No | Specifies the country the user works from. Refer here for allowed values. |
| `department` | string | No | Provide the department in which the user works. |
| `designation` | string | No | Provide the designation the user holds. |
| `displayName` | string | No | Specifies the display name to be assigned to the user. |
| `employeeId` | string | Yes | Provide the employee ID of the user. |
| `extension` | string | No | Provide the extension number of the user. |
| `groupMailList` | array | No | Specifies an array of the group's email addresses to which the user needs to be added. |
| `language` | string | No | Specifies the choice of language for the user. Refer here for allowed values. |
| `lastName` | string | Yes | Provide the last name of the user. |
| `mobileNumber` | string | No | Provide the mobile number of the user. |
| `oneTimePassword` | boolean | No | Specifies if the password is a one-time password. |
| `password` | string | Yes | Specifies the password for the user to be created. |
| `primaryEmailAddress` | string | Yes | Specifies the domain-based primary email address for the user to be created. |
| `role` | enum | No | Specifies the role to be assigned for the user to be created. |
| `timeZone` | string | No | Specifies the timezone the user works from. Refer here for allowed values. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X POST "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Add User to Organization](https://www.zoho.com/mail/help/api/post-add-user-to-org.html)
---
#### Single User Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/accounts/<zuid>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts/<zuid>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/accounts/zuid?zo_id={zo_id}&zuid={zuid}&api_token={api_token}
```
**Description**: Single User Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
| `zuid` | number | Yes | This parameter denotes the unique identifier for each user in an organization. |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts/<zuid>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Single User Details](https://www.zoho.com/mail/help/api/get-single-user.html)
---
#### Single User Details
**Method**: `GET` | **LowCodeAPI Path**: `/api/organization/<zo_id>/accounts/<emailAddress>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts/<emailAddress>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/zo_id/accounts/emailaddress?emailAddress={emailAddress}&zo_id={zo_id}&api_token={api_token}
```
**Description**: Single User Details
**Path Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emailAddress` | string | Yes | This parameter specifies the email address of the user whose details are retrieved. |
| `zo_id` | number | Yes | The unique Zoho Organization Identifier for the organization |
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X GET "https://api.lowcodeapi.com/zohomail/api/organization/<zo_id>/accounts/<emailAddress>?api_token=YOUR_API_TOKEN"
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Single User Details](https://www.zoho.com/mail/help/api/get-single-user.html)
---
#### Delete User Accounts
**Method**: `DELETE` | **LowCodeAPI Path**: `/api/organization/accounts/<account_id>`
**New Format (Priority)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/accounts/<account_id>?api_token=YOUR_API_TOKEN
```
**Old Format (Fallback)**:
```bash
https://api.lowcodeapi.com/zohomail/api/organization/accounts/account_id?api_token={api_token}
```
**Description**: Delete User Accounts
**Example Request**:
```bash
# NEW FORMAT (PRIORITY) - Path parameters stay in URL
curl -X DELETE "https://api.lowcodeapi.com/zohomail/api/organization/accounts/<account_id>?api_token=YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{"key": "value"}'
```
**Example Response**:
```json
{
"data": {
// Provider response here
}
}
```
**Official Documentation**: [Delete User Accounts](https://www.zoho.com/mail/help/api/user-account-deletion.html)
---
## API Definition Endpoints
You can retrieve the complete OpenAPI specification for this provider using these endpoints:
**New Format (OpenAPI spec with dynamic path parameters):**
```bash
curl -X GET "https://backend.lowcodeapi.com/zohomail/openapi"
```
**Old Format (API definition with sanitized paths):**
```bash
curl -X GET "https://backend.lowcodeapi.com/zohomail/definition"
```
## Response Format
All responses from LowCodeAPI are wrapped in a `data` key:
```json
{
"data": {
// Actual response from provider API
}
}
```
The `data` key contains the raw response from the provider's API.
## Complete Endpoint Reference
For a complete list of all 134 endpoints, refer to:
- **Official Provider Documentation**: https://www.zoho.com/mail/help/api/overview.html
## Usage Examples
### Example 1: Basic API Request (New Format)
Making a simple request to Zoho Mail:
```bash
# Replace RESOURCE_ID with an actual resource ID from your Zoho Mail account
curl -X GET "https://api.lowcodeapi.com/zohomail/resource/{RESOURCE_ID}?api_token=YOUR_API_TOKEN"
```
### Example 2: Request with Query Parameters (New Format)
Request with specific parameters:
```bash
# Include query parameters for filtering
curl -X GET "https://api.lowcodeapi.com/zohomail/resources?filter=value&api_token=YOUR_API_TOKEN"
```
## Error Handling
Standard HTTP status codes apply. All responses are wrapped in a `data` key:
```json
{
"data": {
// Actual response from provider
}
}
```