### API Response Examples

Source: https://www.zoho.com/mail/help/api/add-bookmark.html

Examples of successful and failed API responses in JSON format.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "entityId": "1712055358708110001",
    "URI": "https://mail.zoho.com/api/links/groups/123456789/1712055358708110001"
  }
}
```

```json
{
  "data": {
    "errorCode": "JSON_PARSE_ERROR"
  },
  "status": {
    "code": 404,
    "description": "Invalid Input Stream"
  }
}
```

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

### Sample email response object

Source: https://www.zoho.com/mail/help/api/mail-details.html

Example JSON structure returned when querying email details.

```json
{
"FROM": "rebecca@zylker.com", 
"TO": ""Paula M"<paula@zylker.com>", 
"CC": "",
"BCC":" ",
"ACCOUNT_ID": "5164940000000008001",
"MSGID": "3881227000005765001",
"SUBJECT": "Website Design",
"SM": "<p>Attached design ideas</p>",
"NEWATTR": "[ {\"st\": 0, \"attType\": 1, \"e\": \"157742754265103002\", \"part\": \"1\", \"fn\": \"Sample_Name.PDF\", \"l\": [], \"fmt\": \"pdf\", \"fs\": \"1443832\", \"ft\": 102, \"et\": 1, \"p\": \"1\", \"inline\": false, \"size\": \"1443892\", \"u\": \"c6f059b0-2870-11ea-aea7-0cc47a81d49e\", \"appId\": \"0\", \"name\": \"Sample_Name.PDF\", \"tn\": false, \"Id\": \"137967203327290000\", \"id\": \"137967203327290000\", \"shT\": 0, \"gId\": \"688974046\", \"groupId\": \"688974046\", \"entityId\": \"1577427542651030001\", \"entityType\": 1, \"attachId\": \"137967203427290000\"}]",
"CONTENT":"<meta /><div><div style=\"font-size: 12pt; font-family: Georgia, Times New Roman, Times, serif\"><div>Hi Paula,<br /></div><div><br /></div><div>This is in continuation to our discussion about the upcoming website design.<br /></div><div><br /></div><div>I have attached with this email some design ideas that my team has come up with.<br /></div><div><br /></div><div><br /></div><div><br /></div><div>Regards<br /></div><div>Rebecca</div><div><br /></div></div><br /></div>",
"FOLDERNAME": "Inbox"
}
```

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

### Get All Policies

Source: https://www.zoho.com/mail/help/api/index.html

Retrieves a list of all organization policies.

```APIDOC
## GET /api/organization/{zoid}/policy

### Description
Retrieves all policies for the specified organization.

### Method
GET

### Endpoint
/api/organization/{zoid}/policy

### Parameters
#### Path Parameters
- **zoid** (string) - Required - The organization ID.
```

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

### Retrieve All Policies Request

Source: https://www.zoho.com/mail/help/api/get-all-policies.html

Example cURL request to fetch policies for a specific organization ID.

```bash
curl "https://mail.zoho.com/api/organization/12345678/policy?limit=10&start=0&searchKey=business" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***"
```

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

### Handle Drag Initiation

Source: https://www.zoho.com/mail/help/api/mail-drag-drop.html

Triggered when a drag operation is started.

```javascript
clientsdk.on("drag", {started: true})
```

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

### GET /api/tasks/

Source: https://www.zoho.com/mail/help/api/get-tasks-created-by-me.html

Retrieves a list of all tasks created by the authenticated user.

```APIDOC
## GET /api/tasks/

### Description
Retrieves all tasks created by the user, providing details such as ID, title, description, due date, owner, assignee, priority, status, project information, subtasks, and attachments.

### Method
GET

### Endpoint
https://mail.zoho.com/api/tasks/

### Parameters
#### Query Parameters
- **view** (string) - Required - Specifies to retrieve the tasks that have been assigned to the user. Value must be 'createdbyme'.
- **action** (string) - Required - Specifies the action to be performed. Value must be 'view'.
- **limit** (integer) - Optional - Specifies the number of tasks to retrieve (1-499). Default is 20.
- **from** (integer) - Optional - Specifies the task number from which retrieval has to be done. Default is 0.

### Request Example
curl "https://mail.zoho.com/api/tasks/?view=createdbyme&action=view&from=1&limit=1" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

