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

Update Appointments

Purpose

To update the details of an existing appointment in 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
UPDATE - Update appointments data

Sample Request

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

Request JSON Keys

  • idstring, mandatory

    Denotes the distinctive ID of the appointment which has to be updated. You can obtain this ID from the GET Appointments API.

  • Statusstring, mandatory for cancellation and completion

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

  • 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.

  • Appointment_Start_Timestring, mandatory for rescheduling appointments

    Denotes the starting date and time of the appointment. The value should be given in the ISO 8601 format. In the sample input, an existing appointment is rescheduled using this key.

  • Rescheduled_Fromstring, optional

    Denotes the previous appointment time from which the appointment is being 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.

  • Job_Sheet_NameString, optional

    Represents the name of the job sheet as specified by the member at the end of an appointment. It is the documentation of tasks performed in the service. This key becomes mandatory when Job Sheet is mandated in the appointment preferences. Make a GET Appointment Preferences API call to know if the job sheet is mandated in your organization.

  • Job_Sheet_Description__sstring, optional

    Description of the service performed for the appointment. This key is mandatory when Job Sheet is mandated for your organization through appointment preferences.

Note
  • You can also pass the record ID in the request. Example: {api-domain}/crm/v3/Appointments__s/{appointment_id}

  • Except for the Service_Name key you can update all other Request JSON keys from the Create Appointments API.

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

  • 'Scheduled' is the default status for upcoming appointments. The 'Overdue' status is usually auto-populated when the appointment_start_time exceeds the present time. The 'Completed' status is auto-populated only when the appointment preferences of "Ask the user to mark the Appointment as completed" is not configured for your organization. You can get these details using the GET Appointment Preferences API.

Sample Input

Copied{
    "data":[
        {
            "id": "5545974000002254155",
            "Appointment_Start_Time": "2023-04-05T10:00:00+05:30",
            "Reschedule_Reason": "By Team",
            "Reschedule_Note": "Member is unavailable due to unexpected reasons"
        },
        {
            "id": "5545974000002254060",
            "Status": "Cancelled",
            "Cancellation_Reason": "By Customer",
            "Cancellation_Note": "Customer Unavailable"
        },
        {
            "id": "5545974000002254135",
            "Status": "Completed",
            "Job_Sheet_Name": "Delivered",
            "Job_Sheet_Description__s": "Delivered on time"
        }
    ]    
}

Possible Errors

  • DEPENDENT_FIELD_MISSINGHTTP 400

    You are trying to reschedule the appointment without specifying value for Appointment_Start_Time.
    Solution: The Appointment_Start_Time key is mandatory to reschedule an appointment. You can update the Reschedule_Reason and Reschedule_Note keys only when you have already rescheduled the appointment. To know the rescheduled count of an appointment, make a GET Appointments API call.

  • DEPENDENT_FIELD_MISSINGHTTP 400

    You are trying to cancel an appointment without specifying the 'Cancelled' status.
    Solution: The 'Cancelled' status is mandatory to cancel an appointment.

  • DEPENDENT_FIELD_UNCHANGEDHTTP 400

    You are trying to reschedule the appointment to the existing Appointment_Start_Time.
    Solution: The new appointment time has to be greater than the existing Appointment_Start_Time to reschedule the appointment.

  • DEPENDENT_MISMATCHHTTP 400

    You are trying to cancel an appointment with an invalid status.
    Solution: To cancel an appointment, the only valid value for the Status key is 'Cancelled'.

  • DEPENDENT_MISMATCHHTTP 400

    You have specified either 'Completed' or 'Overdue' status before the appointment time ends.
    Solution: You can mark an appointment as 'completed' or 'Overdue' only after the appointment time has ended.

  • INVALID_DATAHTTP 400

    You have specified an invalid appointment ID.
    Solution: Make a GET Appointments API call to get valid IDs of the appointments in your organization.

  • INVALID_DATAHTTP 400

    You have given an invalid value for the status key.
    Solution: The only possible values are 'Scheduled', 'Cancelled', 'Overdue' and 'Completed'.

  • 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 PUT method in the request URL to access this API.

  • MANDATORY_NOT_FOUNDHTTP 400

    You have failed to provide the ID of the appointment which has to be updated.
    Solution: Make a GET Appointments API call to obtain the IDs of the existing appointments in your organization.

  • 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 wrong oauth scope.
    Solution: Use either ZohoCRM.modules.appointments.UPDATE or ZohoCRM.modules.appointments.ALL scope to create a new valid grant token.

  • NO_PERMISSIONHTTP 403

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

  • NOT_ALLOWEDHTTP 403

    You have tried to reschedule either a completed or cancelled appointment.
    Solution: You cannot reschedule an appointment which is already marked as completed or cancelled.

  • NOT_ALLOWEDHTTP 403

    You have tried to mark a cancelled appointment as 'Scheduled' or 'Completed' or 'Overdue'.
    Solution: You cannot change the Status of a cancelled appointment.

  • NOT_ALLOWEDHTTP 403

    You have tried to mark a completed appointment as 'Scheduled' or 'Cancelled' or 'Overdue'.
    Solution: You cannot change the Status of a completed appointment.

  • NOT_ALLOWEDHTTP 403

    You have tried to mark an appointment as 'Completed'.
    Solution: You cannot mark an appointment as 'Completed', if the "Ask the user to mark the Appointment as completed" is not configured in the appointment preferences for your organization. You can update this preference using the Update Appointment Preferences API.

  • 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 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-04T16:10:09+05:30",
                "Modified_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                },
                "Created_Time": "2023-04-04T15:50:27+05:30",
                "id": "5545974000002254155",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                }
            },
            "message": "record updated",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-04-04T16:10:09+05:30",
                "Modified_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                },
                "Created_Time": "2023-04-04T16:01:27+05:30",
                "id": "5545974000002254060",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                }
            },
            "message": "record updated",
            "status": "success"
        },
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-04-04T16:10:09+05:30",
                "Modified_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                },
                "Created_Time": "2023-04-04T16:07:54+05:30",
                "id": "5545974000002254135",
                "Created_By": {
                    "name": "Patricia Boyle",
                    "id": "5545974000000393001"
                }
            },
            "message": "record updated",
            "status": "success"
        }
    ]
}