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

Create Appointments

Purpose

To add new appointments to your organization.

Request Details

Request URL

{api-domain}/crm/{version}/Appointments__s

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.modules.appointments.{operation_type}

Possible operation types

ALL - Full access to appointments data
CREATE - Create new appoitments

Sample Request

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

Request JSON Keys

  • Service_NameJSON object, mandatory

    Contains the name and distinctive ID of the service for which you are creating the appointment. You can fetch these details from the GET Services API.

  • Appointment_Namestring, mandatory

    Represents the name of the appointment and it accepts alphanumeric characters.

  • Appointment_ForJSON object, mandatory

    Contains the name, ID and the module's API name of the customer for whom you are creating the appointment. The customers can be from Contacts, Leads, Accounts and other custom modules which hold customer data.

  • Ownerbigint, mandatory

    Represents the ID of the service member who will provide the service for this appointment. Make a GET Services API call to obtain the IDs of service members. You can add only one owner to an appointment.

  • Appointment_Start_Timestring, mandatory

    Denotes the starting date and time of the appointment. The value should be given in the ISO 8601 format.

  • Locationstring, mandatory

    Represents the location where the service is offered. The GET Services API will provide you the available location of the service you have specified.
    Possible Values: 'Client Address' and 'Business Address' that matches the service Location.

  • Addressstring, mandatory for Client Address

    Provides the address of the customer, where the service will be offered. Make a GET Contacts API call to get the address of the specified contact. You can also provide a different address as demanded by the customer.

  • Additional_Informationstring, optional

    Provides more information about the customer needs and the service, if any.

  • Remind_AtJSON array, optional

    Contains the list of units and period of when you want to get the reminders for the appointment.
    The value of a unit key can be only from 0 to 100.
    The possible values for period key are minutes, hours and days.

  • Statusstring, optional

    Denotes the status of the appointment.
    Possible Values: 'Cancelled', 'Completed', 'Overdue' and 'Scheduled'.

Note
  • You can create a maximum of 100 appointments per API call.

Sample Input

Copied{
    "data":[
        {
            "Appointment_Name":"James - AC Repair",
            "Appointment_For": {
                "module": {
                    "api_name": "Contacts"
                },
                "name": "James Smith",
                "id": "5545974000000955056"
            },
            "Service_Name": {
                "name": "AC Repair",
                "id": "5545974000002180641"
            },
            "Appointment_Start_Time": "2023-04-04T11:00:00+05:30",
            "Owner": "5545974000000393001",
            "Location" : "Client Address",
            "Address":"7 W Jackson Blvd, San Jose",
            "Additional_Information":"Water leakage from the machine",
            "Remind_At": [
                {
                    "unit":30,
                    "period": "minutes"
                }
            ]
        }
    ]
}

Request JSON Keys to Create a Rescheduled Appointment

  • Rescheduled_Fromstring, mandatory to create rescheduled appointments

    Denotes the previous appointment time from which the appointment was rescheduled to the new time. The Rescheduled_From time should be lesser than the new appointment time. The value should be given in the ISO 8601 format.

  • Reschedule_ReasonString, Optional

    Denotes who rescheduled the appointment.
    Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'.

  • Reschedule_NoteString, Optional

    Represents the reason for rescheduling the appointment.

Sample Input to Create a Rescheduled Appointment

Copied{
    "data": [
        {
            "Appointment_Name": "James - AC Repair",
            "Appointment_For": {
                "module": {
                    "api_name": "Contacts"
                },
                "name": "James Smith",
                "id": "5545974000000955056"
            },
            "Service_Name": {
                "name": "AC Repair",
                "id": "5545974000002180641"
            },
            "Appointment_Start_Time": "2023-04-21T13:00:00+05:30",
            "Owner": "5545974000000393001",
            "Location": "Client Address",
            "Address": "7 W Jackson Blvd, San Jose",
            "Additional_Information": "Water leakage from the machine",
            "Remind_At": [
                {
                    "unit": 30,
                    "period": "minutes"
                }
            ],
            "Rescheduled_From":"2023-04-21T12:00:00+05:30",
            "Reschedule_Reason": "By Team",
            "Reschedule_Note": "Member is unavailable due to unexpected reasons"
        }
    ]
}

Show full

Show less

Request JSON Keys to Create a Cancelled Appointment

  • Statusstring, mandatory to create a cancelled appointment

    Denotes the status of the appointment. The possible value to create a cancelled appointment is Cancelled.

  • Cancellation_ReasonString, optional

    Denotes who cancelled the appointment.
    Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'.

  • Cancellation_NoteString, optional

    Represents the reason for canceling the appointment.