### Response
#### Success Response (200)
- **status** (object) - Contains code and description.
- **data** (object) - Contains paging information and the list of tasks.

#### Response Example
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/?view=createdbyme&action=view&from=1&limit=1"
    },
    "tasks": [
      {
        "owner": {
          "name": "Rebecca",
          "id": 42522589
        },
        "numberOfSubtasks": 0,
        "modifiedTime": "2018-10-30T15:36:27+05:30",
        "attachments": [],
        "subtasks": [],
        "dueDate": "30/10/2018",
        "description": "Blog posts and announcements",
        "project": {
          "name": "General",
          "id": "4497000000053001"
        },
        "title": "Revamp Announcements",
        "priority": "Normal",
        "tags": [],
        "createdAt": "2018-10-25T13:36:51+05:30",
        "followers": [],
        "namespaceId": "42522589",
        "id": "4497000001134001",
        "assignee": {
          "name": "Paula M",
          "id": 42522589
        },
        "status": "In Progress"
      }
    ]
  }
}
```

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

### API Response Formats

Source: https://www.zoho.com/mail/help/api/getting-started-with-api.html

Examples of successful and unsuccessful JSON responses returned by the API.

```json
{
"status": {
"code": 200,
"description": "success"
},
"data": {
"subject": "Invitation",
"messageId": "1726208416259127700",
"fromAddress": "rebecca@zylker.com",
"mailId": " <191ea0a1955.d9bc1acf2142936.8470410454014158620@zylker.com>",
"toAddress": "paula@zylker.com",
"content": "Invitation content"
}
}
```

```json
{
"status": {
"code": 500,
"description": "Internal Error"
},
"data": {
"moreInfo": "Internal Error"
}
}
```

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

### Retrieve Group Tasks Request

Source: https://www.zoho.com/mail/help/api/get-group-task-details.html

Example URL for fetching tasks from a specific group ID with a limit parameter.

```http
https://mail.zoho.com/api/tasks/groups/53658048?limit=1
```

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

### Retrieve All Policies Response

Source: https://www.zoho.com/mail/help/api/get-all-policies.html

Sample JSON response structure returned by the Get All Policies API.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "externalImap": true,
      "policyName": "business",
      "zoid": 12345678,
      "usersCount": "0",
      "incomingMaxMailRate": 100,
      "shareMailBox": {
        "restricted": false,
        "value": true
      },
      "junkCleanup": {
        "restricted": false,
        "value": 30
      },
      "contactRestriction": {
        "org": true,
        "personal": true,
        "group": true
      },
      "strictTLS": {
        "isInHerited": false,
        "tlsType": 0
      },
      "incomingMaxMailSizePerMail": 40960,
      "policyID": "1003505000089962560",
      "groupCount": "0",
      "popSetting": {
        "restricted": false,
        "value": false
      },
      "smartFilter": {
        "restricted": false,
        "value": false
      },
      "hugeAttachment": {
        "value": 1024
      }
    }
  ]
}
```

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

### GET /api/tasks/groups/{zgid} - Get Group Tasks

Source: https://www.zoho.com/mail/help/api/get-all-group-or-personal-tasks.html

Retrieves all tasks within a specified group. You can control the number of tasks returned and the starting point of the retrieval using query parameters.

