Zoho Mail API

https://www.zoho.com/mail/help/api/
Admin
Zoho Mail API is a comprehensive REST API platform that enables developers to programmatically...
Tokens:404,791
Snippets:2,845
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get contact details by email address (example)

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

Example call using a specific email address 'paula@zylker.com' to retrieve contact details.

```javascript
clientsdk.get(["contactInfo", {eid: "paula@zylker.com"}]).then(res=>{ console.log(res) })
```

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

### Sample Response - Get Tasks in Project with Status

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

Example JSON response showing a successful retrieval of tasks. The response includes paging information and task details such as owner, title, priority, status, and project information.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "paging": {
      "nextPage": "/api/tasks/groups/53658048/projects/17461000000006001?from=1&limit=1&status=2"
    },
    "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": "Paula M",
        "status": "In Progress"
      }
    ]
  }
}
```

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

### Sample Response - Get All Favorite Bookmarks

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

Example success response for the Get All Favorite Bookmarks API. Shows the pagination next link and a list of favorite bookmarks with details such as title, link, collectionName, and linkMetaInfo.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "pagination": {
      "next": "https://mail.zoho.com/api/links/favorites?&after=2&limit=2"
    },
    "list": [
      {
        "summary": "https://mail.zoho.com",
        "namespaceId": "84626808",
        "link": "https://mail.zoho.com",
        "entityId": "1712123191509110002",
        "title": "https://mail.zoho.com",
        "collectionId": "3764869000000009001",
        "linkMetaInfo": {
          "linkTitle": "https://mail.zoho.com",
          "linkDescription": "https://mail.zoho.com"
        },
        "collectionName": "cat1",
        "isFavorite": "true",
        "tags": []
      },
      {
        "summary": "Link Description",
        "namespaceId": "84626808",
        "link": "https://www.zoho.com",
        "entityId": "1712055358708110001",
        "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-india-3.png"
        },
        "collectionName": "General",
        "isFavorite": "true",
        "tags": []
      }
    ]
  }
}
```

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

### Sample Request - Get Tasks in Project with Status

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

Use this curl command to retrieve tasks with a specified status. The example uses limit=1, from=1, and status=inprogress. Replace the zgid, projectId, and authorization token with your own values.

```bash
curl "https://mail.zoho.com/api/tasks/groups/53658048/projects/1746******8006001?limit=1&from=1&status=inprogress" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"
```

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

### Sample Response: JSON account details

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

Example JSON response from the Get User Account Details API, showing account attributes such as email address, storage, and send mail details.

