API Status Codes
The success or failure of an API request is conveyed by the code and message in its response. The following table lists all the codes corresponding to Zoho Creator's REST APIs.
| HTTP Status Code | HTTP Status | Code | Message | Description |
|---|---|---|---|---|
404 | NOT FOUND | 1000 | Invalid API URL format. | The URL of the API request is not valid. Please refer to the individual documents to learn about their format. |
401 | AUTHORIZATION ERROR | 1000 | A mandatory parameter - 'paramname' is either absent or has been used twice. Please check and try again. | A mandatory parameter is missing or has been provided multiple times in the request. Ensure that all mandatory parameters are included with the correct key. |
401 | AUTHORIZATION ERROR | 1030 | Authorization Failure. The access token is either invalid or has expired. Please check your Zoho Account for more information. | The access token passed in the authorization header is not valid. It may have expired, in which case you need to refresh the access token. |
404 | NOT FOUND | 1040 | No account owner named "<OWNER_NAME>" found. | The account_owner_name in the API request is not valid. You must use the username of the user in whose account the request is to be made. |
404 | NOT FOUND | 1040 | There is no such user. | The specified user account doesn't exist or can't be accessed. This happens when the account name is incorrect, has been deleted, or if you don't have permission to access it. Ensure to use a valid account owner name and verify that you have the necessary permissions. |
403 | FORBIDDEN | 1060 | You do not have permission to access this application. Please check with the application admin. | The target application has not been shared with the requesting user. |
401 | AUTHORIZATION ERROR | 1060 | Invalid request parameter found - paramname | The request includes a parameter that is invalid or not supported for this API. This could be because the parameter name is incorrect, or not applicable to the type of request being made. Refer to the supported parameters for this API. |
403 | FORBIDDEN | 1080 | API calls cannot be made to disabled applications. Please check with the application admin. | There may have been a change in the Creator subscription that caused the target application to be disabled. You need to access the Creator account's home page and enable the target application. |
404 | NOT FOUND | 1100 | You do not have permission to access this component. Please check with the application admin. | The requesting user is not permitted to access the target component (form, report, or page). |
403 | FORBIDDEN | 1130 | You do not have permission to access this application's APIs. Please check with the application admin. | The API access permission is disabled for the requesting user. If you want to give the requesting user this permission, you must either enable it in their permission set or you must assign them another permission set where the API access permission is enabled. |
403 | FORBIDDEN | 2892 | No application named "<APPLICATION_NAME>" found. Please check and try again. | There's no application in the target Creator account with the given application link name. You may use this reference document to view the link names of your applications and components within them. (Use the domain that corresponds to your Zoho account to access the reference document) |
404 | NOT FOUND | 2893 | No form named "<FORM_NAME>" found. Please check and try again. | There's no form in the target application with the given form link name. You may use this reference document to view the link names of your applications and components within them. (Use the domain that corresponds to your Zoho account to access the reference document) |
404 | NOT FOUND | 2894 | No report named "<REPORT_NAME>" found. Please check and try again. | There's no report in the target application with the given report link name. You may use this reference document to view the link names of your applications and components within them. (Use the domain that corresponds to your Zoho account to access the reference document) |
404 | NOT FOUND | 2896 | Permission denied to delete record(s). | The requesting user is not permitted to delete the records of the target form/report. |
403 | FORBIDDEN | 2897 | Permission denied to update record(s). | The requesting user is not permitted to update the records of the target form/report. |
403 | FORBIDDEN | 2898 | Permission denied to view record(s). | The requesting user is not permitted to view the records of the target form/report. |
403 | FORBIDDEN | 2899 | Permission denied to add record(s). | The requesting user is not permitted to add records to the target form/report. |
403 | FORBIDDEN | 2902 | Invalid column value for 'fieldlinkname' | If a form contains dropdown, lookup, or multi select fields, those fields may have specific allowed values in their field properties. When sending values to these fields through the API, ensure the input matches the configured options. For URL fields, the API expects a JSON object that includes the URL along with any required data, such as link name, URL title, and tooltip/description. |
200 | OK | 2933 | You do not have permission to access this application. | The requesting user does not have access to the target application. In other words, it hasn't been shared with that user. |
404 | NOT FOUND | 2945 | ERROR | This is an invalid OAuth scope. Please regenerate the OAuth token corresponding to the API with the proper OAuth scope. |
403 | FORBIDDEN | 2945 | <http method> is not a valid method for this request. | An unsupported HTTP method was used for this request. Refer to the API V2.1 pages for the acceptable methods to use with this URL and resend the request using a supported HTTP method. |
401 | AUTHORIZATION ERROR | 2945 | Please enter a valid input for '%s' key. | The input value entered for the key is invalid. This happens when the key value is not one of the allowed options, contains a typo, or is in an incorrect format. For example, for the key 'environment', the valid values are 'development' and 'stage' only, any other value will result in an error. |
429 | Too Many Requests | 2955 | You have reached your API call limit for a minute. Please try again after sometime. | The threshold limit for all v2.1 APIs is set at 50 calls/min. When the specified per min limit is reached, this error response will be displayed. |
403 | FORBIDDEN | 2965 | No more entries allowed as per the form validation. | The form is configured to be disabled after accepting a certain number of entries. Learn more |
200 | Success | 3000 | Message "Data Added Successfully" or the success message is configured by the user. | "Data Added Successfully" will be shown when the message key is either set to false or not been included in the API request. The form's message will be present in the response when a custom message is set and the API request includes message=true. |
403 | FORBIDDEN | 3002 | The "<FEATURE_NAME>" feature is currently not available for this Zoho Creator account. Please contact support@zohocreator.com to learn more. | This error will occur when the requesting user is trying to perform an operation that is beyond the Creator account's subscription. Please refer to the pricing page for feature availability. |
200 | OK | 3020 | API request's body is either missing or incomplete. | The API request's body content is missing. |
403 | FORBIDDEN | 3050 | Passing values for Formula, File Upload and Image type fields is not allowed. Use the Upload File API to update the File Upload and Image fields. | The add and update record APIs cannot assign a value for the formula, file upload, and image fields. The formula field's value is evaluated as per its expression and you must use the upload file API to upload a file to the file upload and image fields. |
400 | BAD REQUEST | 3050 | File Upload type and Image type fields are not allowed. Use the Upload File API to update the File Upload and Image fields. | Add record and update record APIs doesn't allow directly assigning values for file upload, image fields, audio, video, or signature. For file upload and image fields, you can use the upload file API in order to update the field using API. |
200 | OK | 3090 | When no criteria is passed: When an invalid criteria is passed: When a field's link name, that used in the criteria, is incorrect: | This concerns the API requests that allow a criteria to be passed so as to perform the required operation on select records. Either the request requires a criteria and one hasn't been given, or the criteria is invalid, or the link name of one of the fields used in the criteria is incorrect. |
200 | OK | 3190 | No record with ID "<RECORD_ID>" found. | There is no record in the target form with the given record ID. |
200 | OK | 3630 | Input file exceeds the 50 MB limit. Please upload a smaller file. | The file upload field can accept a file that doesn't exceed 50 MB. The upload file API request will fail so when the input file exceeds this limit. |
200 | OK | 3660 | No file found in the request. Please include a file and try again. | The upload file API request does not have a file in it. An input file is required to perform the upload operation. |
200 | OK | 3710 | No field named "<LINK_NAME>" found. Please check and try again. | No field named "<LINK_NAME>" found. Please check and try again. |
200 | OK | 3730 | No file found in the record with ID "<RECORD_ID>". | Either there's no file in the target file upload, image, audio, video, or signature field, or it contains a file of size 0 KB. |
200 | OK | 3750 | "<LINK_NAME>" is not a file type field. Please check and try again. | The field link name given in the request does not belong to a file upload, image, audio, video or signature field in the target report. You need to check the corresponding form and use the correct field's link name in the API request. |
200 | OK | 3780 | No subform named "<LINK_NAME"> found. Please check and try again. | The target form does not contain a subform with the given link name. You need to check the target form and use the correct field's link name in the API request. |
200 | OK | 3830 | You do not have permission to transfer files to/from the field "<FIELD_NAME>". Please check with the application admin. | The requesting user does not have permission to upload a file to the target file upload, image, audio, video or signature field since they don't have permission to add/update records in that form. |
200 | OK | 3910 | No forms available. | The target application does not have any forms. |
200 | OK | 3920 | No pages available. | The target application does not have any pages. |
200 | OK | 3930 | No reports available. | The target application does not have any reports. |
200 | OK | 3950 | A maximum of 200 records can be added per request. | The add records API can add up to 200 records per request. You'll get this error when the number of JSON objects in the request body exceeds 200. We recommend breaking down your input accordingly. |
200 | OK | 3960 | A maximum of 200 records can be processed per request. Include the "process_until_limit" parameter to process the first 200 records. | A maximum of 200 records can be updated or deleted per request. Including process_until_limit=true in the update records and delete records API requests tells the request server to perform the update or delete operation for the first 200 records that match the given criteria. You'll have to loop your API requests until the more_records key in the response is returned as false. |
200 | OK | 4000 | Account's Developer API limit has been reached. Please upgrade to execute more REST API calls. | The Zoho Creator subscription dictates the number of REST API requests that can be made per day. You'll have to check the Creator account's usage details and either upgrade its Developer API limit or wait a day to make the next API request. |
200 | OK | 8011 | 'fieldlinkname' has exceeded its maximum digits (length) | If a form contains decimal, percentage, currency, or number fields, digit length limits may have been configured in their field properties. The Max Digits setting determines the total number of digits that can be entered, while the Decimal Points setting defines how many digits are allowed after the decimal point. For decimal, percentage, and currency fields, both the Max Digits and Decimal Points limits need to be followed. For number fields, the value must stay within the configured Max Digits limit. |
200 | OK | 8012 | Input format does not match the required format for the field | This error occurs because the value you entered doesn’t match the required numeric format for the currency field. The field requires both an integer and a decimal value, but the input included only the integer portion. |
200 | OK | 9030 | API looping to same component exceeded the specified limit of 1. | This concerns the incorrect usage of API calls to add data in the same form in the application. Assume Form A triggers a workflow and uses an API call on successful form submission to add another record to the same form. This cycle continues, allowing the workflow to run repeatedly in a loop, with data getting added to the same form endlessly. As a measure to stop this looping and avoid the subsequent performance dip, workflow execution will be limited to one loop, for actions that add records to the same form. That is, the workflow will only be triggered once. |
200 | OK | 9030 | API looping to same component exceeded the specified limit of 1. Please contact us at support@zohocreator.com. |
|
200 | OK | 9040 | API looping to other component exceeded the specified limit of 3. | This concerns the incorrect usage of API calls to add data between different forms in the same application. There are two related forms—A and B. On successful submission of Form A, an API call is used to add a record in Form B, which in turn hits another API call, submitting another record in Form A and continuing the same pattern, adding records in both the forms over and over again. As a measure to stop this looping, workflow execution will be limited to three loops for actions that add records to other forms. That is, the workflow will be triggered thrice, allowing records to be added in three forms, after which it will cease to trigger. |
200 | OK | 9040 | API looping to other components exceeded the specified limit of 3. Please contact us at support@zohocreator.com. |
|
200 | OK | 9210 | Please enter a valid input for 'accept' header key. The possible values are application/json and text/csv. | The input for the 'accept' header key which defines the format in which the API will be displayed, can only be application/json or text/csv. The value given as input here is of an unsupported content type. |
200 | OK | 9220 | No records exist in this report. | This report has no available records for the user. |
400 | BAD REQUEST | 9240 | Please enter a valid input for 'field_config' key. The possible values are quick_view, detail_view, custom, all. | An incorrect value was specified for the 'field_config' parameter. This parameter determines what fields of the records are fetched. You can only provide the key value as quick_view, detail_view, custom, or all to retrieve the required fields. |
400 | BAD REQUEST | 9250 | Please enter a valid input for 'max_records' key. The possible values are 200, 500, 1000. | An incorrect value was provided for the 'max_records' parameter, that determines how many records are fetched per request. You can only provide the preset values 200, 500, or 1000 as an input for this key. |
400 | BAD REQUEST | 9260 | fields' key is mandatory since 'field_config' value has been specified as 'custom'. | If the 'field_config' parameter is set to 'custom', only the fields you specify will be fetched. In this case, you need to provide the field link names for all the fields you want to retrieve in 'fields' key. The API will return only the fields included in your configuration. |
400 | BAD REQUEST | 9270 | None of the fields supplied in the 'fields' key exist. Please specify at least one valid field link name. | The field names provided in the 'fields' parameter doesn't exist or are incorrect for this form. Enter a valid field link name that is defined in the form. |
400 | BAD REQUEST | 9280 | No records found matching the given criteria. Try using different search criteria. | This error occurs when the search criteria included in the request body. |
400 | BAD REQUEST | 9290 | The specified record ID is incorrect or non-existent. Please enter a valid ID value. | When accessing records using record ID, the API retrieves data based on the IDs provided in the request. If a record ID is incorrect or does not exist in the associated report, the corresponding record will not be returned. |
400 | BAD REQUEST | 2953 - 3001 | 'fieldlinkname' has exceeded the maximum character length | If a form contains single line or email fields, a maximum character length may have been set in its field properties. The character length configured for each field determines how much input it can accept. When sending values to these fields through the API, make sure the input value is within that defined limit. |
400 | BAD REQUEST | 2904 - 3001 | Value cannot be specified for a formula field | A formula field can't accept user input because its value is automatically generated. The system calculates this based on the expression configured for the field, so you can't enter or update it through an API request. |