```APIDOC
## GET /api/tasks/groups/{zgid}

### Description
Retrieves all tasks within a specified group. This endpoint allows you to fetch tasks associated with a particular group ID. You can paginate through the results using the `limit` and `from` query parameters.

### Method
GET

### Endpoint
https://mail.zoho.com/api/tasks/groups/{zgid}

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Specifies the number of tasks to retrieve. Possible values: (1 - 499). Default value: 20
- **from** (integer) - Optional - Specifies the task number from which retrieval has to be done. e.g.: If you want to retrieve tasks starting from the 50th task to the 70th task, the 'from' value should be 50, and the 'limit' value should be 20. Possible values: (0 - Number of tasks available). Default value: 0

### Request Example
```json
{
  "example": "curl \"https://mail.zoho.com/api/tasks/groups/5365*****?from=2&limit=1\" \
-X GET \
-H \"Accept: application/json\" \
-H \"Content-Type: application/json\" \
-H \"Authorization:Zoho-oauthtoken *****\""
}
```

### Response
#### Success Response (200)
- **status** (object) - Contains the status code and description of the response.
- **data** (object) - Contains the task data and pagination information.
  - **paging** (object) - Pagination details.
    - **nextPage** (string) - URL for the next page of results.
  - **tasks** (array) - An array of task objects.
    - **owner** (object) - Information about the task owner.
    - **numberOfSubtasks** (integer) - The number of subtasks associated with the task.
    - **modifiedTime** (string) - The date and time when the task was last modified.
    - **attachments** (array) - An array of attachment objects.
    - **subtasks** (array) - An array of subtask objects.
    - **description** (string) - The description of the task.
    - **project** (object) - Information about the project the task belongs to.
    - **title** (string) - The title of the task.
    - **priority** (string) - The priority level of the task.
    - **tags** (array) - An array of tags associated with the task.
    - **createdAt** (string) - The date and time when the task was created.
    - **followers** (array) - An array of follower objects.
    - **namespaceId** (string) - The namespace ID of the task.
    - **id** (string) - The unique identifier of the task.
    - **assignee** (object or null) - Information about the task assignee, or null if not assigned.
    - **status** (string) - The current status of the task.

#### Response Example
```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/groups/5365*****?from=2&limit=1"
    },
    "tasks": [
      {
        "owner": {
          "name": "Rebecca",
          "id": 53608806
        },
        "numberOfSubtasks": 0,
        "modifiedTime": "2018-10-30T15:14:10+05:30",
        "attachments": [],
        "subtasks": [],
        "description": "",
        "project": {
          "name": "General",
          "id": "17461000000006001"
        },
        "title": "Marketing Collaterals",
        "priority": "Normal",
        "tags": [],
        "createdAt": "2018-10-30T15:14:10+05:30",
        "followers": [],
        "namespaceId": "53658048",
        "id": "17461000000053006",
        "assignee": null,
        "status": "In Progress"
      }
    ]
  }
}
```
```

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

### Sample Success Response for Get All Books

Source: https://www.zoho.com/mail/help/api/get-all-books.html

This JSON structure represents a successful response when fetching book details. It includes a list of projects (books) and optionally highlights the default project.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "projects": [
      {
        "bookName": "General",
        "bookId": "3764869000000005003"
      },
      {
        "bookName": "noteBook0",
        "bookId": "3764869000000007001"
      },
      {
        "bookName": "noteBook1",
        "bookId": "3764869000000012001"
      }
    ],
    "defaultProject": {
      "bookName": "General",
      "bookId": "3764869000000005003"
    }
  }
}
```

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

### Get All Personal Tasks - Sample Request

Source: https://www.zoho.com/mail/help/api/get-all-group-or-personal-tasks.html

This cURL command demonstrates how to fetch all your personal tasks. Remember to substitute ***** with your valid authorization token.

```curl
curl "https://mail.zoho.com/api/tasks/me?limit=1&from=1" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****" \