```json
{
   "status": {
       "code": 200,
       "description": "success"
   },
   "data": {
       "country": "us",
       "lastLogin": 1708054510447,
       "mxStatus": true,
       "activeSyncEnabled": false,
       "mobileNumber": "",
       "incomingBlocked": false,
       "language": "en",
       "type": "ZOHO_ACCOUNT",
       "extraStorage": {},
       "incomingUserName": "rebecca@zylker.com",
       "emailAddress": [
           {
               "isAlias": false,
               "isPrimary": true,
               "mailId": "rebecca@zylker.com",
               "isConfirmed": true
           }
       ],
       "mailboxStatus": "enabled",
       "popBlocked": false,
       "usedStorage": 143295,
       "spamcheckEnabled": true,
       "imapAccessEnabled": true,
       "timeZone": "America/Los_Angeles",
       "accountCreationTime": 1682488069407,
       "zuid": 809451734,
       "webBlocked": false,
       "planStorage": 100,
       "firstName": "rebecca",
       "accountId": "2560636000000008002",
       "sequence": 1,
       "mailboxAddress": "rebecca@zylker.com",
       "lastPasswordReset": 1682488070541,
       "tfaEnabled": false,
       "phoneNumer": "",
       "status": true,
       "lastName": "training",
       "accountDisplayName": "rebecca_training",
       "role": "member",
       "gender": "NOT_SPECIFIED",
       "accountName": "zylker",
       "displayName": "rebecca training",
       "isLogoExist": false,
       "URI": "https://mail.zoho.com/api/accounts/2560636000000008002",
       "primaryEmailAddress": "rebecca@zylker.com",
       "enabled": true,
       "mailboxCreationTime": 1682488072077,
       "basicStorage": "professional",
       "lastClient": "WEB_ZM",
       "allowedStorage": 104857600,
       "sendMailDetails": [
           {
               "sendMailId": "2560636000000008004",
               "displayName": "rebecca training",
               "serverName": "smtpout.mail.zoho.com",
               "signatureId": "null",
               "serverPort": 25,
               "userName": "rebecca@zylker.com",
               "connectionType": "plain",
               "mode": "mailbox",
               "validated": false,
               "fromAddress": "rebecca@zylker.com",
               "smtpConnection": 0,
               "validationRequired": true,
               "validationState": 0,
               "status": true
           },
           {
               "sendMailId": "2560636000000082001",
               "verifyCode": 200193088841352729,
               "displayName": "rebeccatraining",
               "serverName": "smtpout.mail.zoho.com",
               "signatureId": "null",
               "serverPort": 25,
               "userName": "rebecca@zylker.com",
               "connectionType": "plain",
               "mode": "extfrom",
               "validated": false,
               "fromAddress": "rebecca@zylkertraining.com",
               "smtpConnection": 0,
               "validationRequired": true,
               "validationState": 0,
               "status": false
           },
           {
               "sendMailId": "2560636000000143001",
               "verifyCode": 5686021185181369376,
               "displayName": "ckrbjr nb",
               "serverName": "smtpout.mail.zoho.com",
               "signatureId": "null",
               "serverPort": 25,
               "userName": "rebecca@zylker.com",
               "connectionType": "plain",
               "mode": "extfrom",
               "validated": false,
               "fromAddress": "p3487260@gmail.com",
               "smtpConnection": 0,
               "validationRequired": true,
               "validationState": 0,
               "status": false
           }
       ],
       "popFetchTime": -1,
       "address": {
           "country": "",
           "streetAddr": "",
           "city": "",
           "postalCode": "",
           "state": ""
       },
       "planType": 82,
       "userExpiry": -1,
       "popAccessEnabled": true,
       "imapBlocked": false,
       "iamUserRole": "member",
       "outgoingBlocked": false,
       "policyId": {
           "1082700000003462021": "home POLICY1.",
           "zoid": 3226386
       },
       "smtpStatus": true,
       "extraEDiscoveryStorage": {}
   }
}
```

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

### Sample Request using zuid - cURL

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

Example curl command to retrieve user details for a specific organization using the zuid path parameter. Uses GET method with Accept, Content-Type, and Authorization headers.

```bash
curl "https://mail.zoho.com/api/organization/1234567890/accounts/123456789" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Zoho-oauthtoken ********"
```

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

### Get contact details by ZUID (example)

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

Example call using a specific ZUID '647310909' to retrieve contact details.

```javascript
clientsdk.get(["contactInfo", {zuid: "647310909"}]).then(res=>{ console.log(res) })
```

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

### Sample Response: Create Folder

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

Response with status 201 Created and data containing the new folder details such as path, folderId, and URI.

```json
{
    "status": {
        "code": 201,
        "description": "Created"
    },
    "data": {
        "path": "/new",
        "previousFolderId": "2560636000000076001",
        "isArchived": 0,
        "folderName": "new",
        "imapAccess": true,
        "folderType": "Inbox",
        "URI": "https://mail.zoho.com/api/accounts/N****C0CM/folders/2560636000000076007",
        "folderId": "2560636000000076007"
    }
}
```

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

### Sample Response: Folder details

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

Example JSON response showing folder metadata including path, folder name, folder type, and access flags.

```json
{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": {
        "path": "/again",
        "previousFolderId": "2560636000000008028",
        "isArchived": 0,
        "folderName": "again",
        "imapAccess": true,
        "folderType": "Inbox",
        "URI": "https://mail.zoho.com/api/accounts/25606360000****8002/folders/2560636000000075001",
        "folderId": "2560636000000075001"
    }
}
```

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

