The New Error Codes in CRM API - RECORD_LOCKED and NOT_APPROVED

The New Error Codes in CRM API - RECORD_LOCKED and NOT_APPROVED

Hello everyone!

As you all are aware, Zoho CRM offers an option to upload images for a record. When a user uploads images, Zia vision checks if the record meets any Zia vision configuration rules' criteria, and validates them. Click here to know more about Zia vision.

As a part of our upcoming enhancement, we are going to support the image processing state for the records. We have added two new error codes related to the same in the Zoho CRM APIs.

1. RECORD_LOCKED

Zia image processing state
In our upcoming enhancement, we are going to introduce a new state named "Zia image processing state".

Whenever a user creates/updates a record with images, Zia vision will validate the images. We will lock the records undergoing Zia image processing. When you try to access the records that are in this state, the system throws RECORD_LOCKED error.

When will you face this error?
When you try to Update Records, Delete Records, Add Tags, Remove Tags, Share Records, Mass Update Records, Convert Lead, Download Record Image of the records that are in the Zia image processing state, through API.

Here is how the error looks:
{
    "code": "RECORD_LOCKED",
    "details": {
     "id":"111112000000075003",
     "action":"zia_vision_processing"
    },
    "message": "Cannot update record that is not approved yet",
    "status": "error"
}

What should you do when you face this error?
You must wait for Zia Vision to complete the image processing and then make an API call to manipulate the record.

2. NOT_APPROVED

APIs in which you might face this error, once the enhancement is live:

When will you face this error?
The record can be either approved or rejected based on the failure actions configured in Zia vision configuration rules' criteria. Once the enhancement is live, you might face the error when:
  1. The images of the record fail and the record meets the failure action type criteria "Do not create". In this case, Zia vision rejects the record.
    (or)
  2. The record is moved back to the approval process after satisfying the failure action type criteria "Record Approval".
    (or)
  3. When you try to download/upload the record image that is waiting for Image approval.
Here is how the error looks:
{
"code": "NOT_APPROVED",
"details": {
"id":"111112000000075003"
},
"message": "Cannot update record that is not approved yet",
"status": "error"
}

What should you do when you face this error?

Case 1: When the record is in the rejected state due to Zia image validation.
If the record is in the rejected state, you can:
  1. Either upload a new image which will again be resubmitted to Zia image validation. 
    (or)
  2. Delete the failed image and, after making the necessary changes, resubmit the record to Zia image validation. 
Case 2: When the record is in the approval process.
If the image has been rejected by Zia image validation, and the record is moved to the approval state, the system will not allow you to update the images of the record until the reviewer approves the record.

In this case, wait for the reviewer to review the record, and either approve or reject the same.

Case 3: When you try to download/upload the record image that is in the approval process.
In this case, wait for the concerned user to either approve or reject the images of the record.

Note:
Currently, Zia validation supported for only for record image. As part of our upcoming enhancement, we will extend the support for image upload field also.

This enhancement will be opened to all by the end of October, 2020.

We request you to make the necessary changes in your code to handle these error codes.

Please write to us at support@zohocrm.com, if you have any questions.

Cheers!





                            Zoho Desk Resources

                            • Desk Community Learning Series


                            • Digest


                            • Functions


                            • Meetups


                            • Kbase


                            • Resources


                            • Glossary


                            • Desk Marketplace


                            • MVP Corner


                            • Word of the Day



                                Zoho Marketing Automation


                                        Manage your brands on social media



                                              Zoho TeamInbox Resources

                                                Zoho DataPrep Resources



                                                  Zoho CRM Plus Resources

                                                    Zoho Books Resources


                                                      Zoho Subscriptions Resources

                                                        Zoho Projects Resources


                                                          Zoho Sprints Resources


                                                            Qntrl Resources


                                                              Zoho Creator Resources


                                                                Zoho WorkDrive Resources



                                                                  Zoho Campaigns Resources

                                                                    Zoho CRM Resources

                                                                    • CRM Community Learning Series

                                                                      CRM Community Learning Series


                                                                    • Tips

                                                                      Tips

                                                                    • Functions

                                                                      Functions

                                                                    • Meetups

                                                                      Meetups

                                                                    • Kbase

                                                                      Kbase

                                                                    • Resources

                                                                      Resources

                                                                    • Digest

                                                                      Digest

                                                                    • CRM Marketplace

                                                                      CRM Marketplace

                                                                    • MVP Corner

                                                                      MVP Corner

                                                                    





                                                                    




                                                                        Design. Discuss. Deliver.

                                                                        Create visually engaging stories with Zoho Show.

                                                                        Get Started Now