​

Update Appointment

Table of Contents

Purpose

​To update the status of a booking or its information.

Request URL

https://www.zohoapis.com/bookings/v1/json/updateappointment

Headers

Parameter NameDescription
AuthorizationZoho-oauthtoken {{accesstoken}}

Note: The access token can be generated from the developer console.

Scope

zohobookings.data.CREATE

Request Method

POST

Parameters

Parameters to be passed in the request body as form-data along with the request URL are,

Parameter NameDescription
booking_id *The unique id of the previously booked appointment
action *The action to perform. Possible values: completed, cancel, noshow, edit_appointment_info.

data (*mandatory when action is edit_appointment_info)

Use the notes key to update appointment notes and the custom_fields key to update custom booking fields. Pass the booking field labels as keys and their corresponding values as key-value pairs inside the data object.

Notes: fields marked * are mandatory.
When action is set to edit_appointment_info, include notes, custom_fields, or both inside the data object.

Response Type

JSON

​

API Limits

Zoho Bookings Plan/EditionNumber of API calls/day
Free250/per user
Basic1000/per user
Premium3000/per user
Zoho One3000/per user
Note: The API limits are excluding the authorization requests. API counts are calculated between 00:00 and 23:59 hours in the respective time zones.

Related Links

Sample Request

Copiedcurl --location --request POST 'https://www.zohoapis.com/bookings/v1/json/updateappointment' \
--header 'Authorization: Zoho-oauthtoken 1000.7b3610d1XXXXXXXXXXXXXXXX087cc3.6282226f615637c467bee7209ce1c0a1' \
--form 'booking_id=#AN-00014' \
--form 'action= noshow'

curl --location --request POST 'https://www.zohoapis.com/bookings/v1/json/updateappointment' \
--header 'Authorization: Zoho-oauthtoken 1000.7b3610d1XXXXXXXXXXXXXXXX087cc3.6282226f615637c467bee7209ce1c0a1' \
--form 'booking_id=#AN-00014' \
--form 'action=edit_appointment_info' \
--form 'data={
  "notes":"Customer requested to discuss the quarterly project review.",
  "custom_fields":{
    "Company Name":"Zylker Technologies",
    "Department":"Sales",
    "Preferred Meeting Date":"31-Jul-2025",
    "Meeting Type":"In-person"
  }
}'

Sample Response

Copied{
  "response": {
    "returnvalue": {
      "staff_name": "Staff 1",
      "customer_more_info": {},
      "customer_booking_start_time": "2019-05-28 13:00:00",
      "customer_contact_no": "123456",
      "booked_on": "2019-05-28 10:47:03",
      "booking_id": "#AN-00014",
      "workspace_id": "3848021000000027004",
      "duration": "30 mins",
      "service_id": "3848021000000027083",
      "staff_id": "3848021000000027052",
      "cost_paid": "0.00",
      "currency": "INR",
      "workspace_name": "Chennai",
      "cost": "0.00",
      "service_name": "Meeting",
      "time_zone": "Asia/Calcutta",
      "start_time": "28-May-2019 13:00:00",
      "due": "0.0",
      "customer_email": "john@zylker.com",
      "booking_type": "appointment",
      "customer_name": "John",
      "summary_url": "https://john.zohobookings.com/#/customer/anu1/invoice/LI8VujFVTFsz9q2o3sh1I%2Bep1hxEFxhfH9Lr2CsEesFXLc%2FxHtB1tBapl4Qp5Cf5",
      "customer_booking_time_zone": "Asia/Calcutta",
      "status": "upcoming"
    },
    "logMessage": [],
    "status": "success"
  }
}
When action is "edit_appointment_info"
{

 "response": {
"returnvalue": {
"status": "success",
"message": "Appointment details edited successfully"
},
"status": "success"
}
}

A Collective booking response will also include the following parameters:

"co_hosts": [
                {
                    "staff_name": "Ryan",
                    "staff_contact_number": "9222222222",
                    "staff_email": "ryan.jones@zylker.com"
                },
                {
                    "staff_name": "Ashton",
                    "staff_contact_number": "9111111111",
                    "staff_email": "ashton.prince@zylker.com"
                }
	]