Actions11
Overview
The "Book Appointment" operation of the Zoho Bookings node allows users to create a new appointment booking in Zoho Bookings via its API. This operation is useful for automating appointment scheduling workflows, such as when integrating booking capabilities into custom applications, websites, or other automation pipelines.
Typical scenarios include:
- Automatically booking appointments when a customer fills out a form.
- Scheduling services with specific staff members at designated times.
- Adding customer details and custom fields to enrich the booking information.
- Handling group bookings or collective appointments.
- Managing time zones accurately for global customers.
For example, a business could use this node to automatically book a haircut appointment for a customer by specifying the service ID (e.g., "Haircut"), the staff member who will perform it, the desired start time, and the customer's contact details.
Properties
Name | Meaning |
---|---|
Service ID | The unique identifier of the service to be booked. It corresponds to the number found in the URL on the service page. |
Staff ID | The unique identifier of the staff member assigned to the appointment. |
Start Time | The starting date and time of the appointment. Must match the format dd-MMM-yyyyTHH:mm:ss (e.g., 30-Apr-2019T22:30:00 ). |
Customer Full Name | The full name of the customer making the appointment. |
Customer Email | The email address of the customer. |
Customer Phone | (Optional) The phone number of the customer. |
Custom Fields Input Type | Specifies how custom customer fields are provided. Options: Key Value (individual key-value pairs), or JSON (a JSON string representing multiple fields). |
Custom Customer Fields | Additional custom fields for the customer. Depending on the input type, either a collection of key-value pairs or a JSON object can be provided to set extra customer data fields. |
Additional Fields | A collection of optional additional parameters: - Resource ID: Identifier for the resource. - Group ID: Required for collective/group bookings. - Time Zone: Time zone of the event (e.g., "America/New_York"). - Zoho Region: The regional domain suffix for Zoho API endpoints (e.g., .com , .eu ). |
Workspace ID | (Not directly used in this operation but available in the node) |
Output
The output JSON contains a single field:
zohoResponse
: This field holds the raw response from the Zoho Bookings API after attempting to book the appointment. It includes details about the created appointment or error messages if the booking failed.
No binary data is produced by this operation.
Dependencies
- Requires an active Zoho Bookings OAuth2 API credential configured in n8n for authentication.
- Uses the Zoho Bookings API endpoint, which varies based on the selected region (e.g.,
.com
,.eu
). - Relies on the
luxon
library internally for date-time formatting. - The node expects the
startTime
property to be formatted correctly and validates time zones if provided.
Troubleshooting
- Incorrect Date Format: If the
Start Time
is not in the expected format (dd-MMM-yyyyTHH:mm:ss
), the API call may fail or produce unexpected results. Ensure the date-time matches the required pattern. - Missing Required Fields: Omitting required fields like
Service ID
,Staff ID
,Customer Full Name
, orCustomer Email
will cause errors. - Time Zone Issues: Providing an invalid or unsupported time zone string may cause errors. Use valid IANA time zone names (e.g., "America/New_York").
- API Authentication Errors: If the OAuth2 credentials are invalid or expired, the request will fail. Refresh or reconfigure the credentials as needed.
- Customer Details Merging: The Zoho API merges customer details if they match existing records, which might lead to unexpected overwrites. Review the node's documentation for handling customer data carefully.
- Group Booking Requirements: When booking a group appointment, ensure the
Group ID
is provided; otherwise, the booking may be rejected.
Common error messages typically come from the Zoho API and should be interpreted according to Zoho's API documentation. Checking the raw zohoResponse
output helps diagnose issues.