Kaizen #66 - Contact Roles #API

Kaizen #66 - Contact Roles #API

Hi everyone! Welcome to another Kaizen week!!
This week, we will be discussing the Contact Roles APIs in Zoho CRM.

What are Contact Roles in Zoho CRM?

      The Contact Roles related list is a powerful feature in Zoho CRM that allows you to define the role of a contact in a deal, and to associate multiple contacts with a Deal.
      The Contact Roles lets you track and manage various contacts within a prospective organization, and understand their roles to have targeted and effective discussions. For example, when you schedule a meeting with the head of the department, it is important to explain the product features and functionalities, but it is imperative to discuss the cost-saving benefits with a financial manager. Likewise, you can choose to address the product features with a product manager, present technical specifications to an IT manager, or review legal or compliance considerations with a legal manager. With Contact roles, you can thus have the most relevant and productive discussions as you work on a deal.
There are a few Contact Roles like Decision Maker, Product Management, Purchasing etc that are available by default. You can also customize them according to the specific business requirements. 

1. Retrieving Contact Roles via API

Using the Get Contact Roles API, you can get the list of contact roles configured in your organization.

Request method : GET
Request URL to retrieve all Contact Roles : {api-domain}/crm/{version}/Contacts/roles
Request URL to retrieve a specific Contact Role : {api-domain}/crm/{version}/Contacts/roles/{contact_role_id}

Sample Request and Response


Response Keys

 Key
 Description
 sequence_number
 Position of the contact role in the picklist in CRM UI
 name
 Name of the contact role
 id
 Unique ID of the contact role

2. Adding new Contact Roles via API

      Using the Insert Contact Roles API you can create a new contact role to fit your business need. For example, you are working on a deal and have been in touch with several contacts throughout the sales process. As you near the end of the negotiation, you start talking to the legal department of the prospective organization to finalize the terms of the contract. You might want to add the legal manager as a contact role, and associate the respective contact with the role.
You can add up to 100 contact roles in a single API call.

Request method : POST
Request URL : {api-domain}/crm/{version}/Contacts/roles

Input Keys

 Key
 Description
 name
 string, mandatory
 The name of the contact role
 sequence_number
 integer, optional
 The position of the contact role in the picklist in CRM UI

Sample Request and Response



If you add a new contact role in Zoho CRM to a position that is already occupied, the existing contact role will be moved down one position to make room for the new role.

3. Updating Contact Roles via API

You can update the name and sequence number of up to 100 contact roles using the Update Contact Roles API.

Request method : PUT
Request URL to update more than one Contact Role : {api-domain}/crm/{version}/Contacts/roles
Request URL to update a specific Contact Role : {api-domain}/crm/{version}/Contacts/roles/{contact_role_id}

Input Keys

 Key Description
 id
 string, mandatory
 U​​nique ID of the contact role.
 This key is mandatory if you have not specified the id in the URL.
 name
 string, optional
 Name of the contact role
 sequence_number
 integer, optional
 The position of the contact role in the picklist in CRM UI

Sample Request and Response


4. Deleting Contact Roles via API

If a contact role is no longer relevant, you may need to delete that contact role from your organization. 

Request method : DELETE
Request URL to delete more than one Contact Role : {api-domain}/crm/{version}/Contacts/roles?ids={contact_role_id1,contact_role_id2,..}
Request URL to delete a specific Contact Role : {api-domain}/crm/{version}/Contacts/roles/{contact_role_id}

To delete multiple contact roles in a single API call, you must include the ids parameter. The API allows you to delete up to 100 contact roles at a time.

Sample Request and Response



Now that we have learnt how to create, fetch, update and delete contact roles, let us see how to associate a contact role with a deal. 

5. Associate Contact Role with a Deal

      You can add a contact to a deal and associate the same with a contact role. You can add only one contact role to the deal in a single API call. 
      Consider a scenario where you are working on a deal with a medium-sized company and have been in contact with the company's sales manager throughout the sales process. Towards the end, you would need to speak with the company's legal advisor to review the contract terms and compliance considerations. You can use the contact roles feature, and associate the contact with the deal. 

Request method : PUT
Request URL : {api-domain}/crm/{version}/Deals/{deal_id}/Contact_Roles/{contact_id}

Input Keys

 Key Description
 id
 string, mandatory if name is not specified
 Unique ID of the contact role.
 name
 string, mandatory if id is not specified
 Name of the contact role

You must specify either the name or the id, or both in the input body. 

Sample Request and Response



