Create Appointments

Contains the name and distinctive ID of the service for which you are creating the appointment. You can fetch these details from the GET Services API.

Represents the name of the appointment and it accepts alphanumeric characters.

Contains the name, ID and the module's API name of the customer for whom you are creating the appointment. The customers can be from Contacts, Leads, Accounts and other custom modules which hold customer data.

Represents the ID of the service member who will provide the service for this appointment. Make a GET Services API call to obtain the IDs of service members. You can add only one owner to an appointment.

Denotes the starting date and time of the appointment. The value should be given in the ISO 8601 format.

Represents the location where the service is offered. The GET Services API will provide you the available location of the service you have specified.
Possible Values: 'Client Address' and 'Business Address' that matches the service Location.

Provides the address of the customer, where the service will be offered. Make a GET Contacts API call to get the address of the specified contact. You can also provide a different address as demanded by the customer.

Provides more information about the customer needs and the service, if any.

Contains the list of units and period of when you want to get the reminders for the appointment.
The value of a unit key can be only from 0 to 100.
The possible values for period key are minutes, hours and days.

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

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

Denotes who rescheduled the appointment.
Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'.

Represents the reason for rescheduling the appointment.

Denotes the status of the appointment. The possible value to create a cancelled appointment is Cancelled.

Denotes who cancelled the appointment.
Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'.

Represents the reason for canceling the appointment.

You are trying to create a cancelled appointment without specifying the 'Cancelled' status.
Solution: The 'Cancelled' status is mandatory to create a cancelled appointment.

You are trying to create a rescheduled appointment without specifying the Rescheduled_From key.
Solution: The Rescheduled_From key is mandatory to create a rescheduled appointment.

You have specified 'Scheduled' status for an appointment with past time.
Solution: You cannot schedule an appointment for a past date and time. You can only specify either 'Overdue' or 'Completed' for an appointment in the past time.

You have specified either an invalid User ID or the user is not a part of the service members.
Solution: Make a GET Services API call to provide a valid owner ID who is a part of the service member.

You have specified the value of Remind_At key in the wrong format.
Solution: The value of Remind_At key should be given in a JSON array, within which it should hold the unit and period keys.
The data type of unit key is numbers and it should be between 0 to 100.
The data type of period key is string and the only possible values are 'minutes', 'hours' and 'days'.

You have given invalid values for Location key.
Solution: The only possible values are 'Client Address' and 'Business Address'.

The appointment's Location that you specified mismatches with the service's Location.
Solution: Make a GET Services API call to get the location of the service for which you want to create the appointment.

You have given an invalid value for the Appointment_Start_Time key.
Solution: Before providing value for the Appointment_Start_Time key, make a GET Services API call to know the available timings of the particular service. Ensure the appointment start time falls under the available timings of the service.

You have given an invalid module name in the request URL.
Solution: You can use only Appointments__s in the request URL.

You have specified an invalid http request method type.
Solution: Use only the POST method in the request URL to access this API.

You have failed to specify any of the mandatory fields.
Solution: The 'details' key in the error response will provide the missing mandatory field. You can also refer to the above Request JSON Keys section to find other mandatory fields.

You have used an invalid oauth token.
Solution: The access token you used has expired. Kindly refresh your token and retry.

You created the grant token using the wrong oauth scope.
Solution: Use either ZohoCRM.modules.appointments.CREATE or ZohoCRM.modules.appointments.ALL scope to create a new valid grant token.

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

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 request URL.

Internal Server Error
Solution: Unexpected and unhandled exception in the server. Please contact our support team.