Zoho SalesIQ REST API: Authentication and Common Errors

Zoho SalesIQ REST API v2

Zoho SalesIQ's REST APIs let third-party applications connect with your SalesIQ portal to read and manage data such as operators, conversations, feedback, and articles. Two versions are currently documented, v2 being the current one to build against.

Authentication with OAuth 2.0

The REST API uses OAuth 2.0 rather than a static API key, avoiding the need to ask for or store a username and password directly.

  1. Register your application. In the Zoho Developer Console's API Credentials page, click Add Client ID, and provide your Client Name, Client Domain, and Authorized Redirect URI.
  2. Receive your credentials. You'll be issued a Client ID and Client Secret, known to both Zoho and your application.
  3. Direct the user to authorise. Send the user to Zoho's authorisation URL with your client ID, requested scopes, and redirect URI. If they accept, Zoho redirects back to your site with an authorisation code in the URL.
  4. Exchange the code for tokens. Your application requests an access token using that code, receiving both an access token and, if you included access_type=offline in the original request, a refresh token to generate new access tokens later without the user re-authorising.
Note: You can force a user to re-authorise on every login by adding a prompt=consent parameter to the authorisation request, useful if you don't want a stored refresh token to silently persist access.

Scopes

Access is controlled by scopes specific to each resource and operation, such as SalesIQ.operators.UPDATE or SalesIQ.visitorroutingrules.UPDATE, so a token only grants the exact permissions your integration actually needs, rather than blanket access to the whole portal.

Common error responses

  • Invalid portal. The screen name provided doesn't match a valid portal.
  • Resource limit exceeded. You've hit a limit tied to your current Zoho SalesIQ plan.
  • Operation not available in current plan. The requested action requires a higher plan than you currently have.
  • Too many requests. Your IP has been temporarily blocked after too many actions in a short period.
Need help? 1 Cloud Consultants can help you build authenticated integrations against the Zoho SalesIQ REST API. Book a discovery call with 1 Cloud Consultants.

    • Related Articles

    • Zoho SalesIQ Workflows

      SalesIQ Workflows let you react automatically to events happening inside your portal, triggering an action the moment a specific event occurs and matches your configured rules. Modules you can build workflows around Workflows can track changes across ...

    • Zoho SalesIQ: Lead Score

      Lead Score is a score visitors earn based on their activity during a visit to your website. Setting rules to score visitors based on their actions gives you a clear, automated way to understand who's genuinely interested and who's just browsing, ...

    • Zoho SalesIQ: Tracking Reports

      The Reports module in Zoho SalesIQ gives you a complete overview of your live chat operation, covering both visitor behaviour and operator performance, accessible from Reports in the left-hand navigation. The Four Sections Overview. A dashboard ...

    • Zoho SalesIQ JavaScript APIs

      Zoho SalesIQ's JavaScript APIs let you customise chat widget behaviour beyond what the standard dashboard settings offer, giving developers fine-grained control over the visitor experience. How to use them Pick the JavaScript API you need and paste ...

    • Zoho SalesIQ FAQs

      This covers the most common questions about Zoho SalesIQ, grouped by administrator setup, day-to-day operator use, and chatbots. Administrator questions What is Zoho SalesIQ, and who uses it? Zoho SalesIQ is a live chat and visitor analytics platform ...