6. Fetch Contact Roles of a specific Deal via API

      If you are working on a deal with a large enterprise, you may be in contact with several individuals throughout the sales process. As the deal nears closure, you may want to review all contact roles to ensure you have covered all necessary discussions and are aligned with the right people. You can use this API to fetch all contact roles associated with the Deal for assistance with the review.

Request method : GET
Request URL to get all Contact Roles associated with the Deal : {api-domain}/crm/{version}/Deals/{deal_id}/Contact_Roles
Request URL to get a specific contact role associated with the Deal : {api-domain}/crm/{version}/Deals/{deal_id}/Contact_Roles/{contact_id}
Request URL to get multiple contact roles associated with the Deal : {api-domain}/crm/{version}/Deals/{deal_id}/Contact_Roles?ids={contact_id1,contact_id2,...}

Sample Request and Response


7. Removing a contact role from a deal

      As you progress through the sales process, one of the stakeholders may no longer be involved in the deal. In this case, you may want to delete this contact role from the deal to ensure that you are only working with the relevant set of stakeholders.  Using the API, you can remove up to 100 contact roles from a specific deal.

Request method : DELETE
Request URL : {api-domain}/crm/{version}/Deals/{deal_id}/Contact_Roles/{contact_id}
Request URL to remove more than one contact role from a Deal : {api-domain}/crm/{version}/Deals/{deal_id}/Contact_Roles?ids={contact1,contact2,..}

Sample Request and Response



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. 

