Add a sync account using OAuth
Purpose
This API is used to add a sync account in Mail360 using Oauth flow. Before adding an account via OAuth, connectors must be configured.
OAuth Scope
Use the scope
MailApps.accounts.ALL (or) MailApps.accounts.CREATE
ALL - Full access to the accounts.
CREATE - Add a new account through OAuth.
To generate Authtoken, refer here.
Request URL
Method: POST
https://mail360.zoho.com/api/accounts/oauth
Request Body (JSON object)
- hintEmail* string
- This is the email ID of the account to be added as a sync account.
- displayName string
- This is the short name to be used to identify the account.
- mailProvider* string
- This is the email provider name for which a connector is created.
- rUrl* string
- This is the URL to which redirection needs to be done after authentication.
- gmailTypeSync boolean
- This parameter is applicable for Gmail accounts, determining the type of sync (based on labels).
- The possible value can be
- true - if sync should be based on labels.
- false - if sync should not be based on labels
- syncFromDate string
- This is the timestamp value of the date from which the mail should be synced.
- saveSentCopy integer
- The value of this parameter determines whether to save a copy of sent mail in Mail360 storage or not.
- The possible value can be
- 0 - Do not save sent emails.
- 1 - Save sent emails
* - Mandatory parameter
Sample request
Copied
Sample response
Copied