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

Recent Launches

New

Payroll software with automated tax payments and filing.

Try now
New

Robotic process automation software to automate high-volume, rule-based tasks.

Try for free
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Privacy-friendly application analytics solution.

Try for free

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
 
NEW
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
 
NEW
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
 
NEW
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

GDPR Compliance

GDPR is a comprehensive set of rules that will replace the existing Data protection directive or Directive 95/46/EC, which will be enforced across the EU. It is designed to empower EU citizens by putting them directly in control of how they want their data to be processed and protect their data privacy due to the increasingly complex nature of personal data transmission across the world.

Note:
  • The content presented herein is not to be construed as legal advice. Please contact your legal advisor to know how GDPR impacts your organization and what you need to do to comply with the GDPR.

  • The following changes to the API are applicable only for modules which have GDPR Compliance enabled.

Organization API

A new key privacy_settings is added in the Organization API. The data type of this field is boolean, i.e true/false.

Sample Request: To get Organization Data

Copiedcurl "https://www.zohoapis.com/crm/v3/org"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Note:

  • If privacy_settings=true, GDPR Compliance is enabled for the Org.
  • If privacy_settings=false, GDPR Compliance is disabled.

Sample Response

Copied{
    "org": [
       {
            "country": "US",
            "mc_status": false,
            "gapps_enabled": false,
            "id": "111111000000033001",
            "state": null,
            "employee_count": "154",
            "website": "www.zylker.com",
            "currency_symbol": "$",
            "mobile": null,
            "currency_locale": "en_US",
            "primary_zuid": "5478235",
            "zgid": "5478236",
            "country_code": "US",
            "license_details": {
                "paid_expiry": null,
                "users_license_purchased": 3,
                "trial_type": "professional",
                "trial_expiry": "2018-05-17T17:20:05+05:30",
                "paid": false,
                "paid_type": "free"
            },
            "company_name": null,
            "privacy_settings": true,
            "primary_email": "p.boyle@zylker.com",
            "iso_code": "USD"
        }
    ]
}

Show full

Show less

Fields API

A new field in CRM named Data Processing Basis Details will carry the lawful data processing basis for the particular record. You can determine the values in this field based on how you want to process your customer's data.

Currently, this field is supported only in Leads, Contacts, Vendors, and Custom Modules.

A new key named private is added to the APIs, to mark the field as a protected field. The value of the key is either a JSON Object or null.

Fields can be set to be private by enabling the option in the Layout editor. If the user creates a protected field but does not select the sensitivity of the data(sensitive/normal), then the private key is null.

Sample Request: To get Fields Metadata

Copiedcurl "https://www.zohoapis.com/crm/v3/settings/fields?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v3/settings/fields?module=Leads"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

The type attribute can be either High or Low, based on the sensitivity of the data. Once the privacy settings is enabled for the Org, the private field value to be shown in records GET API will be based on the Preferences settings.

The High and Low values correspond to the Sensitive and Normal values as in the Personal Fields in the CRM UI.

If restricted in the private key is true, then the values of a field will not be exposed in any record related APIs.

Sample Response: Field Metadata for Data Processing Basis Field

Copied{
    "custom_field": false,
    "lookup": {},
    "private": null,
    "visible": true,
    "webhook": true,
    "json_type": "jsonobject",
    "crypt": null,
    "field_label": "Data Processing Basis Details",
    "length": 100,
    "tooltip": null,
    "view_type": {
        "view": true,
        "edit": true,
        "quick_create": false,
        "create": true
    },
    "created_source": "default",
    "read_only": false,
    "api_name": "Data_Processing_Basis_Details",
    "unique": {},
    "businesscard_supported": true,
    "data_type": "consent_lookup",
    "formula": {},
    "currency": {},
    "id": "111111000000032030",
    "decimal_place": null,
    "pick_list_values": [],
    "multiselectlookup": {},
    "auto_number": {}
}

Show full

Show less

Records API - INSERT

When Inserting or adding a record, the Data Processing Basis Details key must be given in the POST request. This new key contains the details of the consent form that is accepted by a customer. In another sense, within a request, this key can be used to add consent details to a particular record.

The values in this key are in the form of a JSON Object.

Sample request: To insert a record in Leads module

