Home >> Error Codes

Various errors, which may occur on giving incorrect/inconsistent argument values for a API method OR under some exceptional cases like resource unavailability at the server side etc are listed here.

Each error is assigned with a unique error code.

1. Internal Server Error

This error will occur if there is some internal server problem or some resource unavailability in the Zoho Sheet server while processing the API request.

Error Code:


<methodResponse methodName="$methodName">
    <error>
        <code>2500</code>
 <message>
            Internal Server problem while executing this method.
        </message>
    </error>
</methodResponse>

2. Authentication Error

This error will occur if wrong login credentials were passed for getting the ticket or incorrect ticket is passed while invoking the API methods

Error Code


<methodResponse>
    <error>
        <code>2401</code>
        <message>
            Problem while authenticating the associated ticket.
        </message>
    </error>
</methodResponse>

3. Request Parsing Error

This error will occur if the API request is not sent with the correct xml format

Error Code


<methodResponse>
    <error>
        <code>2400</code>
        <message>
            Problem while parsing the request.
        </message>
    </error>
</methodResponse>

4. Unsupported HTTP operation Error

For now, most of the API methods should be invoked through HTTP POST requests. If they are invoked through any other mode like HTTP GET, this error will occur

Error Code


<methodResponse>
    <error>
        <code>2402</code>
        <message>
            Currently, " + $http_operation + " is not supported for accessing zohosheet web APIs.
        </message>
    </error>
</methodResponse>

5. No Such Method Error

This error will occur when the value specified for the 'methodName' tag in API request is wrong

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2405</code>
        <message>
            Specified method name is wrong.
        </message>
    </error>
</methodResponse>

6. Mandatory Arguments Missing Error

This error will occur if any of the mandatory arguments is missed out while sending the API request

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2831</code>
        <message>
            The parameter(s) {param1,param2,..} required for executing this method were missing
        </message>
        <info>
            <param name="$paramName" />
            ....
        </info>
    </error>
</methodResponse>

7. Wrong Value Error

This error will occur, if a wrong value is specified for any of the arguments.

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2832</code>
        <message>
            The value specified for $paramName is wrong. Allowed values are { val1 | val2 | ... }
        </message>
        <info>
            <param name="$paramName" value="$paramValue" />
        </info>
    </error>
</methodResponse>

8. Wrong Type Error

This error will occur, if data type of the specified argument is wrong. For example, specifying a string value for a integer argument will lead to this error

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2833</code>
        <message>
            Wrong type of value given for $paramName. Expected type is $datatype
        </message>
        <info>
            <param name="$paramName" value="$paramValue" />
        </info>
    </error>
</methodResponse>

9. Base64 Decoding Error

This error will occur, if problem occurs while decoding the Base64 encoded content sent by the client

Error Code


<methodResponse methodName="$methodName">
    <error>
 <code>2834</code>
        <message>
            The Base64 encoded content provided for $paramName parameter is inconsistent.Hence it could'nt
            be decoded properly
        </message>
        <info>
            <param name="$paramName" />
        </info>
    </error>
</methodResponse>

10. No Such Workbook Error

This error occurs, if the workbook referred by the user in API requests does not exists in user's Zoho Sheet account

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2851</code>
        <message>
            The workbook with id $bookId is not available in your account
        </message>
        <info>
        <workbookId> $bookId </workbookId>
        </info>
    </error>
</methodResponse>

11. Accessing Trashed Workbook Error

This error occurs, if the user is accessing a trashed workbook through the APIs

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2852</code>
        <message>
            The workbook with id $bookId is not accessible as it is trashed
        </message>
        <info>
            <workbookId> $bookId </workbookId>
        </info>
    </error>
</methodResponse>

12. Accessing Shared Workbook Error

This error occurs, if the user is accessing a workbook shared to him from the API methods, which were meant not for exposing the 'Sharing' related details

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2853</code>
 <message>
            The workbook with id $bookId is shared to you. It is currently not accessible through this method.
        </message>
        <info>
        <workbookId> $bookId </workbookId>
        </info>
    </error>
</methodResponse>

13. Concurrent Modification Error

This error may occur, if more than one user is trying to update the same workbook simultaneously

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2854</code>
        <message>
            The workbook with id $bookId is currently modified by user $lockOwner. Save operation failed.
        </message>
        <info>
            <workbookId> $bookId </workbookId>
            <lockedBy> $lockOwner </lockedBy>
        </info>
    </error>
</methodResponse>

14. Needs Merge Error

This error occurs, if the user is trying to update the workbook with an older version

Error Code


<methodResponse methodName="$methodName">
 <error>
        <code>2855</code>
 <message>
             The workbook with id $bookId is updated since your retrieval. Save operation failed.
        </message>
        <info>
 <workbookId> $bookId </workbookId>
        </info>
    </error>
</methodResponse>

15. Wrong API Key Error

This error occurs, if the API key specified with the method request is incorrect.

Error Code


<methodResponse methodName="$methodName">
    <error>
        <code>2890</code>
        <message>
             The API Key is either missing or incorrect.Provide the correct one.
        </message>
    </error>
</methodResponse>