### Sample Success Response

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

Example JSON response when the request succeeds. Contains a list of books under 'projects' and optionally highlights the default book under 'defaultProject' when the defaultProject query parameter is true.

```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"
    }
  }
}
```

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

### Sample Request - Get All Forward Restrictions

Source: https://www.zoho.com/mail/help/api/get-forward-restrictions.html

Curl command to retrieve forward restrictions. Uses GET method with query parameters limit and start. Requires Authorization header with Zoho-oauthtoken.

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

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

### Sample Failure Response - Get All Favorite Bookmarks

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

Example failure response for the Get All Favorite Bookmarks API. Returns a 500 status with description 'Internal Error' and moreInfo 'Invalid Input'.

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

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

### Sample Response: Task List JSON

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

Example success response containing paging information and one task object with fields like owner, subtasks, attachments, dueDate, description, project, title, priority, status, and assignee. The response matches the sample request output.

```json
{
  "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"
      }
    ]
  }
}
```

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

### Sample Response (raw = true)

Source: https://www.zoho.com/mail/help/api/get-email-header.html

Shows the response when the 'raw' query parameter is set to true. The header content is returned as a single string with raw header lines.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "headerContent": "Received: from mail.zoho.com by zohomail.com.in\r\n\twith SMTP id 1710915503001464.8172454726922; Wed, 20 Mar 2024 11:48:22 +0530 (IST)\r\nDate: Wed, 20 Mar 2024 11:48:06 +0530\r\nFrom: Rebecca <Rebecca@zylker.com>\r\nTo: \"Paula\" <Paula@zylker.com>\r\nMessage-Id: <18e5a828422.b64e1ac10.3955673754999231544@140.com>\r\nSubject: Hello\r\nMIME-Version: 1.0\r\nContent-Type: multipart/mixed; \r\n\tboundary=\"----=_Part_324_1916164368.1710828056044\"\r\nImportance: Medium\r\nUser-Agent: Zoho Mail\r\nX-Mailer: Zoho Mail\r\nX-Zoho-Virus-Status: 1\r\nX-Zoho-Virus-Status: 1\r\n",
    "messageId": 1710915488416100000
  }
}
```

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

### Sample response for get all labels

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

Example JSON response from the get all labels endpoint, showing a success status and an array of label objects with fields like sequence, labelId, color, tagId, displayName, and URI.

```json
{
"status": {
"code": 200,
"description": "success"
},
"data": [
{
"sequence": 1,
"labelId": "2674552000000009027",
"color": "#96ccf5",
"tagId": "2674552000000009027",
"displayName": "testing",
"URI": "https://mail.zoho.com/api/accounts/12345678/labels/2674552000000009027"
},
{
"sequence": 2,
"labelId": "2674552000000009029",
"color": "#96ccf5",
"tagId": "2674552000000009029",
"displayName": "hello",
"URI": "https://mail.zoho.com/api/accounts/12345678/labels/2674552000000009029"
}
]
}
```

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

### Sample Request - For Personal

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

GET request to retrieve personal bookmarks. Uses the /me endpoint and the limit query parameter. Requires the ZohoMail.links.ALL or ZohoMail.links.READ scope.

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

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

### Get all folders - Sample response

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

Example JSON response for the Get all folders request. It includes a status object with code 200 and success description, and a data array containing folder objects with properties such as path, folderName, folderType, imapAccess, URI, and folderId.

```json
{
    "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"
        }
    ]
}
```

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

### Sample Success Response

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

Example of a successful response with HTTP 200 status, containing bookmark details such as summary, link, title, and metadata.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "summary": "https://mail.zoho.com",
    "namespaceId": "84626808",
    "link": "https://mail.zoho.com",
    "entityId": "1712123191509110002",
    "title": "https://mail.zoho.com",
    "collectionId": "3764869000000009001",
    "linkMetaInfo": {
      "linkTitle": "https://mail.zoho.com",
      "linkDescription": "https://mail.zoho.com"
    },
    "collectionName": "category1",
    "isFavorite": "false",
    "tags": []
  }
}
```

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

