---
canonical_url: "https://docs.composio.dev/toolkits/zoho_bookings"
markdown_url: "https://docs.composio.dev/toolkits/zoho_bookings.md"
product: "platform"
version: null
last_updated: null
---

# Zoho Bookings

Zoho Bookings is an appointment scheduling platform for managing workspaces, services, staff, resources, customers, availability, and bookings.

- **Category:** scheduling & booking
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 27
- **Triggers:** 0
- **Slug:** `ZOHO_BOOKINGS`
- **Version:** 00000000_00

## Tools

### Add Staff

**Slug:** `ZOHO_BOOKINGS_ADD_STAFF`

Add up to 50 staff members to Zoho Bookings; the connected user must be an admin or super admin.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `staff_map` | object | Yes | Batch of one to 50 staff members to add. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Book Appointment

**Slug:** `ZOHO_BOOKINGS_BOOK_APPOINTMENT`

Book an appointment for a customer with a service and a staff member, resource, or group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Additional information to attach to the appointment. |
| `to_time` | string | No | Appointment end in dd-MMM-yyyy HH:mm:ss format; only for resource booking services. |
| `group_id` | string | No | Unique ID of the collective staff group. Supply exactly one booking target ID. |
| `staff_id` | string | No | Unique ID of the staff member to book. Supply exactly one booking target ID. |
| `timezone` | string | No | IANA or Zoho-supported timezone used to interpret the appointment times. |
| `from_time` | string | Yes | Appointment start in dd-MMM-yyyy HH:mm:ss format. |
| `service_id` | string | Yes | Unique ID of the service to book. |
| `resource_id` | string | No | Unique ID of the resource to book. Supply exactly one booking target ID. |
| `payment_info` | object | No | Payment information for the booking. |
| `customer_details` | object | Yes | Customer identity and contact details. |
| `additional_fields` | object | No | Custom-field label/value map; checkbox values may be arrays and address values may be nested objects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customers

**Slug:** `ZOHO_BOOKINGS_CREATE_CUSTOMERS`

Create up to 50 guest customers in one request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_map` | object | Yes | Batch of guest customers. Account customer-field settings may require additional values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Date Overrides

**Slug:** `ZOHO_BOOKINGS_CREATE_DATE_OVERRIDES`

Create up to 10 business, staff, or resource availability overrides.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Override target and one to 10 validated override definitions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Resources

**Slug:** `ZOHO_BOOKINGS_CREATE_RESOURCES`

Create up to 10 booking resources and assign them to workspaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_map` | object | Yes | Batch of one to 10 booking resources to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Service

**Slug:** `ZOHO_BOOKINGS_CREATE_SERVICE`

Create a one-on-one or resource booking service in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Typed definition of the service to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workspace

**Slug:** `ZOHO_BOOKINGS_CREATE_WORKSPACE`

Create a Zoho Bookings workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Workspace name, 2-50 characters. Must not contain &#124;, /, \, comma, ?, {, }, <, >, :, ;, double quotes, or single quotes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `ZOHO_BOOKINGS_DELETE_CUSTOMER`

Delete one Zoho Bookings customer. The customer must have no upcoming appointments before deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_map` | object | Yes | Customer deletion payload containing the customer ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Date Overrides

**Slug:** `ZOHO_BOOKINGS_DELETE_DATE_OVERRIDES`

Delete up to 10 availability overrides by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The date-override IDs to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Resource

**Slug:** `ZOHO_BOOKINGS_DELETE_RESOURCE`

Delete one Zoho Bookings resource. The resource must have no assigned services or upcoming appointments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_map` | object | Yes | Resource deletion payload containing the resource ID. |
| `ignore_past_appointments` | boolean | No | Set true to disregard past appointments when deleting the resource. This does not bypass assigned-service or upcoming-appointment restrictions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Service

**Slug:** `ZOHO_BOOKINGS_DELETE_SERVICE`

Permanently delete a one-on-one booking service. Warning: this deletion cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Service ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workspace

**Slug:** `ZOHO_BOOKINGS_DELETE_WORKSPACE`

Delete a Zoho Bookings workspace. A workspace with future appointments cannot be deleted, and a booked group service must first be moved to another workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace ID to delete. The workspace must have no future appointments, and any booked group service must first be moved to another workspace. |
| `ignore_past_appointments` | boolean | No | Set true to permit deletion when past appointments exist. This does not bypass future-appointment or booked-group-service restrictions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Appointment

**Slug:** `ZOHO_BOOKINGS_GET_APPOINTMENT`

Get the full details of one previously booked appointment by booking ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `booking_id` | string | Yes | Booking ID, including its displayed prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Appointments

**Slug:** `ZOHO_BOOKINGS_LIST_APPOINTMENTS`

List one page of Zoho Bookings appointments with optional time, assignee, service, status, customer, and creation-time filters. With no filters, the provider returns the current day's appointments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page for the initial request. Omit to use the first page. |
| `status` | string ("UPCOMING" | "CANCEL" | "ONGOING" | "PENDING" | "COMPLETED" | "NO_SHOW" | "PENDING_PAYMENT" | "PAYMENT_FAILURE") | No | Appointment status to return. |
| `to_time` | string | No | Range end in dd-MMM-yyyy HH:mm:ss format; alone selects its day. |
| `per_page` | integer | No | Appointments per page (1-100). The provider returns at most 60 when need_customer_more_info is true. |
| `staff_id` | string | No | Return appointments for this staff member; do not combine with resource_id. |
| `from_time` | string | No | Range start in dd-MMM-yyyy HH:mm:ss format; alone selects its day. |
| `service_id` | string | No | Return appointments for this service. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Pass it back unchanged; it takes precedence over page. |
| `resource_id` | string | No | Return appointments for this resource; do not combine with staff_id. |
| `customer_name` | string | No | Case-insensitive customer-name contains filter. |
| `customer_email` | string | No | Customer-email contains filter. |
| `customer_phone_number` | string | No | Customer-phone contains filter. |
| `need_customer_more_info` | boolean | No | Include customer custom fields. This changes the provider's default page size from 50 to 30. |
| `appointment_created_from` | string | No | Return appointments created at or after this dd-MMM-yyyy HH:mm:ss time. |
| `appointment_created_till` | string | No | Return appointments created at or before this dd-MMM-yyyy HH:mm:ss time. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Available Slots