```

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

### Sample Success Response

Source: https://www.zoho.com/mail/help/api/get-all-bookmarks.html

This is a sample JSON response indicating a successful retrieval of bookmark data. It includes pagination details and a list of bookmarks with their associated information.

```json
{
   "status": {
       "code": 200,
       "description": "success"
   },
   "data": {
       "pagination": {
           "next": "https://mail.zoho.com/api/links/groups/84626808?&after=2&limit=2"
       },
       "list": [
           {
               "summary": "Link Description",
               "namespaceId": "84626808",
               "link": "https://www.zoho.com",
               "entityId": "1712055380477110001",
               "title": "zoho link",
               "collectionId": "3764869000000006003",
               "linkMetaInfo": {
                   "linkTitle": "Zoho | Cloud Software Suite for Businesses",
                   "linkImage": "https://www.zohowebstatic.com/sites/zweb/images/zoho_general_pages/zh-homev2-banner.png"
               },
               "collectionName": "General",
               "isFavorite": "false",
               "tags": []
           },
           {
               "summary": "Link Description",
               "namespaceId": "84626808",
               "link": "https://www.zoho.com",
               "entityId": "1712055358708110001",
               "title": "zoho link",
               "collectionId": "3764869000000006003",
               
```

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

### Get All Collections in Groups Request

Source: https://www.zoho.com/mail/help/api/get-all-group-collections-api.html

Use this cURL command to make a GET request to retrieve all collections in groups. Ensure you replace '*****' with a valid Zoho-oauthtoken.

```curl
curl "https://mail.zoho.com/api/links/groups/collections" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"
```

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

### Sample Success Response

Source: https://www.zoho.com/mail/help/api/delete-collection.html

A successful deletion of a bookmark collection will return a 200 status code with a 'success' description.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  }
}
```

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

### GET /api/tasks/me - Get Personal Tasks

Source: https://www.zoho.com/mail/help/api/get-all-group-or-personal-tasks.html

Retrieves all personal tasks assigned to the authenticated user. This endpoint allows for pagination using `limit` and `from` query parameters.

```APIDOC
## GET /api/tasks/me

### Description
Retrieves all personal tasks associated with the authenticated user. This endpoint is useful for fetching a user's individual task list. Pagination can be managed using the `limit` and `from` query parameters.

### Method
GET

### Endpoint
https://mail.zoho.com/api/tasks/me

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Specifies the number of tasks to retrieve. Possible values: (1 - 499). Default value: 20
- **from** (integer) - Optional - Specifies the task number from which retrieval has to be done. e.g.: If you want to retrieve tasks starting from the 50th task to the 70th task, the 'from' value should be 50, and the 'limit' value should be 20. Possible values: (0 - Number of tasks available). Default value: 0

### Request Example
```json
{
  "example": "curl \"https://mail.zoho.com/api/tasks/me?limit=1&from=1\" \
-X GET \
-H \"Accept: application/json\" \
-H \"Content-Type: application/json\" \
-H \"Authorization:Zoho-oauthtoken *****\""
}
```

### Response
#### Success Response (200)
- **status** (object) - Contains the status code and description of the response.
- **data** (object) - Contains the task data and pagination information.
  - **paging** (object) - Pagination details.
    - **nextPage** (string) - URL for the next page of results.
  - **tasks** (array) - An array of task objects.
    - **owner** (object) - Information about the task owner.
    - **numberOfSubtasks** (integer) - The number of subtasks associated with the task.
    - **modifiedTime** (string) - The date and time when the task was last modified.
    - **attachments** (array) - An array of attachment objects.
    - **subtasks** (array) - An array of subtask objects.
    - **dueDate** (string) - The due date of the task.
    - **description** (string) - The description of the task.
    - **project** (object) - Information about the project the task belongs to.
    - **title** (string) - The title of the task.
    - **priority** (string) - The priority level of the task.
    - **tags** (array) - An array of tags associated with the task.
    - **createdAt** (string) - The date and time when the task was created.
    - **followers** (array) - An array of follower objects.
    - **namespaceId** (string) - The namespace ID of the task.
    - **id** (string) - The unique identifier of the task.
    - **assignee** (object) - Information about the task assignee.
    - **status** (string) - The current status of the task.

#### Response Example
```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/me?from=1&limit=1"
    },
    "tasks": [
      {
        "owner": {
          "name": "Rebecca",
          "id": 42522589
        },
        "numberOfSubtasks": 0,
        "modifiedTime": "2018-10-30T15:36:27+05:30",
        "attachments": [],
        "subtasks": [],
        "dueDate": "30/10/2018",
        "description": "Blog posts and announcements for the release",
        "project": {
          "name": "Blogging",
          "id": "4497000000053001"
        },
        "title": "Revamp Announcements",
        "priority": "Normal",
        "tags": [],
        "createdAt": "2018-10-25T13:36:51+05:30",
        "followers": [],
        "namespaceId": "42522589",
        "id": "4497000001134001",
        "assignee": {
          "name": "Paula M",
          "id": 42522589
        },
        "status": "In Progress"
      }
    ]
  }
}
```
```

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

### Get Mail Details API

Source: https://www.zoho.com/mail/help/api/mail-details.html

This section covers endpoints for retrieving email details. You can get current mail information or details of a specific email using its message ID.

```APIDOC
## Get Current Mail Details

### Description
Retrieves the current email details, such as From, To, and CC, typically used when an email is previewed.

### Method
GET

### Endpoint
clientsdk.get(["currentMailInfo"])

### Parameters
None

### Request Example
```javascript
clientsdk.get(["currentMailInfo"]).then(function(mailObj){console.log(mailObj);});
```

### Response
#### Success Response (200)
Returns an object containing current mail information.

#### Response Example
```json
{
  "FROM": "rebecca@zylker.com", 
  "TO": ""Paula M"<paula@zylker.com>",
  "CC": "",
  "BCC":" ",
  "ACCOUNT_ID": "5164940000000008001",
  "MSGID": "3881227000005765001",
  "SUBJECT": "Website Design",
  "SM": "<p>Attached design ideas</p>",
  "NEWATTR": "[ {\"st\": 0, \"attType\": 1, \"e\": \"157742754265103002\", \"part\": \"1\", \"fn\": \"Sample_Name.PDF\", \"l\": [], \"fmt\": \"pdf\", \"fs\": \"1443832\", \"ft\": 102, \"et\": 1, \"p\": \"1\", \"inline\": false, \"size\": \"1443892\", \"u\": \"c6f059b0-2870-11ea-aea7-0cc47a81d49e\", \"appId\": \"0\", \"name\": \"Sample_Name.PDF\", \"tn\": false, \"Id\": \"137967203327290000\", \"id\": \"137967203327290000\", \"shT\": 0, \"gId\": \"688974046\", \"groupId\": \"688974046\", \"entityId\": \"1577427542651030001\", \"entityType\": 1, \"attachId\": \"137967203427290000\"}]",
  "CONTENT":"<meta /><div><div style=\"font-size: 12pt; font-family: Georgia, Times New Roman, Times, serif\"><div>Hi Paula,<br /></div><div><br /></div><div>This is in continuation to our discussion about the upcoming website design.<br /></div><div><br /></div><div>I have attached with this email some design ideas that my team has come up with.<br /></div><div><br /></div><div><br /></div><div><br /></div><div>Regards<br /></div><div>Rebecca</div><div><br /></div></div><br /></div>",
  "FOLDERNAME": "Inbox"
}
```

## Get Mail Details by Message ID

### Description
Retrieves the details of a specific email using its unique message ID.

### Method
GET

### Endpoint
clientsdk.get(["mailInfo", "msgId"])

### Parameters
#### Query Parameters
- **messageID** (Integer) - Required - The unique identifier used for the email.

### Request Example
```javascript
clientsdk.get(["mailInfo", "msgId"], { messageID: 12345 }).then(function(mailObj){console.log(mailObj);});
```

### Response
#### Success Response (200)
Returns an object containing the details of the specified email.

#### Response Example
```json
{
  "FROM": "rebecca@zylker.com", 
  "TO": ""Paula M"<paula@zylker.com>",
  "CC": "",
  "BCC":" ",
  "ACCOUNT_ID": "5164940000000008001",
  "MSGID": "3881227000005765001",
  "SUBJECT": "Website Design",
  "SM": "<p>Attached design ideas</p>",
  "NEWATTR": "[ {\"st\": 0, \"attType\": 1, \"e\": \"157742754265103002\", \"part\": \"1\", \"fn\": \"Sample_Name.PDF\", \"l\": [], \"fmt\": \"pdf\", \"fs\": \"1443832\", \"ft\": 102, \"et\": 1, \"p\": \"1\", \"inline\": false, \"size\": \"1443892\", \"u\": \"c6f059b0-2870-11ea-aea7-0cc47a81d49e\", \"appId\": \"0\", \"name\": \"Sample_Name.PDF\", \"tn\": false, \"Id\": \"137967203327290000\", \"id\": \"137967203327290000\", \"shT\": 0, \"gId\": \"688974046\", \"groupId\": \"688974046\", \"entityId\": \"1577427542651030001\", \"entityType\": 1, \"attachId\": \"137967203427290000\"}]",
  "CONTENT":"<meta /><div><div style=\"font-size: 12pt; font-family: Georgia, Times New Roman, Times, serif\"><div>Hi Paula,<br /></div><div><br /></div><div>This is in continuation to our discussion about the upcoming website design.<br /></div><div><br /></div><div>I have attached with this email some design ideas that my team has come up with.<br /></div><div><br /></div><div><br /></div><div><br /></div><div>Regards<br /></div><div>Rebecca</div><div><br /></div></div><br /></div>",
  "FOLDERNAME": "Inbox"
}
```
```

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

### Sample Response for Get All Tasks

Source: https://www.zoho.com/mail/help/api/get-tasks-with-given-status.html

This JSON response structure details a successfully retrieved task, including its owner, project, status, and other relevant information. It also includes pagination details for further retrieval.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/groups/53658048?from=1&limit=1&status=inprogress"
    },
    "tasks": [
      {
        "owner": {
          "name": "Rebecca",
          "id": 53608806
        },
        "numberOfSubtasks": 0,
        "modifiedTime": "2018-10-30T15:14:10+05:30",
        "attachments": [],
        "subtasks": [],
        "description": "",
        "project": {
          "name": "General",
          "id": "17461000000006001"
        },
        "title": "Blog Updates",
        "priority": "Normal",
        "tags": [],
        "createdAt": "2018-10-30T15:14:10+05:30",
        "followers": [],
        "namespaceId": "53658048",
        "id": "17461000000053006",
        "assignee": "Justin Case",
        "status": "In Progress"
      }
    ]
  }
}
```

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

### Get All Groups Request

Source: https://www.zoho.com/mail/help/api/get-all-groups.html

Use this cURL command to make a GET request to retrieve all group details. Ensure you include the Authorization header with a valid Zoho OAuth token.

```curl
curl "https://mail.zoho.com/api/notes/groups" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
```

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

### Edit Personal Task Custom Status - PUT Request

Source: https://www.zoho.com/mail/help/api/edit-custom-status-of-task.html

This cURL example demonstrates how to modify the custom status for a personal task. Remember to substitute the example values with your specific task details and authentication token.

```curl
curl "https://mail.zoho.com/api/tasks/me/customStatus" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken **************" \
-d '{
 "statusName": “Under Testing",
 "statusColour": “#2E8BD3“,
 "status":12
}'
```

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

### Sample Response for Allowed IPs

Source: https://www.zoho.com/mail/help/api/add-allowed-ips-api.html

The API returns a status code and the details of the successfully added IP configuration.

```json
{
  "status":{
     "code":200,
     "description":"success"
  },
  "data":{
     "allowedIps":[
        {
           "ip":[
              {
                 "isipinRange":"true",
                 "user":[
                    {
                       "ipid":987654321,
                       "toip":"255.255.255.255",
                       "fromip":"0.0.0.0"
                    }
                 ]
              }
           ]
        }
     ],
     "failedList":[
        {
        }
     ]
  }
}
```

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

### Get DKIM Fail Option Request

Source: https://www.zoho.com/mail/help/api/get-dkim-fail-option.html

Use this cURL command to make a GET request to retrieve the DKIM fail option for your organization. Ensure you replace '1234567890' with your actual zoid and provide a valid authorization token.

```curl
Copiedcurl "https://mail.zoho.com/api/organization/1234567890/antispam/options?mode=getDKIMFailOption" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Zoho-oauthtoken **************"
```

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

### Fetch All Domains Response

Source: https://www.zoho.com/mail/help/api/get-all-domains.html

Example JSON response containing domain verification details, DKIM status, and hosting information.

```json
{
   "status": {
       "code": 200,
       "description": "success"
   },
   "data": {
       "domainVO": [
           {
               "lastName": "T",
               "isDomainAlias": false,
               "mxstatus": "expired",
               "verificationStatus": true,
               "dkimstatus": false,
               "zoid": 1234567890,
               "catchAllExcludeAddresses": [],
               "verifiedBy": 699104950,
               "URI": "https://mail.zoho.com/api/organization/699103332/domains/zylkerbiz.com",
               "domainId": "1082700000213855787",
               "verifiedByAddress": "test@zylkerbiz.com",
               "firstName": "test",
               "spfstatus": false,
               "subDomainStripping": 0,
               "HTMLVerificationCode": "94873515",
               "verifiedDate": 1619586519236,
               "dkimDetailList": [
                   {
                       "isDefault": false,
                       "isVerified": false,
                       "selector": "zmail",
                       "publicKey": "v=DKIM1; k=rsa; p=MWGfMA0GCUpGNIb3DQEBAQUAA4GNADCBiQKBgQCNTHXgi6v4fGVy6y6Z2KjLVuM0T7TEWTHgjGxVQWdlLvMgmIPxEBEXZchCm4KHpYiAdflcPRQy1cYW676JRJaoIZw3szGkSOkJsxhdiwwTYBBTGM478WFJ2bZYN2wMBT9jOF1oj5qeiCHszHbsHLcSEiFlPJD65eA/yZqMZdDv2QIDAQAB",
                       "hashType": "sha256",
                       "domainId": "1082700000213850787",
                       "dkimId": "1082700000213855089"
                   }
               ],
               "domainName": "zylkernew.com",
               "mailHostingEnabled": true,
               "createdTime": 1619586448940,
               "CNAMEVerificationCode": "zb94873515",
               "isExpired": true,
               "isRegisteredByZoho": false,
               "primary": false
           }
       ]
   }
}
```

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

### Create a New Notebook via cURL

Source: https://www.zoho.com/mail/help/api/post-create-book.html

Use these requests to create a notebook in either a group or personal context. Ensure the Authorization header includes a valid OAuth token.

```bash
curl "https://mail.zoho.com/api/notes/groups/1726251/books" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "bookName": "zylker"
 }'