### GET Account Restrictions with curl

Source: https://www.zoho.com/mail/help/api/get-account-restrictions.html

Use this GET request to retrieve all account restrictions for an organization. The URL includes the organization ID (zoid) and query parameters limit and start. The Authorization header must contain a valid Zoho OAuth token with the required scope.

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

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

### Sample Request - Enable User

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

Curl command to enable a user account. Uses PUT method with the required headers and a JSON body containing mode, unblockIncoming, and zuid.

```bash
curl "https://mail.zoho.com/api/organization/1234567890/accounts/111111111000" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Zoho-oauthtoken ***************" \
-d '{
  "mode": "enableUser",
  "unblockIncoming": "true",
  "zuid": "11111111"
}'
```

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

### GET All Email Restrictions - curl Request

Source: https://www.zoho.com/mail/help/api/get-email-restrictions.html

Use this GET request to retrieve all email restrictions for an organization. The URL includes the organization ID (zoid) and optional query parameters limit and start. The Authorization header must contain a valid OAuth token with the required scope.

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

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

### GET /api/organization/{zoid}/policy/mailRestriction

Source: https://www.zoho.com/mail/help/api/get-email-restrictions.html

Retrieves all email restrictions for the specified organization. Use the start and limit query parameters to paginate through results, and searchKey to filter restrictions.

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

### Description
Retrieves details of all the email restrictions created for the organization.

### Method
GET

### Endpoint
https://mail.zoho.com/api/organization/{zoid}/policy/mailRestriction

### Parameters
#### Path Parameters
- **zoid** (long) - Required - Unique Zoho Organization Identifier for the organization. Can be retrieved from the Get Organization Details API.

#### Query Parameters
- **start** (int) - Optional - Start sequence number of restrictions to be retrieved. Default value is 0.
- **limit** (int) - Optional - Number of restrictions to be retrieved from the start value. Default value is 10.
- **searchKey** (string) - Optional - Particular data to search for.

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

### Response
#### Success Response (200)
- **status** (object) - Contains response code and description.
- **data** (array) - List of email restriction objects.
  - **incomingDomainRestrictionStatus** (string) - Status of incoming domain restriction.
  - **incomingAttachmentRestrictionStatus** (string) - Status of incoming attachment restriction.
  - **restrictionName** (string) - Name of the restriction.
  - **policyCount** (string) - Number of policies associated.
  - **incomingEmailRestrictionStatus** (string) - Status of incoming email restriction.
  - **outgoingSubjectRestrictionStatus** (string) - Status of outgoing subject restriction.
  - **incomingSubjectRestrictionStatus** (string) - Status of incoming subject restriction.
  - **outgoingDomainRestrictionStatus** (string) - Status of outgoing domain restriction.
  - **outgoingAttachmentRestrictionStatus** (string) - Status of outgoing attachment restriction.
  - **restrictionID** (string) - Unique identifier for the restriction.
  - **zoid** (long) - Organization identifier.
  - **outgoingEmailRestrictionStatus** (string) - Status of outgoing email restriction.

