Users API

User Mail Account Details

The User Details APIs help you to get and update information about the users and their mail accounts in the organization.

Method Name	URL	OAuth Scope	Method Type	Purpose
Add User Account to an Org	/api/organization/{zoid}/accounts	ZohoMail.organization.accounts	POST	Add a user to the organization.
Mail Account Details of All Users	/api/organization/{zoid}/accounts		GET	Get the details of all the users' mail accounts in the organization.
Single User Details	/api/organization/{zoid}/accounts/{zuid}		GET	Get the details of a single user in the organization.
Single User Details	/api/organization/{zoid}/accounts/{emailAddress}		GET	Get the details of a single user in the organization.
Change the Role of a User	/api/organization/{zoid}/accounts		PUT	Change the role of a user as administrator and vice versa.
Reset the Password of a User	/api/organization/{zoid}/accounts/{zuid}		PUT	Reset the password of a user in the organization.
Add an Email Alias to the User Account	/api/organization/{zoid}/accounts/{zuid}		PUT	Add an email alias to a user's mail account.
Remove Email Alias from the User Account	/api/organization/{zoid}/accounts/{zuid}		PUT	Remove an email alias associated with the user account.
Enable the User's Mail Account	Admin Authentication: /api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	Enable the email account of a particular user.
Enable the User's Mail Account	User Authentication: /api/accounts/{accountId}	ZohoMail.accounts	PUT	Enable the email account of a particular user.
Disable the User's Mail Account	Admin Authentication: /api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	Disable the email account of a particular user and prevent login.
Disable the User's Mail Account	User Authentication: /api/accounts/{accountId}	ZohoMail.accounts	PUT
Enable User	/api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	The API can be used by the admin to enable a user account.
Disable User	/api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	The admin can use the API to disable a user account. Upon disabling, the user cannot user's sign in to their account.
Delete User account	/api/organization/{zoid}/accounts	ZohoMail.organization.accounts	DELETE	Delete a user's account.

User Account Access Mode API

The User Account Access Mode APIs help you to enable/ disable the external access modes for the account, like POP/ IMAP and Active Sync for the user. Further, you can enable/ disable Incoming/ Outgoing for the account using the APIs.

Method Name	URL	OAuth Scope	Method Type	Purpose
Change Incoming Status for a User	/api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	To enable/ disable the Incoming status of the email account.
Change Outgoing Status for a User	/api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	To enable/ disable the Outgoing status of the email account.
To change IMAP Status	/api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	To enable/ disable access via IMAP for the particular account.
To change POP Status	/api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	To enable/ disable access via POP for the particular account.
To change Active Sync Status	/api/organization/{zoid}/accounts/{accountId}	ZohoMail.organization.accounts	PUT	To enable/ disable access via Active Sync for the particular account.
To change TFA Preference	/api/organization/{zoid}/accounts/{zuid}	ZohoMail.organization.accounts	PUT	To enable/ disable Two Factor Authentication Setting for the account.