Get scope enhancement token

Get a scope enhancement token from our authorization server. You will need to send a refresh token to which the additional scopes are to be appended.

Endpoint

CopiedPOST 	{accounts-server-url}/oauth/v2/token/scopeenhance

Note: The accounts-server-url is specific to the location (i.e., datacenter) where your app is registered.  

Query parameters

ParameterDescription
client_id

required

The unique ID of your application. You can find this in the API console.

client_secret

required

The unique secret for your app which is known only to your app and Zoho. You can find this is the API console.

grant_type

required

Should be sent with the value update_scopes_token.

refresh_token

required

The refresh token to which the additional scopes are to be appended.

Request example

Copiedhttps://accounts.zoho.in/oauth/v2/token/scopeenhance
?grant_type=update_scopes_token
&client_id=1000.HRLOVZ0U6LSAZ14OQHYZYTZBTL3SGR
&client_secret=fa10d952be6bd6654cbb6b5fe271042de9546541e781
&refresh_token=1000.0d50a4d6a383005cc1f899968b9f9d97.2183743f8798bea2f71e193e34e37ef0d

Response parameters

ParameterDescription
access_tokenThe scope enhancement token that can be used to append additional scopes to a refresh token.
token_typeIndicates the type of token that is generated.
expires_inIndicates the time (seconds) in which the scope enhancement token expires.

Response example

Copied{
"access_token": "1000.f95a0db717f52b825e3f94654f651.ced2cf4e786cf04c0e91daee545jh51cd",
"token_type": "update_scope",
"expires_in": 600
}

Error codes

ErrorReasons
invalid_client
  • The accounts-server URL is invalid. Check if the URL is corresponding to the user's datacenter location. See all URLs
  • The parameter client_id is missing or its value is invalid. 
  • The value of the parameter grant_type is invalid. It must be update_scopes_token.
  • The parameter "grant_type" is missing.
invalid_client_secret
  • The parameter client_secret is missing or its value is invalid. 
invalid_code
  • The parameter refresh_token is missing or its value is either invalid or already used.
  • The value of the parameter grant_type is incorrect. It must be update_scopes_token.
400 Bad request
  • The HTTP method used is incorrect. It must be POST.