Book Appointment
Table of Contents
Purpose
To book an appointment for a customer for a desired service.
Request URL
https://www.zohoapis.com/bookings/v1/json/appointment
Headers
| Parameter Name | Description |
|---|---|
| Authorization | Zoho-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 Name | Description |
|---|---|
| service_id * | The unique id of the service for which the appointment is booked. |
staff_id/resource_id/ group_id* (For collective booking, group_id is mandatory) | staff_id: The unique id of the staff associated with the service. resource_id: The unique id of the resource associated with the service. group_id: The unique id of the staff group associated with the collective booking service. |
| from_time * | The starting time from which the appointment needs to be booked. (24-hour time format) format: dd-MMM-yyyy HH:mm:ss (e.g. 30-Apr-2019 22:00:00) |
| to_time | End time till which the resource has to be booked. Applicable only for resource booking service.(24-hour time) format: dd-MMM-yyyy HH:mm:ss (e.g. 30-Apr-2019 22:00:00) |
timezone (optional) | The timezone under which the appointment needs to be booked. |
| customer_details * | The details of the customer which needs to be recorded for booking the appointment. They are the customer's name, email address and contact number. They must be represented as a JSON like below. e.g. {"name":"John", "email":"john@email.com", "phone_number":"9876543201"} |
notes (optional) | Additional information about the appointment. |
additional_fields (optional) | Additional details of the customer to be captured through custom fields can be recorded while booking the appointment. Assume the 6 fields for the different types of custom fields - Participant2 (Single Line); Description (Multi Line); Email (Email); Interests (Checkbox); Gender (Radio button); Location (Drop down); and DOB (Date). These fields are represented as key-value pairs. They must be represented as a JSON like below. e.g. {"Participant2":"Peter", "Email":"peter@email.com", "Description":"I am a guest user", "Location":"Adelaide", "Gender":"Male", "DOB":"30-Jul-1997", "Interests":["Football","Tennis"]} |
payment_info (optional) | The amount a user has paid for the booking. e.g.{"cost_paid":"100.00"} |
Response Type
JSON
API Limits
| Zoho Bookings Plan/Edition | Number of API calls/day |
| Free | 250/per user |
| Basic | 1000/per user |
| Premium | 3000/per user |
| Zoho One | 3000/per user |
Related Links
Sample Request
Copied
Sample Response
Copied