Skip to product menu
close
  • Sales
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

Rest APIs

A REST API defines a set of functions using which the developers can perform requests and receive responses via the HTTP protocols such as GET and POST.

Server URI

SalesIQ offers the following server URI. Choose the server URI based on your data center.

Data Center  ZohoSalesIQ_Server_URI  ZohoAccounts_Server_URI  Developer Console
US
(United States)
salesiq.zoho.comaccounts.zoho.comapi-console.zoho.com
EU
(Europe)
salesiq.zoho.euaccounts.zoho.euapi-console.zoho.eu
IN
(India)
salesiq.zoho.inaccounts.zoho.inapi-console.zoho.in
AU
(Australia)
salesiq.zoho.com.auaccounts.zoho.com.auapi-console.zoho.com.au
CN
(China)
salesiq.zoho.com.cnaccounts.zoho.com.cnapi-console.zoho.com.cn
JP
(Japan)
salesiq.zoho.jpaccounts.zoho.jpapi-console.zoho.jp

What is the Screen name?

The unique name provided to your SalesIQ portal is known as the Screen name.

Example: https://salesiq.zoho.com/zylker/index

What is the response format?

The response format is how you get the answer from the respondent. Both the success and the error responses hold the status code as 200.

Success Response Format

If the request is successful, the response object contains a key "data" that holds the result of the request.

  • url : request URL
  • object : list or resource object type
  • data : String or array or object
  • sync_time : request current time (Only to GET Resouce list APIs)

Example

{
      "data" : <value - string, array or object> ,
      "url":<value - string> ,
      "object": < value - string>
}

 

Error Response Format:

In case of errors, the response object contains a key "error" which contains information about the error. The error object might contain keys such as the "code" (unique error code), and the "message" (description of the error), and you might also get one of these optional keys (json_key or param or header) in your error response. Use them to identify and resolve your error.

Example

{
  "error" :
  {
    "message":"Invalid URL",
    "code":1006,
    "json_key":<value - string>, // Optional key
    "param":<value - string>, // Optional key
    "header":<value - string> // Optional key
  }
}​​​

 

Basic Authorization Errors

1. General Error (Code: 1001 )

Message: "Unknown authentication error. Contact SalesIQ Team!"

This type of response occurs in case of internal server error (i.e., due to problems in the server while retrieving the data.)


2. Invalid Header Error (Code: 1002)

Message: "Invalid authorization header."

This error occurs when either the Authorization header is absent or is not set properly.


3. Invalid Header Value (Code: 1054)

Message: "Invalid header value"
Header: <header-name>

This error occurs when the request header value is not valid. (For ex, If an API accepts JSON input, the request header "content-type" should be "application/json"). If your error is related to the "content-type" header, you can refer to the following:

Valid content-type request header values:

  • For JSON input APIs - application/json
  • For form input APIs - application/x-www-form-urlencoded

3. Invalid Request Type Error (Code: 1004)

Message: "Invalid Request Type."

The invalid request type error occurs when the request method is incorrect (For ex : If you have sent a Post request instead of a Get URL request.)


4. Invalid Portal Error (Code: 1005)

Message: "Invalid portal or wrong screen name."

This type of error occurs when the user portal is invalid (i.e., If the user Portal is not valid or the provided screen name is wrong.)


5. Invalid URL error (Code: 1006)

Message: "Invalid URL"

This kind of error occurs if the requested URL is incorrect. For example, "https://zylker.com/api/" - is the wrong URL because the screen name is missing in the provided URL.


6. Invalid Data Type (Code: 1007)

Message: Invalid datatypes found in params,
param: <Invalid-param-name>, //Optional key
json_key: <Invalid-json-key> //Optional key

The error is sent when the data type of a parameter sent does not comply with the mentioned one. You might get one of these optional keys (json_key or param) in your error response. Use them to identify and resolve your error.


7. Invalid OAuthToken (Code 1008)

Message: Invalid OAuthToken.

This kind of error occurs if the OAuthToken is incorrect.


8. Invalid OAuthScope (Code: 1009)

Message: Invalid OAuthScope.

This kind of error occurs if the OAuthScope is invalid.


9. Invalid Method (Code: 1010)

Message: Invalid Method.

This kind of error occurs if the mentioned method is invalid.


10. Invalid Params (Code 1011)

Message: Either the request parameters are invalid or absent,
param: <Invalid-param-name> //Optional key

This kind of error occurs if the provided param is invalid or not present.


11. Invalid Inputstream (Code: 1015)

Message: Either the input stream is invalid or absent,
json_key: <Invalid-json-key> //Optional key

This kind of error occurs if the provided input stream is invalid or is not present.


General Errors

1. Resource Already Exists (Code: 1014)

Message: "Resource already exists"

This type of response occurs in case if the provided resource details already exist.


2. Permission Denied (Code: 1016)

Message: "Operator doesn't have permission to perform the operation"

This type of error occurs when the operator doesn't have access to perform the operation based on their role (Associate, Supervisor, Administrator).


3. Limit Exceeded (Code: 1017)

Message: "Resource limit reached for current plan"

This type of error occurs when the resource limit has been exceeded. This is based on their current Zoho SalesIQ purchase plan.


4. Empty File (Code: 1018)

Message: "File is empty"

This type of error occurs when the file sent doesn't contain any data.


5. Invalid Resource (Code: 1019)

Message: "Invalid Resource"

This kind of error occurs if the requested resource is not valid.


6. Invalid Operator (Code: 1020)

Message: Invalid operator

This type of error occurs when the requested operator does not belong to the portal.


7. Upgrade Needed (Code: 1021)

Message: Operation is not available in the current plan

This kind of error occurs if your current plan does not support the requested action.


8. Remote IP Locked (Code: 1023)

Message: Too many requests, lease try after sometime

This kind of error occurs if too many actions are performed at the same time and the IP is blocked from performing any action for a while.


9. Invalid Operator IDs (Code: 1024)

Message: Invalid Operator id/s

This kind of error occurs if the requested operator ID is not valid.


10. Invalid Department IDs (Code: 1025)

Message: Invalid Department IDs

This kind of error occurs if the requested department ID is not valid or is not present.


11. Last Available Resource (Code: 1026)

Message: Last available resource

This kind of error occurs if you are about to delete the last available resource in the portal. (For ex, If your portal has one department and you are about to delete that department, then this error will occur.)


12. File Size Exceeded (Code: 1027)

Message: File size is greater than the allowed size

This kind of error occurs if the file size is greater than the allowed size.


13. Invalid File Type (Code: 1028)

Message: Invalid file type

This kind of error occurs if the file type is not valid.


14. Invalid Filters (Code: 1029)

Message: Invalid Filter

This kind of error occurs if the filter you have applied is not valid.


15. Insufficient Data (Code: 1031)

Message: Insufficient data  
This kind of error occurs if the given data is insufficient to perform the action.

New Key Details

  • If your input JSON key is invalid, you will get "json_key" in your error response.
Example:
 {
 "department":{
    "status":012345
  },
  "app_ids":["app", 123456789],
  "operators":[
    {
      "name":"agent 1"
    },
    {
      "name":"$#!@%^"
    }
  ]
}

 

Note:

ScenarioSyntaxExample
If an invalid value is present inside JSONObject<parent-key>.<child-key>department.status
If an invalid value is present inside JSONArray<key>[<index>]app_ids[0]
If an invalid value is present inside an array of JSONObject<parent-key>[<index>].<child-key>operators[1].name
  • If your query param or form input is invalid, you will find the "param" key in your error response.
  • You will find the "header" key in your error response if your request header is invalid.