#### Response Example
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "incomingDomainRestrictionStatus": "noRestriction",
      "incomingAttachmentRestrictionStatus": "noRestriction",
      "restrictionName": "noRestriction",
      "policyCount": "1",
      "incomingEmailRestrictionStatus": "noRestriction",
      "outgoingSubjectRestrictionStatus": "noRestriction",
      "incomingSubjectRestrictionStatus": "noRestriction",
      "outgoingDomainRestrictionStatus": "noRestriction",
      "outgoingAttachmentRestrictionStatus": "noRestriction",
      "restrictionID": "1003505000077177286",
      "zoid": 12345678,
      "outgoingEmailRestrictionStatus": "noRestriction"
    },
    {
      "incomingDomainRestrictionStatus": "restrictedDomain",
      "incomingAttachmentRestrictionStatus": "noRestriction",
      "restrictionName": "Copy All Policy",
      "policyCount": "1",
      "incomingEmailRestrictionStatus": "noRestriction",
      "outgoingSubjectRestrictionStatus": "noRestriction",
      "incomingSubjectRestrictionStatus": "noRestriction",
      "outgoingDomainRestrictionStatus": "noRestriction",
      "outgoingAttachmentRestrictionStatus": "noRestriction",
      "restrictionID": "1003505000077337001",
      "zoid": 12345678,
      "outgoingEmailRestrictionStatus": "noRestriction"
    }
  ]
}
```

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

### Sample Success Response

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

This is the success response returned when a bookmark is created. It includes the entityId and the URI of the newly created bookmark.

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

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

### Initialize Zoho Mail SDK and fetch app settings

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

Initializes the Zoho Mail SDK and then fetches the application settings (such as DC, font, language, and night/light modes) configured in the Mail settings. Use these commands in sequence to set up your widget or extension and retrieve the current settings.

```javascript
var clientsdk = SigmaSDK.MAIL.init(function () { });
```

```javascript
clientsdk.get(["appsetting"])
```

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

### GET tasks in a project with curl and sample JSON response

Source: https://www.zoho.com/mail/help/api/get-tasks-in-project.html

Use this GET request to retrieve tasks from a project. The response shows a successful retrieval with status code 200 and includes task details such as owner, title, priority, and status. The example uses limit=1 and from=0 to fetch the first task.

```bash
curl "https://mail.zoho.com/api/tasks/groups/53****48/projects/17461****001?limit=1&from=0" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"
```

```json
{
"status": {
"code": 200,
"description": "success"
},
"data": {
"paging": {
"nextPage": "/api/tasks/groups/53658048/projects/17461000000006001?from=0&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": "Blog Updates",
"priority": "Normal",
"tags": [],
"createdAt": "2018-10-30T15:14:10+05:30",
"followers": [],
"namespaceId": "53658048",
"id": "17461000000053006",
"assignee": Paula M,
"status": "In Progress"
}
]
}
}
```

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

### GET Policy Groups with curl

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

Use this GET request to retrieve policy groups. The URL includes the organization ID (zoid) and policy ID (policyId) as path parameters, with optional query parameters limit and start. The Authorization header must contain a Zoho OAuth token with the required scope.

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

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

### Sample Response - Projects List

Source: https://www.zoho.com/mail/help/api/get-projects-in-group.html

Example response showing a successful retrieval of projects in a group. The response includes a status object with code 200 and a data object containing an array of projects with their names and IDs.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "projects": [
      {
        "name": "General",
        "id": "17461000000006001"
      },
      {
        "name": "Marketing",
        "id": "17461000000006006"
      },
      {
        "name": "Blogging",
        "id": "17461000000008001"
      },
      {
        "name": "Sales",
        "id": "17461000000008003"
      }
    ]
  }
}

```

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

### Sample Success Response for Subscription Info

Source: https://www.zoho.com/mail/help/api/get-org-subscription-info.html

