PUT - Change ActiveSync Status for a User
Purpose
The API is used to change the ActiveSync status of a user from enabled to disabled or vice-versa.
OAuth Scope
Use the scope
ZohoMail.organization.accounts.ALL (or)
ZohoMail.organization.accounts.UPDATE
to generate the Authtoken.
ALL - Grants full access to accounts.
UPDATE - Grants access to update account information.
Request URL
Method: PUT
Using admin authentication:
https://mail.zoho.com/api/organization/{zoid}/accounts/{accountId}
Path Parameters
- zoid* long
- This parameter denotes the unique Zoho Organization Identifier for the organization.
- This value can be retrieved using the GET organization details API.
- accountId* long
- This parameter is the identifier for the user account whose ActiveSync status is updated.
- This parameter can be retrieved from the GET all org user details API.
Request Body (JSON Object)
- zuid* long
- This parameter denotes the unique identifier for each user in an organization.
- This value can be retrieved using the GET all org user details API.
- mode* string
- This parameter represents the type of operation that is to be performed.
- Provide the value as updateMobileSyncStatus.
- activeSyncEnabled* boolean
- This parameter specifies whether to enable or disable ActiveSync for this mail account.
- Allowed values:
- true - Enable ActiveSync status of the user.
- false - Disable ActiveSync status of the user.
* - Mandatory parameter
Response Codes
Refer here for the response codes and their meaning.
Sample Request
Copied
Sample Response
Copied