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
How to parse column having JSON data using SQL?
We have a daily sync from a PostgreSQL database that brings data into Zoho Analytics. Some of the columns store raw JSON data. We need to build SQL queries on top to parse data from JSON and store them in discrete columns. There is no option for "DataEnable report button based on the current user role
Greetings i have a report that contains action buttons, i want these buttons to appear as enabled only when the current logged in user has a certain role, for example only CEO role users will be able to use this button. but when setting the conditions500 Internal Error In Mail API
I'm getting 500 Internal Error when using mail API. I'm getting this error for this one account, it works fine for other Account IDs which I have in my system.Piss poor service in Support in Domains and email
Srijith Narayanan B contacted me today. Very pleasant fellow. Just didn't want to tell him how bad your support service is. You help the person, but you leave before we can finish the next stage. Which causes a lot of frustration. It's been 8 days nowZoho live chat widget in React Js
I am trying to test Zoho live chat widget code in react js, below is the sample code void(0)} onClick={()=>window.$zoho.salesiq.floatwindow.visible("show")}>LIVE CHAT window.$zoho = window.$zoho || {};window.$zoho.salesiq = window.$zoho.salesiqAre there any plans to add Triggers for Subform edits?
By The Grace of G-D. Hi, How are you? Can you tell me if you have any plans to support subform edit as a workflow trigger? And what about have them trigger an "onChange" client script?Zoho commerce
i am facing issue with order summary emails.i am getting 1 continuous email for order received yesterday and today.ideally 1 email should be received for a particular date ie for 02/08 i should received 1 email from 12.01am till 11.59pm but it is beingFeature Request: Improve Category Page Sorting for "Out of Stock" Products
Hi there, I'm writing to request a new feature that I believe would significantly improve the user experience in my online store. Currently, on category pages, products are sorted by popularity. However, when a popular product goes "Out of Stock," itPOSTMAN - There was an error in evaluating the Pre-request Script:Error: Cannot read properties of undefined (reading 'json')
I am beginning the journey to learn how to use the API for Zoho Sign. I am getting the following error when I try to use postman. To walk you through how I am getting this error... I wanted to start with a simple GET and expand my learning from there.How do i integrate shipstation with zoho inventory
Wanting to set up my own delivery driver in ship station so we can get real time tracking of where the package is but then i want it to automatically update zoho inventory packages/shipments how can i do thisInvalid value passed for salesorder_id
Hi, I am using sales return API, details are given below: API: https://inventory.zoho.com/api/v1/salesreturns?organization_id=700571811 Post Json Data: { "salesreturn_number": "", "date": "2020-11-12", "reason": "Testing from API", "line_items": [ { "item_id":Create Invoice and Invoice Items from Sales Order via API
Currently, when creating an Invoice associated with a Sales Order via the API, it appears that I must manually include all of the items (line_items) even though they are already part of the Sales Order. My question is this: is it possible to raise an Invoice via the API based on all of the information associated with a Sales Order--such as the items? In other words, do I always have to manually include the items (line_items) when raising an Invoice via the API when the Invoice is associated withOutlook 2013 Calendar Syncs but "Related To" Field in Zoho is blank
Outlook 2013 Calendar Syncs but Related To Field in Zoho is blank I expect the "Realted To" field to be populated with the calendar participantsExport a Course
Is it possible to export a course from Zoho Learn to a SCORM file?Add and Remove Agents from Departments and Groups in Zoho One
Hi Zoho Flow Team, We hope you're doing well. Currently, Zoho Flow provides an action to add an agent to a group in zoho one, but there is no action to remove an agent from a group or a department. Another action that we find missing is the option toZoho learn Custom portal - networkurl & CustomPortalId
I want to get my individual account’s networkurl and customportalId to use in this API: https://learn.zoho.com/learn/api/v1/portal/<networkurl>/customportal/<customportalId>/manual How can I retrieve the networkurl and customportalId using the API? IConsumer Financing
Does Zoho currently have a payment gateway (such as Stripe, Square, etc) which offers financing for customers? So, let's say the estimate we give the customer is greater than what they can afford at the time, but we can sell the service now, letting themIntégration de la gestion des Passkeys dans Zoho Vault
Zoho Vault est depuis plus d’une décennie une solution fiable pour les entreprises : pour la gestion, le partage et le stockage des mots de passe. En 2018, nous avons fait un pas en avant en proposant la connexion unique (SSO). Nous sommes fiers de franchirScan & Fill with double quote key/value pairs
Hi, An old Ticket moved to a Topic/Idea: I love the idea of the new Scan & Fill as it nearly covers my previous request for a QR Scanner to read a multi-part QR Code. My QR Codes are hard-coded as below: {"key1":"value1","key2":"value2","key3":"value3"}Analytics SQL Queries should allow # as comment
# and // are very common for commenting in SQL. Not sure why analytics only allows /* and */ for commenting. Especially when # grays the line as if it's being commented out. This should be added for sure.SalesIQ Operator Activity Reports in Zoho Analytics
I'm busy building a dashboard in Zoho Analytics and I want to include SalesIQ stats in the dashboard, but I'm unable to get the statistics mentioned in the attached image. Any idea where I can get the stats for Operator Activity?Default in fields on Form B based on the user selection in Form A
Hi Everyone, I have added an action button to a form report to bring up a new form based on user selection, see it indicated in red below: Then when the ne form loads, I want to default in some of the fields based on the record the user was selected on.No longer can indent
Hey there! Is it just me or were we used to be allowed to used tab or indent when writing. It’s not working right now, has this always been the case?Upcoming Changes to the Timesheet Module
The Timesheet module will undergo a significant change in the upcoming weeks. To start with, we will be renaming Timesheet module to Time Logs. This update will go live early next week. Significance of this change This change will facilitate our nextFree webinar alert! Seamless Transition with Lossless Migration: Zoho One + Zoho Mail
Hello Zoho Mail Community! 🚀 Attention IT Admins and Email Administrators! Are you planning to migrate your organization's email to Zoho Mail within the Zoho One ecosystem? 📧 Join our exclusive webinar, Seamless Transition with Lossless Migration: ZohoAdd Resource to Export
The Export Data feature does not include a column for the Resource field. Without this column, Zoho Bookings cannot be used by any business for resource-based services or event types e.g. room bookings, equipment bookings. It seems to be an oversight,Client Script | Update - Client Script Support For Custom Buttons
Hello everyone! We are excited to announce one of the most requested features - Client Script support for Custom Buttons. This enhancement lets you run custom logic on button actions, giving you greater flexibility and control over your user interactions.Mandatory field via deluge code
I would like to ask you if it is possible to make a field mandatory via deluge script. For example, if I have a decision box and I click on it then I want a single line field to be mandatory. If uncheck the decision box then to do the single line as optional. I think it is not possible to do that and I have to do it via validation in 'on validate' field.Revenue Management: #1 What does it mean to "recognize" revenue?
Earning revenue isn't just about collecting cash from your customers. It's about recording the income correctly and consistently. Revenue recognition is the process of deciding when and how to record revenue in financial statements so that they reflectPower of Automation :: Auto-Populate Integration Field in Projects with CRM Account Data
Hello Everyone, A custom function is a software code that can be used to automate a process and this allows you to automate a notification, call a webhook, or perform logic immediately after a workflow rule is triggered. This feature helps to automateZoho Forms and ChatGPT - populating a field using AI.
I have a form where I would like the user to enter a response or query, and have another field populated using AI. For example, user enters Field 1, AI populates Field 2 in response. I want to be able to wrap some additional instruction text around thecampo tag para api
debo conectarme a una api de zoho inventory y ocupo tomar el campo tag para poder asi jalar el articulo que cuente con el campo correcto en tag ejemplo que tag existen carro y avion que cuando busque los articulo con tag carro arroje solo estos por masConnecting Zoho Inventory to ShipStation
we are looking for someone to help connect via API shipStation with Zoho inventory. Any ideas? Thanks. UriUploading file as attachment to Zoho CRM
Hi, I am trying to attach a file to a Zoho CRM contact using Zoho Flow. Right now, I try to do it through the “Upload File” field in Zoho CRM (In my screenshots, it’s called Téléchargement du fichier 1). Here is what I tried: Case 1: Webmerge document The Flow is called “Custom Function” (see screenshot 101). Step 1: Creating a Webmerge document (screenshot 99) Step 2: I use “Update module entry” to upload the created file. I upload Webmerge’s “Document” in my “Téléchargemet duZia Answer Bot - Create Ticket
Surprisingly, the current iteration of Zia will try to answer a question and unless you have "transfer to SalesIQ chat" enabled, it won't create a ticket for the user or offer them a method to create a ticket. We don't want it to create chats for us,meassure leads phases
Hi, I need to create a table to meassure the time that a lead stay in blueprint phases. the phases are first contact, second contact, lead spam, contacted, appointment. any idea? I have attached an exampleZoho Desk API Documentation missing a required field
We are trying to create a section using this information. Even after preparing everything based on that page, we still get an error. The error we get is this: {"errorCode":"INVALID_DATA","message":"The data is invalid due to validation restrictions","errors":[{"fieldName":"/translations","errorType":"missing","errorMessage":""}]}In the Custom Module I have 500 Records , this 500 record only want to view to the specific user only example user A ,
In the Custom Module, I have 500 Old records that should only be visible to a specific user, for example, User A. Any new records created from today onwards should be visible to Record owner in the Custom Module. Pls help how i achive this .Invoice template, how to change the text under "Notes" and "Terms and Conditions"
In "Invoice templates", there are two text/info sections at the bottom:"Notes" and "Terms and Conditions". It is possible to change the names of these two headings, but how is it possible to change/alter the text under it. As a standard it says "Thank you for your business" under Notes - I need to change it into something different- How? Thank you.How to reply to thread via API
We have built a webapp for our customers that uses the Zoho Desk API to enable each customer to view their full list of tickets, view individual tickets and raise new tickets. The Zoho Desk API doesn't have the ability to reply to a ticket/thread. RepliesNext Page