Sample Input to Create a Cancelled Appointment

Copied{
    "data": [
        {
            "Appointment_Name": "James - AC Repair",
            "Appointment_For": {
                "module": {
                    "api_name": "Contacts"
                },
                "name": "James Smith",
                "id": "5545974000000955056"
            },
            "Service_Name": {
                "name": "AC Repair",
                "id": "5545974000002180641"
            },
            "Appointment_Start_Time": "2023-04-21T13:00:00+05:30",
            "Owner": "5545974000000393001",
            "Location": "Client Address",
            "Address": "7 W Jackson Blvd, San Jose",
            "Additional_Information": "Water leakage from the machine",
            "Remind_At": [
                {
                    "unit": 30,
                    "period": "minutes"
                }
            ],
            "Status": "Cancelled",
            "Cancellation_Reason": "By Customer",
            "Cancellation_Note": "Customer Unavailable"
        }
    ]
}

Show full

Show less

Possible Errors

  • DEPENDENT_FIELD_MISSINGHTTP 400

    You are trying to create a cancelled appointment without specifying the 'Cancelled' status.
    Solution: The 'Cancelled' status is mandatory to create a cancelled appointment.

  • DEPENDENT_FIELD_MISSINGHTTP 400

    You are trying to create a rescheduled appointment without specifying the Rescheduled_From key.
    Solution: The Rescheduled_From key is mandatory to create a rescheduled appointment.

  • DEPENDENT_MISMATCHHTTP 400

    You have specified 'Scheduled' status for an appointment with past time.
    Solution: You cannot schedule an appointment for a past date and time. You can only specify either 'Overdue' or 'Completed' for an appointment in the past time.

  • INVALID_DATAHTTP 400

    You have specified either an invalid User ID or the user is not a part of the service members.
    Solution: Make a GET Services API call to provide a valid owner ID who is a part of the service member.

  • INVALID_DATAHTTP 400

    You have specified the value of Remind_At key in the wrong format.
    Solution: The value of Remind_At key should be given in a JSON array, within which it should hold the unit and period keys.
    The data type of unit key is numbers and it should be between 0 to 100.
    The data type of period key is string and the only possible values are 'minutes', 'hours' and 'days'.

  • INVALID_DATAHTTP 400

    You have given invalid values for Location key.
    Solution: The only possible values are 'Client Address' and 'Business Address'.

  • INVALID_DATAHTTP 400

    The appointment's Location that you specified mismatches with the service's Location.
    Solution: Make a GET Services API call to get the location of the service for which you want to create the appointment.

  • INVALID_DATAHTTP 400

    You have given an invalid value for the Appointment_Start_Time key.
    Solution: Before providing value for the Appointment_Start_Time key, make a GET Services API call to know the available timings of the particular service. Ensure the appointment start time falls under the available timings of the service.

  • INVALID_MODULEHTTP 400

    You have given an invalid module name in the request URL.
    Solution: You can use only Appointments__s in the request URL.

  • INVALID_REQUEST_METHODHTTP 400

    You have specified an invalid http request method type.
    Solution: Use only the POST method in the request URL to access this API.

  • MANDATORY_NOT_FOUNDHTTP 400

    You have failed to specify any of the mandatory fields.
    Solution: The 'details' key in the error response will provide the missing mandatory field. You can also refer to the above Request JSON Keys section to find other mandatory fields.

  • INVALID_TOKENHTTP 401

    You have used an invalid oauth token.
    Solution: The access token you used has expired. Kindly refresh your token and retry.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    You created the grant token using the wrong oauth scope.
    Solution: Use either ZohoCRM.modules.appointments.CREATE or ZohoCRM.modules.appointments.ALL scope to create a new valid grant token.

  • NO_PERMISSIONHTTP 403

    You do not have permission to create any appointments.
    Solution: Contact your system administrator.

  • INVALID_URL_PATTERNHTTP 404

    Check if you are trying to access the correct URL.
    Solution: You have given an invalid request URL. Use only /Appointments__s endpoint in the request URL.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Solution: Unexpected and unhandled exception in the server. Please contact our support team.

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-04-03T20:22:18+05:30",
                "Modified_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                },
                "Created_Time": "2023-04-03T20:22:18+05:30",
                "id": "5545974000002242004",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                }
            },
            "message": "record added",
            "status": "success"
        }
    ]
}