How to retrieve ZIA next best experience in Zoho CRM

Zia's Next Best Experience (NBX) feature in Zoho CRM surfaces context-aware, AI-driven action recommendations for a given record — and you can retrieve those suggestions programmatically via a dedicated API endpoint.

Why this matters

Sales teams working with large pipelines need timely, intelligent guidance on which action to take next for each opportunity or lead. Rather than manually surfacing NBX suggestions inside the CRM UI, developers and integration builders can call the NBX endpoint directly to embed those recommendations into external dashboards, automation workflows, or custom applications. This is especially useful when you want to trigger guided selling logic outside the standard Zoho CRM interface.

Step-by-step

Step 1. Understand what the endpoint returns.

The Zia NBX API retrieves the next best experience recommendation for a specific CRM record. Zia analyses every relevant touchpoint — interactions, signals, and transactions — to produce actionable, context-aware suggestions that help you nurture leads, retain customers, and optimise your pipeline. ^[2]

Step 2. Identify the two required path parameters.

The endpoint requires exactly two parameters: m (the module name, e.g. Leads, Contacts, Deals) and rid (the unique record ID within that module). Both are positional segments in the URL path. ^[5]

Step 3. Construct the HTTP request.

Issue an HTTP GET request to the following path pattern:

GET /{m}/{rid}/zia/nbe

Replace {m} with the target module's API name and {rid} with the record's ID. For example, to retrieve NBX data for a Deal record, your path would look like:

GET /Deals/4876XXXXXXXXX/zia/nbe

^[5]

Step 4. Call the operation using the SDK helper (if applicable).

If you are using the Zoho CRM Python client or a zpilot-based integration layer, the operation is exposed as getzianextbestexperience. Pass the module name as the first argument (m) and the record ID as the second (rid): [^1, ^5]

result = client.get_zia_next_best_experience(m="Deals", rid="4876XXXXXXXXX")

The method internally fires the GET /{m}/{rid}/zia/nbe request and returns the parsed response. ^[5]

Step 5. Interpret the response in context.

The NBX payload will contain Zia's recommended actions for that record. These suggestions are grounded in the full history of record touchpoints, so the richer the data in your CRM (emails, calls, transactions, signals), the more precise the recommendation will be. ^[2]

Step 6. Optionally surface NBX via custom buttons in the UI.

If you prefer a no-code approach, Zoho CRM also allows you to associate prompts with custom buttons. When a user clicks the button on a record, Zia executes the associated prompt and returns output that is contextual to that specific CRM record — effectively giving you an in-UI version of the NBX experience without writing API calls. ^[2]

Common pitfalls

• Wrong module API name: The m parameter must match the exact API name of the module (e.g. Leads not Lead, Deals not Deal). A mismatch will result in a failed request. ^[5]
• Invalid or inaccessible record ID: If rid does not correspond to a record the authenticated user can access, the API will return an error. Always confirm the record exists and that your OAuth token has the appropriate CRM scope. ^[5]
• Insufficient data for recommendations: NBX quality depends on the volume and variety of touchpoints logged against the record. Records with sparse activity may return limited or no suggestions. Ensuring interactions, signals, and transactions are consistently captured will improve output quality. ^[2]

What to check

• Confirm that the m value matches the exact API name of the target module and that rid is a valid, accessible record identifier before making the call. ^[5]
• Verify that your Zoho CRM OAuth token carries the necessary Zia/AI permissions, as NBX is an AI-powered feature that may require specific scopes to be enabled. ^[1]
• After receiving the response, cross-reference the suggested action against the record's current stage in the pipeline to ensure the recommendation aligns with your expected guided-selling logic. ^[2]

---

*Beam Help is an independent expert support resource for Zoho products and is not official Zoho support. Always validate API behaviour against your specific Zoho CRM edition and plan, as feature availability may vary.*