**Slug:** `ZOHO_BOOKINGS_LIST_AVAILABLE_SLOTS`

List available Zoho Bookings appointment times for a service and exactly one staff member, collective group, or resource on a selected date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | No | Collective staff group whose slots to return. Supply exactly one availability target ID. |
| `staff_id` | string | No | Staff member whose slots to return. Supply exactly one availability target ID. |
| `service_id` | string | Yes | Service whose availability to check. |
| `resource_id` | string | No | Resource whose slots to return. Supply exactly one availability target ID. |
| `selected_date` | string | Yes | Date to check in the format supported by the connected Zoho Bookings account. Zoho does not document a normative format for this endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Date Overrides

**Slug:** `ZOHO_BOOKINGS_LIST_DATE_OVERRIDES`

List one page of business, staff, or resource availability overrides, optionally filtered by override type and time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Provider page for the initial request. Each page contains up to 50 overrides. |
| `type` | string ("unavailability" | "additional_availability") | No | Whether to return unavailable periods or additional availability. |
| `to_time` | string | No | End of the period. Requires from_time. |
| `from_time` | string | No | Start of the period in a date or date-time format accepted by Zoho Bookings. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call. Pass it back unchanged; it takes precedence over page. |
| `availability_for` | string ("business" | "staff" | "resource") | Yes | Target kind whose overrides to return. |
| `availability_for_id` | string | No | Staff or resource ID. Omit this field for business overrides. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Resources

**Slug:** `ZOHO_BOOKINGS_LIST_RESOURCES`

List Zoho Bookings resources, optionally narrowed to one resource or resources assigned to a service.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `service_id` | string | No | Return resources assigned to this service. |
| `resource_id` | string | No | Return only the resource with this ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Services

**Slug:** `ZOHO_BOOKINGS_LIST_SERVICES`

List services in a Zoho Bookings workspace, optionally narrowed to one service or staff member.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `staff_id` | string | No | Return services assigned to this staff member. |
| `service_id` | string | No | Return only this service. |
| `workspace_id` | string | Yes | Workspace whose services to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Staff

**Slug:** `ZOHO_BOOKINGS_LIST_STAFF`

List Zoho Bookings staff, optionally filtered by staff, service, email substring, or workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `staff_id` | string | No | Return only this staff member. |
| `service_id` | string | No | Return staff assigned to this service. |
| `staff_email` | string | No | Return staff whose email address contains this value. |
| `workspace_id` | string | No | Return staff assigned to this workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `ZOHO_BOOKINGS_LIST_WORKSPACES`

List all Zoho Bookings workspaces or return one workspace by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | No | Return only the workspace with this ID. Omit to list all workspaces. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reschedule Appointment

**Slug:** `ZOHO_BOOKINGS_RESCHEDULE_APPOINTMENT`

Move an existing Zoho Bookings appointment to a new start time, staff member, or collective staff group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | No | New collective staff group ID. Omit when the group should not change. |
| `staff_id` | string | No | New staff member ID. Omit when the assignee should not change. |
| `booking_id` | string | Yes | Appointment booking ID to reschedule. |
| `start_time` | string | No | New appointment start time in dd-MMM-yyyy HH:mm:ss format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Appointment

**Slug:** `ZOHO_BOOKINGS_UPDATE_APPOINTMENT`

Change an appointment's status or edit its notes and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Appointment information changes. Required only for edit_appointment_info and must include notes, custom_fields, or both. |
| `action` | string ("completed" | "cancel" | "noshow" | "edit_appointment_info") | Yes | Operation to perform: change status or edit notes and custom fields. |
| `booking_id` | string | Yes | Appointment booking ID to update, including its displayed prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer

**Slug:** `ZOHO_BOOKINGS_UPDATE_CUSTOMER`

Update one guest customer's name, email, or phone details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_map` | object | Yes | One customer's ID and replacement details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Date Overrides

**Slug:** `ZOHO_BOOKINGS_UPDATE_DATE_OVERRIDES`

Update up to 10 existing Zoho Bookings availability overrides.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Batch of one to 10 date overrides to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Resource

**Slug:** `ZOHO_BOOKINGS_UPDATE_RESOURCE`

Update one Zoho Bookings resource and optionally apply its changed details to past appointments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_map` | object | Yes | Single-resource update envelope. |
| `ignore_past_appointments` | boolean | No | Set true to apply this resource's changed details to past appointments; false leaves historical appointment details unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Service

**Slug:** `ZOHO_BOOKINGS_UPDATE_SERVICE`

Update an existing one-on-one booking service.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Service ID and the fields to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workspace

**Slug:** `ZOHO_BOOKINGS_UPDATE_WORKSPACE`

Update a workspace's name, status, description, or booking-ID policy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data_map` | object | Yes | One or more workspace fields to update. |
| `workspace_id` | string | Yes | Unique ID of the workspace to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