```

```bash
curl "https://mail.zoho.com/api/notes/me/books" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "bookName": "zylker"
 }'
```

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

### Get User Storage Details Response

Source: https://www.zoho.com/mail/help/api/get-user-subs.html

This is a sample JSON response for the GET User Storage Details API. It includes details about total storage, mailbox status, basic storage type, extra storage, and used storage.

```json
{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": {
        "totalStorage": 65,
        "mailBox": true,
        "basicStorage": "mailPremium",
        "extraStorage": {
            "5 gb": 3
        },
        "usedStorage": 1389,
        "zuid": 73348674
    }
}
```

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

### Sample Response for Get All Folders

Source: https://www.zoho.com/mail/help/api/get-all-folder-details.html

This is a sample JSON response when successfully retrieving all folders from a Zoho Mail account. It includes details for each folder such as its path, name, ID, and type.

```json
Copied{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": [
        {
            "path": "/Inbox",
            "isArchived": 1,
            "folderName": "Inbox",
            "imapAccess": true,
            "folderType": "Inbox",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008014",
            "folderId": "2560636000000008014"
        },
        {
            "path": "/Drafts",
            "previousFolderId": "2560636000000008014",
            "isArchived": 0,
            "folderName": "Drafts",
            "imapAccess": true,
            "folderType": "Drafts",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008016",
            "folderId": "2560636000000008016"
        },
        {
            "path": "/Templates",
            "previousFolderId": "2560636000000008016",
            "isArchived": 0,
            "folderName": "Templates",
            "imapAccess": true,
            "folderType": "Templates",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008018",
            "folderId": "2560636000000008018"
        },
        {
            "path": "/Snoozed",
            "previousFolderId": "2560636000000008018",
            "isArchived": 0,
            "folderName": "Snoozed",
            "imapAccess": true,
            "folderType": "Snoozed",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008020",
            "folderId": "2560636000000008020"
        },
        {
            "path": "/Sent",
            "previousFolderId": "2560636000000008020",
            "isArchived": 0,
            "folderName": "Sent",
            "imapAccess": true,
            "folderType": "Sent",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008022",
            "folderId": "2560636000000008022"
        },
        {
            "path": "/Spam",
            "previousFolderId": "2560636000000008022",
            "isArchived": 0,
            "folderName": "Spam",
            "imapAccess": true,
            "folderType": "Spam",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008024",
            "folderId": "2560636000000008024"
        },
        {
            "path": "/Trash",
            "previousFolderId": "2560636000000008024",
            "isArchived": 0,
            "folderName": "Trash",
            "imapAccess": true,
            "folderType": "Trash",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008026",
            "folderId": "2560636000000008026"
        },
        {
            "path": "/Outbox",
            "previousFolderId": "2560636000000008026",
            "isArchived": 0,
            "folderName": "Outbox",
            "imapAccess": true,
            "folderType": "Outbox",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000008028",
            "folderId": "2560636000000008028"
        },
        {
            "path": "/test",
            "previousFolderId": "2560636000000075007",
            "isArchived": 0,
            "folderName": "test",
            "imapAccess": true,
            "folderType": "Inbox",
            "URI": "https://mail.zoho.com/api/accounts/2560636000000008002/folders/2560636000000013018",
            "folderId": "2560636000000013018"
        }
    ]
}
```

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

### GET /api/accounts

Source: https://www.zoho.com/mail/help/api/get-all-users-accounts.html

Retrieves all account details for the authenticated user.

```APIDOC
## GET /api/accounts