Copiedcurl "https://www.zohoapis.com/crm/v3/Leads"
-X POST
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedSyntax:
zoho.crm.bulkCreate(,,,,);
mandatory : module,dataList

Sample Request:
resp = zoho.crm.bulkCreate("Price_Books", [{"Owner": {"id": "7000000031553"},"Active": true,"Pricing_Details": [{"to_range": 5,"discount": 0,"from_range": 1},{"to_range": 11,"discount": 1,"from_range": 6},{"to_range": 17,"discount": 2,"from_range": 12},{"to_range": 23,"discount": 3,"from_range": 18},{"to_range": 29,"discount": 4,"from_range": 24}],"Pricing_Model": "Differential","Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.","Price_Book_Name": "Price_Book_Name oops1"},{"Owner": {"id": "7000000031553"},"Active": true,"Pricing_Details": [{"to_range": 5,"discount": 0,"from_range": 1},{"to_range": 11,"discount": 1,"from_range": 6},{"to_range": 17,"discount": 2,"from_range": 12},{"to_range": 23,"discount": 3,"from_range": 18},{"to_range": 29,"discount": 4,"from_range": 24}],"Pricing_Model": "Differential","Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.","Price_Book_Name": "Price_Book_Name oops2"}]);
  • The same request pattern is to be followed for Update and Upsert records APIs.
  • If the Data Processing Basis Details are not specified when inserting a record, Data_Processing_Basis_Details key becomes null.

Sample Input: To insert a record in Leads module

Copied{
    "data": [
       {
            "Last_Name": "Boyle",
            "Email": "p.boyle@zylker.com",
            "Data_Processing_Basis_Details": {
                "Contact_Through_Email": true,
                "Contact_Through_Social": true,
                "Consent_Through": "Email",
                "Contact_Through_Survey": true,
                "Data_Processing_Basis": "Consent - Obtained",
                "Contact_Through_Phone": true,
                "Consent_Date": "2018-04-18",
                "Consent_Remarks": "fgvhbjnm"
            }
        }
    ]
}

Records API - GET

This API retrieves all the data of a record along with the Consent Details. In "Sample Request: To get a record from Leads module", the Email field is marked as a private field. Hence, the value of the field becomes null.

Sample Request: To get a record from Leads module

Copiedcurl "https://www.zohoapis.com/crm/v3/Leads/111111000000034001?include=private_fields"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedSyntax:
zoho.crm.getRecords(,,,,,);
mandatory : module

Sample Request:
resp = zoho.crm.getRecords("Leads",5,2,{"converted":"false"});
  • The example is also applicable for bulk operations (Bulk Get, Bulk Insert, etc).
  • In the sample response, the Email field is privacy protected. Hence, the field has the value as "null", even if the email for the record exists. Add include=private_fields in the params section of the Request URL to include the "private_fields" key in any GET APIs.
  • If the $stop_processing key for a particular record is true, then any Update, Upsert or Convert Lead process cannot be used on the record.

Sample Response

