Kaizen #49 - Share Records #API
Hello Everyone!
Welcome back to another week of Kaizen!
In this post, we will discuss Share Records via Zoho CRM API.
Record-level sharing
In Zoho CRM, users can share individual records from any module with other users in the organization. You can share records using share records API.
Pre-requisite
Users with the Administrator profile can always share records with other users in the organization. For users with other profiles, the sharing permission must be enabled.
To enable share permission,
- Go to Setup > Users and Control > Security Control.
- Select a profile to which you want to enable the permission.
- Enable the Share permission under Tool Permissions.
- Select the checkbox(es) for the corresponding modules to which you want to enable Share permission.
1. Share Records via API
Using the share records API, you can share individual records from any module with other users in the organization.
Request URL: {{api-domain}}/crm/v2/Quotes/4150868000002515001/actions/share
Request method: POST
Sample Input
{ "share": [ { "user": { "id": "4150868000001248015" }, "share_related_records": true, "permission": "full_access" }, { "user": { "id": "4150868000001199001" }, "share_related_records": true, "permission": "read_only" } ] } |
Input JSON
Key | Description |
user JSON object, Mandatory | Specify the unique ID of the user in the "id" key. You can retrieve valid user IDs from Get Users API. |
share_related_records Boolean, Optional | Represents if you want to share the record along with the related records: true - share related records along with the record. false - Do not share related records. This is the default value. |
Permission String, Optional | Represents the access permission you want to give the user for the record: full_access - Allow user the full access(read, edit, delete) to the record. The user with whom the record is shared can also update the owner of the record. However, the user cannot share the record with another user. This is the default value. read_only - Allow the user to only view the record. read_write - Allow the user to view and edit the record. The user with whom the record is shared cannot update the owner of the record. |
Note:
- A record can be shared with a maximum of 10 users. Through related lists, a record can be shared with a maximum of 12 users. If you exceed this limit, the system throws the SHARE_LIMIT_EXCEEDED error.
- You can share records from any module except the activities module and linking module. They must be shared as related records. Refer to the Input JSON section, to know how to share a record with related list.
- You can only share the records with users who do not already have access to it.
- Only record owners and users with the administrator profile can share their records with other active and confirmed users in the organization.
Sample Response
2. Get Details of a Shared Record
Using the get shared record details API, you can retrieve the details of a shared record. For instance, whether the record is shared with or without the related lists, the access-permission of the record, the details of the users with whom the record is shared with, and so on.
Request URL: {{api-domain}}/crm/v2/Quotes/4150868000002515001/actions/share
Request method: GET
Sample Response
Response JSON
Key | Description |
shared_through JSON object | Represents the module API name, module ID of the module from which the record was shared. Also, represents the unique ID of the record. |
user JSON object | Represents the name and unique ID of the user, and ZUID of the organization to which the user belongs. |
3. Update share permissions
Using the update share permissions API, you can update the sharing permissions, revoke access to the shared record, and update access permission to the related lists of the shared record.
Request URL: {{api-domain}}/crm/v2/Quotes/4150868000002515001/actions/share
Request method: PUT
Sample Input
{ "share": [ { "user": { "id": "4150868000001248015" }, "share_related_records": true, "permission": "read_only" }, { "user": { "id": "4150868000001199001" }, "share_related_records": false, "permission": "full_access" } ] } |
Note:
- You can choose to share the record with other users by adding the details to the JSON array. To revoke permission, remove the user's details from the JSON array.
- Apart from adding, removing users, you can update share permissions (read_only, read_write, full_access), and permission to access related records (share_related_records) for existing shared users.
- Ensure that you don't share the same record with more than 10 users.
Sample Response
4. Revoke shared records
Using revoke shared records API, you can revoke access to a shared record.
Request URL: {{api-domain}}/crm/v2/Quotes/4150868000002515001/actions/share
Request method: DELETE
Sample Response
Note:
- When you fire this API, the system revokes the record from all the shared users.
- You can revoke share permissions only for a single record per API call.
We hope you found this post useful.
Write to us at support@zohocrm.com if you have any questions, or let us know in the comment section.
Cheers!
Previous 'Kaizen' - Related Lists and Related Records #API
Access your files securely from anywhere
New to Zoho Recruit?
Zoho Developer Community
New to Zoho LandingPage?
Zoho LandingPage Resources
New to Zoho Survey?
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Bigin?
Topic Participants
Sneha Sridharan
Sticky Posts
Kaizen #197: Frequently Asked Questions on GraphQL APIs
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Kaizen #198: Using Client Script for Custom Validation in Blueprint
Nearing 200th Kaizen Post – 1 More to the Big Two-Oh-Oh! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Celebrating 200 posts of Kaizen! Share your ideas for the milestone post
Hello Developers, We launched the Kaizen series in 2019 to share helpful content to support your Zoho CRM development journey. Staying true to its spirit—Kaizen Series: Continuous Improvement for Developer Experience—we've shared everything from FAQsKaizen #193: Creating different fields in Zoho CRM through API
🎊 Nearing 200th Kaizen Post – We want to hear from you! Do you have any questions, suggestions, or topics you would like us to cover in future posts? Your insights and suggestions help us shape future content and make this series better for everyone.Client Script | Update - Introducing Commands in Client Script!
Have you ever wished you could trigger Client Script from contexts other than just the supported pages and events? Have you ever wanted to leverage the advantage of Client Script at your finger tip? Discover the power of Client Script - Commands! Commands
New to Zoho TeamInbox?
Zoho TeamInbox Resources
Zoho CRM Plus Resources
Zoho Books Resources
Zoho Subscriptions Resources
Zoho Projects Resources
Zoho Sprints Resources
Qntrl Resources
Zoho Creator Resources
Zoho CRM Resources
Design. Discuss. Deliver.
Zoho Show Resources
Get Started. Write Away!
Writer is a powerful online word processor, designed for collaborative work.
Zoho CRM コンテンツ
-
オンラインヘルプ
-
Webセミナー
-
機能活用動画
-
よくある質問
-
Ebook
-
-
Zoho Campaigns
- Zoho サービスのWebセミナー
その他のサービス コンテンツ
Nederlandse Hulpbronnen
ご検討中の方
Recent Topics
ZOHO BOOKS - RECEIVING MORE ITEMS THAN ORDERED
Hello, When trying to enter a vendor's bill that contains items with bigger quantity than ordered in the PO (it happens quite often) - The system would not let us save the bill and show this error: "Quantity recorded cannot be more than quantity ordered."Has anyone successfully added Microsoft Graph API Oauth2 as a connection?
I'm having trouble getting Microsoft Graph API created as a connection in zoho crm. Has anyone successfully added Microsoft Graph API Oauth2 as a connection? My issue is not necessarily on the Zoho side, but understanding how to set up the Microsoft sideSyncing Timesheets between Projects and Desk
All users able to see their own timelog entries from all apps in one place, synced immediately. All managers able to view total/all time entries from one place. This is something that has come up for us and multiple clients. Example: we have a clientSpell Check default language
Hello All, Is it possible to set the Spell Check default language? I can't find it in the settings. Thanks a lot! LeventeZoho Backstage 3.0 - Boostez vos événements avec des outils malins
Zoho Backstage vous accompagne dans l’organisation d’événements réussis, avec des outils qui simplifient la planification, optimisent l’exécution et renforcent la connexion avec votre public. La version 2.0 a apporté une nouvelle interface, plus de flexibilitéPortal user activity reporting
Aside from the metrics section in the admin dashboard, is there a way to view/create reports for portal user activity? Im looking for a more granular option to see exactly what users are utilizing the portal. Thanks!Automation #11 - Auto Update Custom Fields with Values from Emails
This is a monthly series designed to help you get the best out of Desk. We take our cue from what's being discussed or asked about the most in our community. Then we find the right use cases that specifically highlight solutions, ideas and tips to optimizeAdmins to set Agents Picture
Admins should not have to rely on agents to set a nice profile picture for them. Admins get the headshot pictures from HR and should be able to upload and set their picture, not rely on them to: 1) upload a picture at all 2) upload a good picture 3) uploadTime Tracking Reporting and Billing
I wish for the time tracking module to be enhanced further. Currently it is independent of Support Plans and Contracts. Support Plans and Contracts are also mostly separate. We need a better dashboard of this with the ability to natively mark billed orEnhanced Email Signature Folding
We have departmental signatures setup which are great, however, when viewing ticket details, it gets very overwhelming when scrolling though threads and conversations where you scroll past ten different signatures of your own team, then ten signaturesHow to add formatting in zoho.cliq.postToUser(...) message?
In a CRM Deluge function, I'm trying to use the message formatting guidelines given here: https://www.zoho.com/deluge/help/cliq/posting-to-zoho-cliq.html#message-formats My message is: message: #Title text. The result in Cliq is: #Title text. (no largeHow to add line breaks in zoho.cliq.postToUser(...) message?
In a CRM function using Deluge I'm sending this message and attempting to add some line breaks but they are ignored. Is there another way to add these breaks? My message: message: New urgent task\nDescription \nThis is a fake description.\n A new line?Zia Agents/End of Day Reports
As a manager or owner it would be nice if Zia analyzed today's (or this week's tickets) and gave an end of the day report to management team. - what important tickets were worked on or submitted today? - what agents were unproductive today and answeredProject Cost Tracking
I see there are questions/concerns that Zoho doesn't track costs to a tasks in a project. We are a manufacturer and are in the early stages of tracking costs to project. I would like to expand out the COGS Chart of accounts in Books and record costs viaHow to record if the payment made is return due to transaction failed.
So there is Bill of $2000, and a payments made transaction to clear the bill. The amount is actually deducted from bank account. However, a few days later, I found the bank returned only $1750 cause there are $250 bank service charge for this failed transaction.Help Center Customization UI
The customization screens for the help center needs the UI improved. It looks straight out of 2004. The Zoho Desk normal UI is great. All it takes is uniform fonts and colors across all parts of the tool... I compare this to Zendesk Guide.Este domínio já está associado a esta conta
Fui fazer meu cadastro na zoho e quando digitei meu domínio recebi essa mensagem que meu domínio estava associado a uma conta que eu nem faço idéia de quem seja. Como que faço pra resolver isso? Atenciosamente, Anderson Souza.I need some help in Expenses Per Diem Policy
this is my script written for restricting the PerDiem Components. Say if Lodging and Per Day Allowance both is selected from Per Diem Page then the report should gets auto rejected. When Im trying to executing it says the following error {"code":11,"message":"TheAdding Photos to Dashboards on Zoho Analytics
I am creating a dashboard to showcase data from survey results from focus groups. I am creating a focus group participant profile tab where it is filtered by the name of the participant and showcases information about them using KPI widgets. I am runningWhat is the difference between Retainer invoice and Advance Payments?
Retainer invoice seem like they are just advance payments with extra details. Instead of creating a Sales Order with order details, a retainer is created. It feels like they are a workaround to link advance payments with sales orders. Is there any advantageExporting record notes in bulk
Hi team, Is it possible to bulk export the notes attached to a record? i.e to a CSV file or otherwise. Our use case is exporting all notes for our lead/account/Deal records. We have another system we'd like to import these notes to but I can't seem toField customization
Hi Team Good day! I am a commission agent who sell and purchase goods from vendors, while in purchasing invoices I am not able to deduct the expenses such as commission and other expenses on actual amount. Kindly help me to customize the invoice basedvendors / customers with 2 different address and gst no
Why can't we have option for more than one address and depending on the state option for more than 1 GST no. ? We have customers / vendors PAN india with different addresses and GST no. for different states.Error: Invalid Element gst_no, Invalid Element gst_treatment, Invalid Element place_of_contact
so i am creating a new contact post request and i want add gst infomation when amount is above 50000 and if pass gst info in request body then i get this errors > Error: Invalid Element gst_no, Invalid Element gst_treatment, Invalid Element place_of_contactAdd multiple Billing Addresses under one GST number
My client owns multiple businesses in various locations but they all come under one GST. Is there a way to add multiple billing addresses for the same GST? Managing this by adding multiple Shipping addresses is not an option. The client wants the GSTZoho Mail API - Upload Attachment
https://www.zoho.com/mail/help/api/post-upload-attachments.html I followed the steps from the API documentation and wrote a backend in JavaScript to send emails. Normal emails are sent without any problems. However, I can’t send emails with attachments.Unable to create custom fields for shipment order
I'm unable to create custom fields for shipment orders, even though the custom fields are set up correctly. A request to the following endpoint: https://www.zohoapis.com/inventory/v1/settings/preferences/customfields?organization_id=${ZOHO_ORGANIZATION_ID}&entity=shipment_orderKaizen #202 - Answering Your Questions | Testing and Using REST APIs in Widgets
Hello Developers! Welcome back to a fresh week of Kaizen! Thank you for your active participation in sharing feedback and queries for the 200th milestone. This week, we will look at the following queries related to widget: Widget Testing Using REST APIIntroducing the 'Send as Email' option on the Zoho Desk iOS mobile app
Hello everyone! In the latest version(v2.10.2) of the Zoho Desk iOS app, we have brought in support for the 'Send as Email' option while creating a ticket. This feature enables you to reach out to the customers by sending outbound emails. The emails areZoho Forms Not Loading on Website – DNS Resolution Error
Dear Zoho Support Team, User ID : 20069458731 We are experiencing an issue with the Zoho Form embedded on our website (https://vitel.com.tr/satis-destek-formu/). The form is not loading, and the following error message appears in the browser: “forms.zohopublic.euData backup retention question/
My zohocrm subscription gives me 2 full data backups per month. I have a scheduled backup configured to run twice a month. I just went to download my backup and i can't find it, it ran about 9 days ago... From what i can tell with google zoho only keepsBasic Apple Watch App
Sometimes I leave my phone behind. I will get push notifications that tickets are updated etc.. It would be nice to at least view them and do a few basic functions. reassign. public reply. private comment.Look and Feel Uniformity
Someone needs to go through the mobile app and match the look and feel of the web version. For example, it is global standard to highlight private notes as yellow background hue. Desk does that on web, but not on mobile. Mobile also has an odd blue iconManaging two books in Zoho Books
is it possible to effectively manage two separate books within Zoho Books? My organization is considering handling accounting for two distinct subsidiaries, and we would like to understand the best way to achieve this within the Zoho Books.Display All Custom Buttons Without Dropdown on Record Page
In my org's workflow we usually want to do some kind of quick action off of an individual record - i.e. of an individual contact, or individual deal. What we have always found a hindrance is the location of all custom buttons being in the drop down onZoho Sales Team - Extremely Slow Response Times
Hi everyone, Has anyone else experienced unusually slow response times from Zoho’s sales team? I sent an email last night, and it’s been nearly 24 hours with no reply. While I understand delays can happen, this seems longer than expected for a sales inquiry.Yodlee Bank Feeds
I'm well aware of the many bank feed issues out there that haven't been resolved, but I'm looking for information on Rules in relation to bank feeds. U.S based, Bank of America user and prior to Yodlee all of my banking feeds and Rules worked seamlessly.Unable to create custom function
Unable to create custom function - Please check the screenshot for the details HERE IS THE FUNCTION!! try { // 1. Fetch the details of the approved Bill using its ID billDetails = zoho.books.getRecordById("Bills", organization.get("organization_id"),Need a feature which can validate PAN from Income Tax Portal
Hello Zoho, We need a feature which can help us validate PAN which is being entered in AR/AP Profiles to check if it is valid and display the name as per Income Tax so as to get rid of incorrect PAN into the systems. Please do the needful ThanksPAN - Aadhar Link Status
Can Zohobooks also get latest PAN-Aadhar Linking Status from Income Tax Portal ?Next Page