### Description
This API is used to retrieve all the account details of the authenticated user.

### Method
GET

### Endpoint
https://mail.zoho.com/api/accounts

### OAuth Scope
- ZohoMail.accounts.ALL (Grants full access to accounts)
- ZohoMail.accounts.READ (Grants access to read account information)

### Request Example
curl "https://mail.zoho.com/api/accounts" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"
```

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

### GET /api/notes/sharedtome

Source: https://www.zoho.com/mail/help/api/get-all-shared-notes.html

Retrieves the details of all notes shared with the user.

```APIDOC
## GET /api/notes/sharedtome

### Description
This API is used to retrieve the details of all the shared notes.

### Method
GET

### Endpoint
https://mail.zoho.com/api/notes/sharedtome

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of note details to retrieve (title, content, color, bookId, bookName).
- **after** (int) - Optional - Specifies from which index retrieval should start (1 to Number of Notes).
- **limit** (int) - Optional - Number of notes to retrieve (1 to 399, default: 25).
- **isPrev** (boolean) - Optional - Sort order based on created time (true: ascending, false: descending, default: false).

### Request Example
curl "https://mail.zoho.com/api/notes/sharedtome?limit=2" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

### Response
#### Success Response (200)
- **status** (object) - Contains code and description.
- **data** (object) - Contains pagination info and the list of notes.

