Organization API
Partner API
The Partner APIs can be used by the Partners with Partner Admin role to add organizations, mapped to them to manage the particular organizations, subscription details and so on
| Method Name | URL | Method Type | OAuth Scope | Purpose |
| Add Child Organization | /api/organization/ | POST | partner.organization | Add an organization in Zoho Mail, under a partner account to be managed by the partner. |
Organization Details API
The Organization APIs help you to get information about the particular organization, subscription details, number of users, number of groups, list of domains etc.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
| Organization Details | /api/organization/ or /api/organization/<zoid> | GET | partner.organization | Get the basic details of the organization along with the number of users and groups. |
Subscription Details API
The Subscription APIs help you to get information about the organization's Pricing Plans, users storage details and also update/ allocate storage details for the user based on the organization subscription information.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
/api/organization/<zoid>/storage | GET | organization.subscriptions | Get organizations plan details, add ons and summary of the used and available storage information. | |
| User Storage | /api/organization/<zoid>/storage/<zuid> | GET | Get the base plan, extra storage, allotted and used storage details of a particular user. | |
| Update User Storage | /api/organization/<zoid>/storage/<zuid> | PUT | Modify the base storage/ addon storage for a particular user. |
Organization Anti-Spam APIs
The Organization Subscription APIs help you to get information about the organization's Pricing Plan and the details of the Plans available.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
| Organization Spam Process Type | /api/organization/<zoid> | GET | partner.organization | To get the Organization Spam Settings use the Organization Details API specifying the appropriate field name. |
| Update Spam Process Type | /api/organization/<zoid>/spamInfo | PUT | partner.organization | Modify the Spam Process Type of the organization, to enable or disable the Spam Processing. |
| Get Organization Spam Listing | /api/organization/<zoid>/addSpamInfo | GET | organization.spam | Get the details of Spam Listing (Whitelist/ Blacklist Domains and Email addresses) for the organization. |
| Add Organization Spam Listing | /api/organization/<zoid>/addSpamInfo | PUT | partner.organization | To add whitelist/ blacklist domains and email addresses to the organization spam lists. |
| Remove Organization Spam Listing | /api/organization/<zoid>/addSpamInfo | PUT | partner.organization | To remove whitelist/ blacklist domains and email addresses from the organization spam lists. |
Allowed IPs API
The Allowed IPs APIs help you to whitelist/ add allowed IPs, assign them to the members of your organization, fetch the allowed IPs list and delete them.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
/api/organization/<zoid>/allowedIps | CREATE | organization.accounts | To add allowed IPs range and assign them to the members of the organization based on their roles. | |
| Get Allowed IPs list | /api/organization/<zoid>/allowedIps | GET | Fetch the list of allowed IPs range, to whom they're assigned, and the ipId of the IP range. | |
| Delete Allowed IPs | /api/organization/<zoid>/allowedIps | DELETE | Delete a range of Allowed IPs with the help of the ipId. |