This is the sample success response for the subscription info request. It shows the structure of the returned data, including add-ons, feature flags, and the expiryTime as a string in epoch milliseconds.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "currencyType": "INR",
    "autoAllocationPercentage": 100,
    "addOns": [
      {
        "planStorage": 5,
        "PROPVALUE": 291,
        "PLANNAME": "Mail Lite",
        "PROPNAME": 92,
        "planCategory": "MAIL_ONLY",
        "ALLOTEDUSER": 285
      },
      {
        "PROPVALUE": 1000,
        "PROPNAME": 12,
        "ADDONSTORAGE": 10,
        "ALLOTEDUSER": 3,
        "ADDONNAME": "10 gb"
      },
      {
        "PROPVALUE": 1000,
        "PROPNAME": 13,
        "ADDONSTORAGE": 15,
        "ALLOTEDUSER": 4,
        "ADDONNAME": "15 gb"
      }
    ],
    "adminPrivilege": "1",
    "autoAllocation": true,
    "iseDiscoveryStorageEnabled": false,
    "isOfflineSubscription": false,
    "isMixedPlan": false,
    "subscriptionType": 11,
    "isBackupAllowed": false,
    "expiryTime": "1762148966674",
    "isDocAllowed": false,
    "discountType": -1,
    "isRetentionAllowed": false
  }
}
```

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

### Sample Response for Get Email Meta Data

Source: https://www.zoho.com/mail/help/api/get-email-meta-data.html

Example JSON response returned by the API when the request is successful. It contains metadata such as subject, sender, recipient, timestamps, and flags.

```json
{
   "status": {
       "code": 200,
       "description": "success"
   },
   "data": {
       "summary": "Hello Sent using Zoho Mail",
       "sentDateInGMT": "1709856390000",
       "calendarType": 0,
       "subject": "Test",
       "messageId": "1709876190693100009",
       "flagid": "info",
       "status2": "0",
       "priority": "3",
       "hasInline": "false",
       "toAddress": "&quot;autocview_adminuser&quot;&lt;autocview_adminuser@zmaillb.com&gt;",
       "folderId": "9000000002014",
       "ccAddress": "Not Provided",
       "hasAttachment": "0",
       "size": "873",
       "sender": "paula",
       "receivedTime": "1709876190649",
       "fromAddress": "rebecca@zylker.com",
       "status": "1"
   }
}
```

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

### Sample response for params get

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

Shows the structure of the response object with a data array containing paramName and paramValue pairs.

```json
{
   data: { [
                  {
                      "paramName": "userId", 
                      "paramValue": "54367"
                  },
                  {
                      "paramName": "userName", 
                      "paramValue": "Paula"
                   }
             ] }
}
```

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

### Sample Request - For Personal Notes

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

GET request to retrieve all books for personal notes. Uses the /me/books endpoint and the defaultProject query parameter. Requires an OAuth token with ZohoMail.notes.ALL or ZohoMail.notes.READ scope.

```bash
curl "https://mail.zoho.com/api/notes/me/books?defaultProject=true" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"
```

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

### Sample Failure Response - Get Email Attachment Info

Source: https://www.zoho.com/mail/help/api/get-attach-info.html

Example failure response with HTTP status 400. The data object contains a moreInfo field describing the error, here indicating that the provided message id is invalid.

```json
{
  "status": {
    "code": 400,
    "description": "Invalid Input"
  },
  "data": {
    "moreInfo": "Message id 167143473031311477 is invalid"
  }
}
```

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

### Sample Response for GET Organization Subscription Details

Source: https://www.zoho.com/mail/help/api/get-org-subscription.html

Sample response for the GET organization subscription details request. Shows a successful status code 200 with a userList containing storage details for one user.

```json
{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": {
        "userList": [
            {
                "totalStorage": 5,
                "mailBox": true,
                "basicStorage": "free",
                "usedStorage": 0,
                "zuid": 76006481
            }
        ]
    }
}
```

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

### Sample Request - For Groups

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

GET request to retrieve bookmarks from a group. Uses the groupId path parameter and the limit query parameter. Requires the ZohoMail.links.ALL or ZohoMail.links.READ scope.

```bash
curl "https://mail.zoho.com/api/links/groups/84626808?limit=2" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"
```

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

### Sample Request: GET messages for moderation

Source: https://www.zoho.com/mail/help/api/get-moderation-emails.html

Use this curl command to retrieve emails held for moderation. Replace the organization ID, group ID, and OAuth token. The start and limit query parameters control pagination.

```bash
curl "https://mail.zoho.com/api/organization/60000****8002/groups/360000****8002/messages?start=0&limit=25" \
-X GET \
-H "Accept: application/json" \
-H "Authorization:Zoho-oauthtoken ***"
```

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

### Sample Response: Get Policy Users

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

Example JSON response showing a successful retrieval of policy users. The response includes a status object and a data array containing user details such as emailAddress, role, displayName, and zuid.

```json
{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "emailAddress": "rebecca@zylker.com",
      "role": 2,
     "displayName": "rebecca",
      "zuid": 53671954
    },
    {
      "emailAddress": "paula@zylker.com",
      "role": 1,
      "displayName": "testzylker",
      "zuid": 54122735
    }
  ]
}
```
Tokens:
Raw