#### Response Example
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "pagination": {
      "next": "https://mail.zoho.com/api/notes/sharedtome?after=2&limit=2"
    },
    "list": [
      {
        "modifiedTime": "1712041255079",
        "color": "-1",
        "namespaceId": "84626808",
        "entityId": "1712041255679110001",
        "title": "Title",
        "colorHex": "#c6f5f9",
        "bookName": "General",
        "content": "test",
        "isFavorite": "true",
        "bookId": "3764869000000005003"
      }
    ]
  }
}
```

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

### Enable User

Source: https://www.zoho.com/mail/help/api/put-to-enable-user.html

Enables a user account and optionally unblocks incoming emails.

```APIDOC
## PUT /api/organization/{zoid}/accounts/{accountId}

### Description
This API is used to enable a user account within the Zoho Mail organization.

### Method
PUT

### Endpoint
https://mail.zoho.com/api/organization/{zoid}/accounts/{accountId}

### Parameters
#### Path Parameters
- **zoid** (long) - Required - The unique Zoho Organization Identifier for the organization.
- **accountId** (long) - Required - The identifier for the user account to be enabled.

#### Request Body
- **zuid** (long) - Required - The unique identifier for each user in an organization.
- **mode** (string) - Required - The type of operation to be performed. Provide the value as "enableUser".
- **unblockIncoming** (boolean) - Optional - Specifies whether to unblock incoming emails for the user. Allowed values: true, false.