We will be back next year with more interesting topics. Wishing you a Happy New Year!

    Access your files securely from anywhere









                          Zoho Developer Community




                                                • Desk Community Learning Series


                                                • Digest


                                                • Functions


                                                • Meetups


                                                • Kbase


                                                • Resources


                                                • Glossary


                                                • Desk Marketplace


                                                • MVP Corner


                                                • Word of the Day


                                                • Ask the Experts





                                                          Manage your brands on social media



                                                                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

                                                                                    • CRM Community Learning Series

                                                                                      CRM Community Learning Series


                                                                                    • Kaizen

                                                                                      Kaizen

                                                                                    • 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


                                                                                          Zoho Show Resources

                                                                                            Zoho Writer

                                                                                            Get Started. Write Away!

                                                                                            Writer is a powerful online word processor, designed for collaborative work.

                                                                                              Zoho CRM コンテンツ






                                                                                                Nederlandse Hulpbronnen


                                                                                                    ご検討中の方




                                                                                                          • Recent Topics

                                                                                                          • Taz bot not working — What should I do to resolve this issue?

                                                                                                            I am experiencing issues with the Taz bot in Zoho Cliq—not receiving responses or it does not seem to work as expected. Could you please explain why the Taz bot might not be functioning and what steps I should take to resolve this issue? Thank you!
                                                                                                          • OneNote Migration

                                                                                                            I am trying to migrate two notebooks from OneNote. For five days now I have had no notification that migration has completed and the migration page show 50% complete - one notebook completed one not finished. It just stays like this. I am unable to cancel
                                                                                                          • Set various time slot reminders for task and event

                                                                                                            Hi I would like known if there is possibility to set various time reminders for a task or event like we have the possibility to do in google calendar or google task. For example I'am creating an event or task and I want to be alerted before 30min and
                                                                                                          • Zoho Calendar not functioning---cannot edit, add attendees, etc.

                                                                                                            Hello, My calendar is acting strange. I'm using Chrome as my browser and pop ups are not blocked (the calendar worked fine yesterday). When creating an event, I'm not able to "edit" the event and add attendees, etc. The link is non-responsive. I cannot
                                                                                                          • Spilt Axis for stacked column and line graph

                                                                                                            Each month around this time I prepare a business review deck. One of the biggest annoyances I have with Zoho, also happens to be something that most other platforms have provided for a long time now, and that is being able to create a chart with stacked
                                                                                                          • Pin a note on top

                                                                                                            Dear Zoho Notebook Team, Please highly consider adding ability to pin a note on top and arrange pinned notes. I have a lot of notes that I want to pin important ones on top and this feature is missing badly. Thank you.
                                                                                                          • Windows 11 app ver 2.2.8

                                                                                                            I have been trialing Zoho Notes syncing between my PC and iphone. No problems with iphone but the Windows 64 bit app ver 2.2.8 was very buggy and would lock up completely, needing a Control Alt Delete etc to close it down. It seemed to be connected to
                                                                                                          • Deluge Script: Onboarding → Access Form

                                                                                                            Hello everyone, Edit: Sorry, I think I put this topic in the wrong section. I’ve recently run into an issue that’s been giving me a bit of a headache for the past few weeks. Context: This is my first time using Deluge to create a script, but it’s not
                                                                                                          • Windows Device Authentication

                                                                                                            We have recently started using ManageEngine, and my boss saw a device management feature in the Zoho One directory. We thought it would either help give us more intergration into Zoho one through bringing ManageEngine services through Zoho one. Or, it
                                                                                                          • How can I change spell check language?

                                                                                                            I cannot find the way to change spell check language. My "display language" is English, and I want to have the same one for Spell Check, but it is Russian!!! How can I change it? In one of your explanations you mentioned that I have to choose it from
                                                                                                          • Mail is so slow - doesn't even work!

                                                                                                            Mail has been getting slower and slower - and today it's not even pulling up emails in either Inbox or Unread. This is beyond frustrating since email is a big part of business. Sent a request through the useless help portal - no response. Called the useless
                                                                                                          • User marked as SPAMMER. Mail Fetch has also been disabled for any active POP accounts.

                                                                                                            I am the administrator for joelles.com One of our accounts has been blocked saying this: User marked as SPAMMER. Mail Fetch has also been disabled for any active POP accounts. I cannot change the disabled account in the control panel as it says that it
                                                                                                          • My domain did not activate

                                                                                                            Hi, my domain (apsaindustrial.com.ar) did not activate, and the phone verification message never arrived. Please would you solve this problem? Thanks.
                                                                                                          • ME SALE ESTE ERROR: No fue posible enviar el mensaje;Motivo:554 5.1.8 Email Outgoing Blocked

                                                                                                            Ayuda!! Me sale este error al intentar enviar mensajes desde mi correo electronico de Zoho! Tampoco recibo correos pues cuando me envia rebotan. Ayuda, Me urge enviar unos correo importantes!! Quedo atenta MAGDA HERNANDEZ +5731120888408
                                                                                                          • Is there a way to sync Tags between CRM and Campaigns/Marketing Hub?

                                                                                                            I wonder if there is a way to synch the tags between CRM and Marketing-Hub / Campaigns?
                                                                                                          • how to see if a specific contact opened an email in zoho campaign?

                                                                                                            how to see if a specific contact opened an email in zoho campaign?
                                                                                                          • Revenue Management: #8 Revenue Recognition in Educational & Training Institutions

                                                                                                            Educational Institutions and training centres typically collect course fees at the time of enrolment, sometimes for a one-day workshop and sometimes for a year-long certification course. You might also charge separately for course materials or evaluation.
                                                                                                          • How to Customize Task Creation to Send a Custom Alert Using JavaScript in Zoho CRM?

                                                                                                            Hello Zoho CRM Community, I’m looking to customize Zoho CRM to send a custom alert whenever a task is created. I understand that Zoho CRM supports client scripts using JavaScript, and I would like to leverage this feature to implement the alert functionality.
                                                                                                          • Using files from Zoho CRM in Gemini/ChatGPT/Claude

                                                                                                            Hi all, I’ve got subscriptions to Gemini and a few other AI tools which I use for tasks like data enrichment, email composition, etc. In our workflow, we often receive various documents from clients — such as process workflows, BRDs/requirement documents
                                                                                                          • Maximum file limit in zoho people LMS

                                                                                                            Dear Team, I am having approximately 4.9 GB of material, including PPTs and videos for uploading in zoho people LMS course. May I know what is the maximum limit limit for the course files Thanking you, With regards, Logeswar V Executive _ Operations
                                                                                                          • Dynamically prefill ticket fields

                                                                                                            Hello, I am using Zoho Desk to collect tickets of our clients about orders they placed on our website. I would like to be able to prefill two tickets fields dynamically, in this case a readonly field for the order id, and a hidden field for the seller
                                                                                                          • Optimize your Knowledge Base for better visibility by allowing search engine crawling and indexing

                                                                                                            All you need to know about no-follow and no-index in KB. What are article crawlability and indexability? Crawlability and indexability are vital for making an article visible and accessible to search engines. When a search engine crawls an article, it
                                                                                                          • Has anyone created a public ASAP Guide that I can check out?

                                                                                                            I am thinking of adding an ASAP guide to my web application, but I have noticed that the ASAP widget itself can be really slow to load sometimes. Has anyone created a public ASAP Guide that I can check to see how performant it is? I don't want to spend
                                                                                                          • Zoho Desk Partners with Microsoft's M365 Copilot for seamless customer service experiences

                                                                                                            Hello Zoho Desk users, We are happy to announce that Zoho Desk has partnered with Microsoft's M365 to empower customer service teams with enhanced capabilities and seamless experiences for agents. Microsoft announced their partnership during their keynote
                                                                                                          • What’s New in Zoho Analytics – September 2025

                                                                                                            Hello Users!! In this month’s update, we’re raising the bar across multiple touchpoints, from how you bring in data, plan and track projects to how you design and brand your dashboards. We’ve added the all-new Gantt chart for project visualization, expanded
                                                                                                          • Zoho MCP has no tools for Creator or 3rd Party Apps?

                                                                                                            I don't see a Zoho MCP community forum so putting this here. Two big problems I see: 1) Although Zoho advertises "over 950 3rd party apps" as available through their MCP, when I go to "Add Tools" there are ZERO 3rd party apps available to choose from.
                                                                                                          • Zoho Forms - Zoho Drive connection - Shared Drives not supported

                                                                                                            Hello i am stuck with Google Drive Connection There is no supported shared drives Connection is not support shared drives boolean Query Parameters - supportsAllDrives=true&supportsTeamDrives=true to activate fetch files from the shared drives. Ahat need
                                                                                                          • Can't create package until Bill created?

                                                                                                            I can't understand why we cannot create a package until a Bill is created? We are having to created draft Bills to create a package when the item is received, but we may not have received a Bill from the supplier. Also, Bill # is required, but we normally
                                                                                                          • Whats the Time out Limit for API Calls from Deluge?

                                                                                                            Hi Creator Devs, We are making API calls to third party server via Deluge. Getting this error message: Error at line : 24, The task has been terminated since the API call is taking too long to respond. Please try again after sometime. Whats the default
                                                                                                          • How to get the authorization code for domain transfer from Zoho?

                                                                                                            I have transferred my domain from zoho to godaddy, and that needs a authorization code. I haven't got any mail containing that. How to get the authorization code from domain transfer? Thanks, Arun
                                                                                                          • How can I optimize a Zoho Site page for SEO when embedding external menu or restaurant links?

                                                                                                            Hi everyone, I’m experimenting with building small content hubs on Zoho Sites and want to make sure I’m doing it in an SEO-friendly way. For example, I tried creating a page that highlights restaurant menu items and linked out to a resource like this:
                                                                                                          • Diff signature for compose new email and replies

                                                                                                            Hi,   How do i have different signature for replies and new emails. its inconvenient to have one large signature for replies. Usually on Outlook we have the option to keep separate signatures for new emails and for replies.
                                                                                                          • Zoho Website Site Speed Up & Setting

                                                                                                            We are experiencing slow loading speeds on our Zoho website and would like assistance in optimizing its performance. Kindly review the site and suggest or implement necessary improvements to enhance speed, especially related to: > Caching mechanisms >
                                                                                                          • Clickjacking: Zoho Vault's Response

                                                                                                            Issue: Password manager browser extensions are found to be vulnerable to clickjacking security vulnerabilities that could allow attackers to steal account credentials, TFA codes, and card details under certain conditions. Reported by: Marek Toth, Independent
                                                                                                          • No option for pick up in Zoho Books / Inventory but yes on commerce

                                                                                                            Is it planned to release soon on books/inventory?
                                                                                                          • Accessing Zoho form enteries via API

                                                                                                            Hi As a user I can view enteries to a form at: https://forms.zoho.com/<myOrganisation>/report/<myReportName>/records/web How do I access these entries via API? I don't have any problem with scope and getting tokens. But I have no idea what the API call
                                                                                                          • Blueprint Issue - Being able to set a subform field as mandatory

                                                                                                            I'm creating a blueprint. My record involves a subform which is only shown once field is set but the field gets set in step two of the process. My problem - I can't save the record as the subform field is set to mandatory - If I unset the mandatory field,
                                                                                                          • Blueprint - Mandatory file upload field

                                                                                                            Hi, File upload (as we as image upload) field cannot be set as mandatory during a blueprint transition. Is there a workaround? Setting attachments as mandatory doesn't solve this need as we have no control over which attachments are added, nor can we
                                                                                                          • Zoho Books - Include Quote Status in Workflow Field Triggers

                                                                                                            Hi Zoho Books team, I recently tried to create a Workflow rule based on when a Quote is Accepted by the customer. This is something which I thought would be very easy to do, however I discovered that Status is not listed as a field which can be monitored
                                                                                                          • Zoho Books - Show Related Sales Orders on Quotes

                                                                                                            Hi Books team, I've noticed that the Quotes don't show show the related Sales Order. My feature request is to also show related Sales Orders above the Quote so it's easy to follow the thread of records in the sales and fulfilment process. Below screenshot
                                                                                                          • Next Page