Copied{
    "data": [
       {
            "Owner": {
                "First_Name": "Patricia",
                "Last_Name": "Boyle",
                "name": "Patricia Boyle",
                "id": "111111000000031441"
            },
            "Company": null,
            "Email": null,
            "$currency_symbol": "Rs.",
            "Last_Activity_Time": null,
            "Industry": null,
            "$converted": false,
            "$process_flow": false,
            "Street": null,
            "Data_Processing_Basis_Details": {
                "Contact_Through_Email": false,
                "Owner": {
                    "name": "Patricia Boyle",
                    "id": "111111000000031441"
                },
                "Modified_Time": "2018-05-19T18:09:22+05:30",
                "Contact_Through_Social": false,
                "Created_Time": "2018-05-18T20:20:28+05:30",
                "Consent_Through": "Call",
                "Contact_Through_Survey": false,
                "Data_Processing_Basis": "Consent - Obtained",
                "Contact_Through_Phone": false,
                "Lawful_Reason": null,
                "Mail_Sent_Time": null,
                "Modified_By": {
                    "name": "Patricia Boyle",
                    "id": "111111000000031441"
                },
                "Consent_Date": null,
                "id": "111111000000116003",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "111111000000031441"
                },
                "Consent_Remarks": null,
                "Consent_EndsOn": null
            },
            "Zip_Code": null,
            "id": "111111000000121848",
            "Data_Source": "Mobile",
            "$approved": true,
            "$approval": {
                "delegate": false,
                "approve": false,
                "reject": false,
                "resubmit": false
            },
            "$data_source_details": null,
            "Created_Time": "2018-05-19T18:08:45+05:30",
            "$followed": false,
            "$editable": true,
            "City": null,
            "No_of_Employees": 20,
            "State": null,
            "$status": "c_5",
            "Country": null,
            "Created_By": {
                "First_Name": "Patricia",
                "Last_Name": "Boyle",
                "name": "Patricia Boyle",
                "id": "111111000000031441"
            },
            "Annual_Revenue": 0,
            "Secondary_Email": null,
            "Description": null,
            "Rating": null,
            "Website": null,
            "Twitter": null,
            "Salutation": null,
            "First_Name": "Deborah",
            "Lead_Status": null,
            "Full_Name": "Deborah Grogan",
            "Modified_By": {
                "First_Name": "Patricia",
                "Last_Name": "Boyle",
                "name": "Patricia Boyle",
                "id": "111111000000031441"
            },
            "Skype_ID": null,
            "Phone": -8775,
            "Email_Opt_Out": false,
            "Designation": null,
            "Modified_Time": "2018-05-19T18:08:45+05:30",
            "$converted_detail": {},
            "Mobile": null,
            "$stop_processing": false,
            "Last_Name": "Grogan",
            "Lead_Source": null,
            "Tag": [],
            "Fax": null,
            "Lookup_1": null
        }
    ],
    "info": {
        "per_page": 200,
        "count": 1,
        "page": 1,
        "more_records": false
    },
    "private_fields": [
       {
            "private": {
                "restricted": true,
                "type": "High",
                "export": false
            },
            "api_name": "Email",
            "id": "111111000000000873"
        }
    ]
}

Show full

Show less

Search APIs

The Data Processing Basis (Lawful Basis) details are shown along with the record details in the Search APIs.

In "Sample Request: To search for records in Leads module based on criteria", the email field is marked as private (restricted=true) and hence, the value is null.

Sample Request: To search for records in Leads module based on criteria

Copiedcurl "https://www.zohoapis.com/crm/v3/Leads/search?criteria=(Last_Name:equals:Boyle)"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
CopiedSyntax:
zoho.crm.searchRecords(,,,,,);
mandatory : module,criteria

Sample Request:
resp = zoho.crm.searchRecords("Leads", "((Last_Name:equals:Hawkins) or (Last_Name:starts_with:Pat))");

The following error is thrown when the record with the said email is searched through Criteria:

{
"code": "INVALID_QUERY",
"details": {
"reason": "Cannot use the restricted field.",
"api_name": "Email"
},
"message": "invalid query formed",
"status": "error"
} 

Note:

  • The output responses of Search APIs are similar to the GET APIs.
  • A restricted private field cannot be searched through Criteria.

Sample Response

Copied{
    "data": [
       {
            "Data_Processing_Basis_Details": {
                "Contact_Through_Email": true,
                "Owner": {
                    "name": "Patricia Boyle",
                    "id": "111111000000031431"
                },
                "Modified_Time": "2018-04-26T14:28:44+05:30",
                "Contact_Through_Social": true,
                "Created_Time": "3522937-06-04T16:10:31+05:30",
                "Consent_Other_Details": null,
                "Consent_Through": "Email",
                "Contact_Through_Survey": true,
                "Data_Processing_Basis": "Consent - Obtained",
                "Contact_Through_Phone": true,
                "Mail_Sent_Time": null,
                "Modified_By": {
                    "name": "Deborah Grogan",
                    "id": "111111000000031431"
                },
                "Consent_Date": "2018-04-18",
                "id": "111111000000034106",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "111111000000031431"
                },
                "Consent_Lawful_Details": null,
                "Consent_Remarks": "Got consent from the party",
                "Consent_EndsOn": null
            },
            "Email": null,
            "Last_Name": "Boyle",
            "id": "111111000000034001",
            "$stop_processing": false
        }
    ],
    "info": {
        "per_page": 200,
        "count": 2,
        "page": 1,
        "more_records": false
    }
}

Show full

Show less