### Request Example
```json
{
  "mode": "enableUser",
  "unblockIncoming": true,
  "zuid": 11111111
}
```

### Response
#### Success Response (200)
- **status** (object) - Contains the status code and description of the response.
  - **code** (integer) - The HTTP status code.
  - **description** (string) - A description of the status.

#### Response Example
```json
{
  "status": {
    "code": 200,
    "description": "success"
  }
}
```
```

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

### GET /api/links/groups/collections

Source: https://www.zoho.com/mail/help/api/get-all-group-collections-api.html

Retrieves a list of all collections organized by groups.

```APIDOC
## GET /api/links/groups/collections

### Description
This API is used to retrieve all collections in groups.

### Method
GET

### Endpoint
https://mail.zoho.com/api/links/groups/collections

### Request Example
curl "https://mail.zoho.com/api/links/groups/collections" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

### Response
#### Success Response (200)
- **status** (object) - Contains code and description
- **data** (array) - List of groups containing collection details

#### Response Example
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "groupId": "84626808",
      "name": "test",
      "collection": [
        {
          "collectionId": "3764869000000009001",
          "collectionName": "test1"
        }
      ]
    }
  ]
}
```

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

### GET /api/links/me/collections

Source: https://www.zoho.com/mail/help/api/get-all-collections.html

Retrieves all personal collections for the authenticated user.

```APIDOC
## GET /api/links/me/collections

### Description
Retrieves all personal collections of the user.

### Method
GET

### Endpoint
https://mail.zoho.com/api/links/me/collections

### Request Example
curl "https://mail.zoho.com/api/links/me/collections" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

### Response
#### Success Response (200)
- **status** (object) - Status code and description
- **data** (array) - List of collection objects containing collectionId and collectionName

#### Response Example
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "collectionId": "3764869000000006003",
      "collectionName": "General"
    }
  ]
}
```