Zoho: Appointments schemas

← Appointments operations · All schemas

Create Appointment records — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for creating appointment records. Additional keys: not allowed
data	array	Required within parent	Represents the data array containing the appointment objects to create. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Create Appointment records — request body — body data item

Referenced models: Create Appointment records — request body — body data item

Create Appointment records — request body — body data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single appointment record object in the request, containing all appointment fields for creating or updating the record. Additional keys: not allowed
$currency_symbol	string or null	Optional	Represents the currency symbol associated with the CRM organization's primary currency. Maximum length: 1
$editable	boolean or null	Optional	Indicates whether the current user has permission to edit the appointment record. **Possible Values**: - true - The current user has edit access to the appointment record. - false - The current user does not have edit access to the appointment record.
$field_states	null or string	Optional	Represents the state of fields that have conditional visibility or special behavioral rules applied within the appointment record. Maximum length: 255
$sharing_permission	string or null	Optional	Represents the sharing permission level granted to the current user for the appointment record. Maximum length: 11
$state	string or null	Optional	Represents the save state of the appointment record, indicating whether the record is in a draft, saved, or transitional state. Maximum length: 4
$status	string or null	Optional	The request could not be processed due to an invalid appointment ID, an invalid module name, or an unsupported HTTP request method. **Resolution:** For INVALID_DATA, make a GET Appointments API call and provide a valid appointment ID. For INVALID_REQUEST_METHOD, use only the DELETE method. For INVALID_MODULE, verify that the module API name in the request is correct. Maximum length: 7
Additional_Information	null or string	Optional	Represents any supplementary details about the appointment or specific customer requirements that do not belong to a standard field. Maximum length: 32000
Address	null or string	Optional	All three appointment records deleted successfully. Maximum length: 255
Appointment_End_Time	string or null	Optional	Represents the scheduled end date and time of the appointment, expressed in ISO 8601 format. Format: date-time Maximum length: 120
Appointment_For	Model	Required within parent	Expand Create Appointment records — request body — body data item Appointment For Contains the name, ID and the module's API name of the customer for whom you are creating the appointment. (Required)
Appointment_Name	string or null	Optional	Partial deletion where one record deleted, one failed with INVALID_DATA Maximum length: 225
Appointment_Start_Time	string	Required within parent	Represents the scheduled start date and time of the appointment, expressed in ISO 8601 format. Format: date-time Maximum length: 120
Cancellation_Note	null or string	Optional	INVALID_DATA error where appointment ID is invalid or already deleted. Maximum length: 2000
Cancellation_Reason	null or string	Optional	Represents who cancelled the appointment. **Possible values**: - By Customer - The appointment was cancelled by the customer. - By Team - The appointment was cancelled by the service team. Maximum length: 120
Cancelled_By	null or object	Optional	Invalid module API name provided in the request.
Cancelled_Time	null or string	Optional	Represents the date and time when the appointment was cancelled. Maximum length: 120
Created_By	Model	Optional	Expand Create Appointment records — request body — body data item Created By appointment created by
Created_Time	string or null	Optional	Invalid HTTP request method type used in the request. Format: date-time Maximum length: 120
Date_1	null or string	Optional	Delete one or more appointment records. Maximum length: 20
Duration	integer or null	Optional	Represents the duration of the appointment in minutes. Format: int32
Job_Sheet_Created__s	boolean or null	Optional	Indicates whether a job sheet has been created for this appointment. **Possible values**: - true - A job sheet has been created and is associated with the appointment. - false - No job sheet has been created for the appointment.
Job_Sheet_Description__s	string or null	Optional	Represents the description of the job sheet associated with the completed appointment. Maximum length: 32000
Job_Sheet_Name__s	string or null	Optional	Represents the name of the job sheet created for the completed appointment. Maximum length: 120
Job_Sheet_Section__s	string or null	Optional	Represents the job sheet section displayed to the user for a completed appointment. Maximum length: 120
Last_Activity_Time	null or string	Optional	Represents the date and time of the last activity recorded on the appointment. Maximum length: 120
Location	string or null	Optional	Represents the location where the appointment service is offered. Possible values: **Client Address** - The service is delivered at the customer's address. **Business Address** - The service is delivered at the business location. One of: Client Address, Business Address Maximum length: 120
Modified_By	Model	Optional	Expand Create Appointment records — request body — body data item Modified By modified by
Modified_Time	string or null	Optional	Represents the date and time when the appointment record was last modified. Format: date-time Maximum length: 120
Owner	Model	Required within parent	Expand Create Appointment records — request body — body data item Owner Represents the ID of the service member who will provide the service for this appointment. (Required)
Record_Status__s	string or null	Optional	Represents the availability status of the appointment record. Maximum length: 9
Remind_At	array or null	Optional	Contains the list of reminder configurations for the appointment, each specifying a time unit and reminder period. Maximum items: 100
Remind_At[]	object	Each item	Each object represents a single reminder configuration, including the time unit and reminder period. Additional keys: not allowed
Remind_At[].period	string	Optional	Represents the unit of time for the reminder. Possible values: **minutes** - Reminder in minutes. **hours** - Reminder in hours. **days** - Reminder in days. One of: minutes, hours, days
Remind_At[].unit	integer	Optional	Represents the numeric value of the reminder time. Format: int32
Reschedule_Count	integer or null	Optional	Represents the number of times the appointment has been rescheduled. Format: int32
Reschedule_Note	null or string	Optional	Represents the note explaining the reason for rescheduling the appointment. Maximum length: 2000
Reschedule_Reason	null or string	Optional	Represents who rescheduled the appointment. **Possible values**: - By Customer - The appointment was rescheduled by the customer. - By Team - The appointment was rescheduled by the service team. Maximum length: 120
Rescheduled_By	null or object	Optional	Represents the user who rescheduled the appointment.
Rescheduled_By.email	string or null	Optional	Represents the email address of the user who rescheduled the appointment. Format: email Maximum length: 33
Rescheduled_By.id	string or null	Optional	Represents the unique identifier of the user who rescheduled the appointment. Maximum length: 255
Rescheduled_By.name	string or null	Optional	Represents the full name of the user who rescheduled the appointment. Maximum length: 255
Rescheduled_From	null or string	Optional	Represents the previous start time of the appointment before it was rescheduled, expressed in ISO 8601 format. Maximum length: 120
Rescheduled_Time	null or string	Optional	Represents the date and time when the appointment was rescheduled. Maximum length: 120
Rescheduled_To	null or string	Optional	Represents the new start time of the appointment after rescheduling, expressed in ISO 8601 format. Maximum length: 120
Service_Name	Model	Required within parent	Expand Create Appointment records — request body — body data item Service Name Contains the name and distinctive ID of the service for which you are creating the appointment. (Required)
Status	string or null	Optional	Represents the current status of the appointment. Possible values: **Scheduled** - The appointment is booked and upcoming. **Overdue** - The appointment has passed its scheduled time without completion. **Completed** - The appointment has been completed. **Cancelled** - The appointment has been cancelled. Maximum length: 120
Tag	array or null	Optional	Represents the list of tags associated with the appointment record. Maximum items: 100
Tag[]	string	Each item	Each string represents a single tag name associated with the appointment. Maximum length: 2000
id	string or null	Optional	Represents the unique identifier of the appointment record. Maximum length: 18 Read only: true

Referenced models: Create Appointment records — request body — body data item Appointment For, Create Appointment records — request body — body data item Created By, Create Appointment records — request body — body data item Modified By, Create Appointment records — request body — body data item Owner, Create Appointment records — request body — body data item Service Name

Create Appointment records — request body — body data item Appointment For

Field	Type	Presence	Description and constraints
$	object	Root	Represents the customer for whom the appointment is created, including the record ID, name, and module API name. Test4 Additional keys: not allowed
id	string or null	Optional	Represents the list of result objects for each appointment deletion is attempted. Each item is either a success confirmation or an error response. Test7 Maximum length: 18
module	Model	Optional	Expand Create Appointment records — request body — body data item Appointment For module module name
name	string or null	Optional	Represents the full name of the customer record in the associated module. Maximum length: 2

Referenced models: Create Appointment records — request body — body data item Appointment For module

Create Appointment records — request body — body data item Appointment For module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module details for the Appointment_For customer record lookup, including the module API name and ID. Test8 Additional keys: not allowed
api_name	string or null	Optional	Represents the API name of the module for the customer record. Maximum length: 8
id	string or null	Optional	Represents the unique ID of the module. Maximum length: 18

Create Appointment records — request body — body data item Created By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	string or null	Optional	Represents the email address of the user who created the appointment record. Format: email Maximum length: 33
id	string or null	Optional	Represents the unique identifier of the user who created the appointment record. Maximum length: 255
name	string or null	Optional	Represents the full name of the user who created the appointment record. Maximum length: 255

Create Appointment records — request body — body data item Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	string or null	Optional	Represents the email address of the user who last modified the appointment record. Format: email Maximum length: 33
id	string or null	Optional	Represents the unique ID of the user who last modified the appointment record. Maximum length: 255
name	string or null	Optional	Represents the full name of the user who last modified the appointment record. Maximum length: 255

Create Appointment records — request body — body data item Owner

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user assigned as the appointment owner, including the user ID, full name, and email address. Additional keys: not allowed
email	string or null	Optional	Represents the email address of the appointment owner. Format: email Maximum length: 100
id	string or null	Optional	Represents the unique ID of the appointment owner. Maximum length: 100
name	string or null	Optional	Represents the full name of the appointment owner. Maximum length: 100

Create Appointment records — request body — body data item Service Name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the service for which the appointment is created, including the service ID and name. Additional keys: not allowed
id	string or null	Optional	Represents the unique ID of the service. Maximum length: 100
name	string or null	Optional	Represents the name of the service for which the appointment is created. Maximum length: 100

Create Appointment records — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the request to create appointment records, containing the result for each appointment. Additional keys: not allowed
data	array	Optional	Represents the list of result objects for each created appointment record. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Delete an Appointment by ID — response body — data item

Referenced models: Delete an Appointment by ID — response body — data item

Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, DEPENDENT MISMATCH, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the Rescheduled_From field is empty while Reschedule_Reason is provided. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_FIELD_MISSING, DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Rescheduled_From cannot be empty, Reschedule the appointment atleast once to Update the fields of Reschedule Information Section
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when cancellation information fields are updated without setting the Status to Cancelled. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_FIELD_MISSING
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: To Update the fields of Cancellation Information Section, value of Status should be Cancelled
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD UNCHANGED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when Rescheduled_From and Appointment_Start_Time have the same value. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_FIELD_UNCHANGED
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Reschedule_From and Appointment_Start_Time cannot be same, Reschedule the appointment atleast once to Update the fields of Reschedule Information Section
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment Owner is not a part of Service Members, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the appointment owner is not a member of the service specified in Service_Name. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Appointment Owner is not a part of Service Members
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as completed before the appointment ends, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the appointment Status is set to Completed before the appointment end time. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Appointment cannot be marked as completed before the appointment ends
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as overdue before the appointment ends, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the appointment Status is set to Overdue before the appointment end time. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Appointment cannot be marked as overdue before the appointment ends
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be scheduled for past dates, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the appointment start time is set to a past date. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Appointment cannot be scheduled for past dates
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when a job sheet is created for an appointment that has not been completed. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: DEPENDENT_MISMATCH
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Job Sheet can be created only for completed appointment, Field of this jobsheet cannot be updated. Choose appropriate Jobsheet in services
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details about the field that caused the validation failure. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
dependee	object	Required within parent	Represents the dependent field that triggers this constraint. Additional keys: not allowed
dependee.api_name	string	Required within parent	Represents the API name of the field that triggers the dependency constraint. Maximum length: 255
dependee.json_path	string	Required within parent	Represents the JSON path to the field that triggers the dependency constraint. Maximum length: 1000
json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000

Create Appointment records — response body — data / data / item / value / code: INVALID DATA, message: invalid data, INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the Appointment_For field value is not a valid JSON object. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: INVALID_DATA
details	Model	Required within parent	Expand Create Appointment records — response body — data / data / item / value / code: INVALID DATA, message: invalid data, INVALID DATA, status: error details
message	string	Required within parent	Represents the error message describing the validation failure. Known values: invalid data, INVALID_DATA
status	string	Required within parent	Indicates the response status. Known values: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: INVALID DATA, message: invalid data, INVALID DATA, status: error details

Create Appointment records — response body — data / data / item / value / code: INVALID DATA, message: invalid data, INVALID DATA, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details about the field that caused the validation failure. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
expected_data_type	string	Required within parent	Represents the expected data type for the field that has an incorrect value. Maximum length: 255
json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000

Create Appointment records — response body — data / data / item / value / code: INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the module API name provided in Appointment_For does not exist in the multi-module lookup. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: INVALID_DATA
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: the given module name is not exist in multimodulelookup, invalid data, the id given seems to be invalid
status	string	Required within parent	Indicates the response status. Known values: error

Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: mandatory key missing, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the required unit key is missing from a Remind_At object. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: MANDATORY_NOT_FOUND
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: mandatory key missing
status	string	Required within parent	Indicates the response status. Known values: error

Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: required field not found, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when a required field is missing from the request. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: MANDATORY_NOT_FOUND
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: required field not found
status	string	Required within parent	Indicates the response status. Known values: error

Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Appointment time does not falls under business hours, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the appointment time does not fall within the configured business hours. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: NOT_ALLOWED
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Appointment time does not falls under business hours
status	string	Required within parent	Indicates the response status. Known values: error

Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Service is not available on the given time, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the selected service is unavailable at the specified appointment time. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: NOT_ALLOWED
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Service is not available on the given time
status	string	Required within parent	Indicates the response status. Known values: error

Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when an appointment is marked as completed without a job sheet. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: NOT_ALLOWED
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: Appointment cannot be marked as completed without creating the jobsheet
status	string	Required within parent	Indicates the response status. Known values: error

Create Appointment records — response body — data data item code, details, message, status

Field	Type	Presence	Description and constraints
$	object	Root	Represents a successful result item in the Multi-Status response, containing the result code, details, message, and status. Additional keys: not allowed
code	string	Optional	Represents the result code for the appointment record operation. Maximum length: 255
details	Model	Optional	Expand Delete an Appointment by ID — response body — data item details
message	string	Optional	Represents the result message for the appointment record operation. Maximum length: 255
status	string	Optional	Indicates the result status of the appointment record operation. Maximum length: 255

Referenced models: Delete an Appointment by ID — response body — data item details

Create Appointment records — response body — data data item value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a single result item in the Multi-Status response for appointment updates, which is either a success response or an error response for the corresponding appointment record.
$ (anyOf 1)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: required field not found, status: error
$ (anyOf 2)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD UNCHANGED, status: error
$ (anyOf 3)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, DEPENDENT MISMATCH, status: error
$ (anyOf 4)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Service is not available on the given time, status: error
$ (anyOf 5)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Appointment time does not falls under business hours, status: error
$ (anyOf 6)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment Owner is not a part of Service Members, status: error
$ (anyOf 7)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: INVALID DATA, message: invalid data, INVALID DATA, status: error
$ (anyOf 8)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: INVALID DATA, status: error
$ (anyOf 9)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error
$ (anyOf 10)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, status: error
$ (anyOf 11)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as completed before the appointment ends, status: error
$ (anyOf 12)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error
$ (anyOf 13)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as overdue before the appointment ends, status: error
$ (anyOf 14)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be scheduled for past dates, status: error
$ (anyOf 15)	Model	Alternative	Expand Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: mandatory key missing, status: error

Referenced models: Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, status: error, Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: required field not found, status: error, Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Service is not available on the given time, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment Owner is not a part of Service Members, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error, Create Appointment records — response body — data / data / item / value / code: INVALID DATA, message: invalid data, INVALID DATA, status: error, Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Appointment time does not falls under business hours, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be scheduled for past dates, status: error, Create Appointment records — response body — data / data / item / value / code: INVALID DATA, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, DEPENDENT MISMATCH, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as overdue before the appointment ends, status: error, Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: mandatory key missing, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD UNCHANGED, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as completed before the appointment ends, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error

Delete an Appointment by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the single appointment deletion request. Additional keys: not allowed
data	array	Optional	Represents the list of deletion result objects for the deleted appointment record. Maximum items: 1
data[]	Model	Each item	Expand Delete an Appointment by ID — response body — data item

Referenced models: Delete an Appointment by ID — response body — data item

Delete an Appointment by ID — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single item in the response, containing the operation outcome code, details, message, and status. Additional keys: not allowed
code	string	Optional	Represents the result code for the operation. Maximum length: 255
details	Model	Optional	Expand Delete an Appointment by ID — response body — data item details
message	string	Optional	Represents the result message for the operation. Maximum length: 255
status	string	Optional	Indicates the status of the operation. Maximum length: 255

Referenced models: Delete an Appointment by ID — response body — data item details

Delete an Appointment by ID — response body — data item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of an appointment record, including its ID, creation timestamp, and last modification timestamp. Additional keys: not allowed
Created_By	Model	Optional	Expand Delete an Appointment by ID — response body — data item details Created By
Created_Time	string	Optional	Represents the date and time when the appointment record was created. Maximum length: 120
Modified_By	Model	Optional	Expand Delete an Appointment by ID — response body — data item details Modified By
Modified_Time	string	Optional	Represents the date and time when the appointment record was last modified. Maximum length: 120
id	string	Optional	Represents the unique identifier of the appointment record. Maximum length: 255

Referenced models: Delete an Appointment by ID — response body — data item details Created By, Delete an Appointment by ID — response body — data item details Modified By

Delete an Appointment by ID — response body — data item details Created By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	JSON	Optional
email (anyOf 1)	string	Alternative	Represents the email address of the user who created the appointment record. Format: email Maximum length: 33
email (anyOf 2)	null	Alternative	Represents the email address of the user who created the appointment record. Format: email Maximum length: 33
id	JSON	Optional
id (anyOf 1)	string	Alternative	Represents the unique identifier of the user who created the appointment record. Maximum length: 255
id (anyOf 2)	null	Alternative	Represents the unique identifier of the user who created the appointment record. Maximum length: 255
name	JSON	Optional
name (anyOf 1)	string	Alternative	Represents the full name of the user who created the appointment record. Maximum length: 255
name (anyOf 2)	null	Alternative	Represents the full name of the user who created the appointment record. Maximum length: 255

Delete an Appointment by ID — response body — data item details Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	JSON	Optional
email (anyOf 1)	string	Alternative	Represents the email address of the user who last modified the appointment record. Format: email Maximum length: 33
email (anyOf 2)	null	Alternative	Represents the email address of the user who last modified the appointment record. Format: email Maximum length: 33
id	JSON	Optional
id (anyOf 1)	string	Alternative	Represents the unique ID of the user who last modified the appointment record. Maximum length: 255
id (anyOf 2)	null	Alternative	Represents the unique ID of the user who last modified the appointment record. Maximum length: 255
name	JSON	Optional
name (anyOf 1)	string	Alternative	Represents the full name of the user who last modified the appointment record. Maximum length: 255
name (anyOf 2)	null	Alternative	Represents the full name of the user who last modified the appointment record. Maximum length: 255

Delete one or more appointment records — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the bulk appointment deletion request. Additional keys: not allowed
data	array	Optional	Represents the list of deletion result objects for each appointment record in the request. Maximum items: 3
data[]	Model	Each item	Expand Delete an Appointment by ID — response body — data item

Referenced models: Delete an Appointment by ID — response body — data item

Delete one or more appointment records — response body — data data item code, details, message, status

Field	Type	Presence	Description and constraints
$	object	Root	Represents a successful deletion result in the multi-Status response, containing the deleted record ID. Additional keys: not allowed
code	string	Required within parent	Represents the response code for the delete operation. Maximum length: 255
details	object	Required within parent	Represents the details of the deleted appointment record, including the record ID. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the deleted appointment record. Maximum length: 255
message	string	Required within parent	Represents the message for the record deletion. Maximum length: 255
status	string	Required within parent	Indicates the status of the record deletion. Maximum length: 255

Get Appointment Records — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the request to retrieve appointment records, containing the list of appointment objects. Additional keys: allowed
data	array	Required within parent	Represents the list of appointment records returned by the GET request. Maximum items: 200 Minimum items: 1
data[]	Model	Each item	Expand Get Appointment Records — response body — data item

Referenced models: Get Appointment Records — response body — data item

Get Appointment Records — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single appointment record returned in the GET response, containing all appointment details and status information. Additional keys: allowed
$currency_symbol	string	Optional	Represents the currency symbol for the CRM organization's primary currency. Maximum length: 255
$editable	boolean	Optional	Indicates whether the current user has permission to edit the appointment record.
$field_states	JSON	Optional
$field_states (anyOf 1)	null	Alternative	Represents the state of fields with conditional visibility or special behavior. Maximum length: 255
$field_states (anyOf 2)	string	Alternative	Represents the state of fields with conditional visibility or special behavior. Maximum length: 255
$sharing_permission	string	Optional	Represents the sharing permission level of the appointment record for the current user. Maximum length: 255
$status	string	Optional	Represents the Custom View status indicator for the appointment record. Maximum length: 120
Additional_Information	JSON	Optional
Additional_Information (anyOf 1)	null	Alternative	Represents any additional details about the appointment or customer requirements. Maximum length: 32000
Additional_Information (anyOf 2)	string	Alternative	Represents any additional details about the appointment or customer requirements. Maximum length: 32000
Address	JSON	Optional
Address (anyOf 1)	null	Alternative	Represents the address where the service is delivered when the appointment location is Client Address. Maximum length: 255
Address (anyOf 2)	string	Alternative	Represents the address where the service is delivered when the appointment location is Client Address. Maximum length: 255
Appointment_End_Time	string	Optional	Represents the scheduled end date and time of the appointment. Maximum length: 120
Appointment_For	Model	Required within parent	Expand Get Appointment Records — response body — data item Appointment For
Appointment_Name	string	Required within parent	Represents the name of the appointment record. Maximum length: 255
Appointment_Start_Time	string	Required within parent	Represents the scheduled start date and time of the appointment. Maximum length: 120
Cancellation_Note	JSON	Optional
Cancellation_Note (anyOf 1)	null	Alternative	Represents the note explaining the reason for cancelling the appointment. Maximum length: 2000
Cancellation_Note (anyOf 2)	string	Alternative	Represents the note explaining the reason for cancelling the appointment. Maximum length: 2000
Cancellation_Reason	JSON	Optional
Cancellation_Reason (anyOf 1)	null	Alternative	Denotes who cancelled the appointment. Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'. Maximum length: 120
Cancellation_Reason (anyOf 2)	string	Alternative	Denotes who cancelled the appointment. Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'. Maximum length: 120
Cancelled_By	JSON	Optional
Cancelled_By (anyOf 1)	null	Alternative	Represents the user who cancelled the appointment.
Cancelled_By (anyOf 2)	object	Alternative	Represents the user who cancelled the appointment.
Cancelled_Time	JSON	Optional
Cancelled_Time (anyOf 1)	null	Alternative	Represents the date and time when the appointment was cancelled. Maximum length: 120
Cancelled_Time (anyOf 2)	string	Alternative	Represents the date and time when the appointment was cancelled. Maximum length: 120
Contact_Name__s	JSON	Optional
Contact_Name__s (anyOf 1)	null	Alternative	Represents the name and unique ID of the contact associated with the appointment. Maximum length: 255
Contact_Name__s (anyOf 2)	string	Alternative	Represents the name and unique ID of the contact associated with the appointment. Maximum length: 255
Created_By	Model	Optional	Expand Get Appointment Records — response body — data item Created By
Created_Time	string	Optional	Represents the date and time when the appointment record was created. Maximum length: 120
Date_1	JSON	Optional
Date_1 (anyOf 1)	null	Alternative	Represents an additional date field for the appointment record. Maximum length: 20
Date_1 (anyOf 2)	string	Alternative	Represents an additional date field for the appointment record. Maximum length: 20
Duration	JSON	Optional
Duration (anyOf 1)	integer	Alternative	Represents the duration of the appointment in minutes. Format: int32
Duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Job_Sheet_Created__s	boolean	Optional	Indicates whether a job sheet has been created for this appointment. **Possible values**: - true - A job sheet has been created. - false - No job sheet has been created.
Job_Sheet_Description__s	JSON	Optional
Job_Sheet_Description__s (anyOf 1)	null	Alternative	Represents the description of the job sheet associated with the completed appointment. Maximum length: 32000
Job_Sheet_Description__s (anyOf 2)	string	Alternative	Represents the description of the job sheet associated with the completed appointment. Maximum length: 32000
Job_Sheet_Name__s	JSON	Optional
Job_Sheet_Name__s (anyOf 1)	null	Alternative	Represents the name of the job sheet created for the completed appointment. Maximum length: 255
Job_Sheet_Name__s (anyOf 2)	string	Alternative	Represents the name of the job sheet created for the completed appointment. Maximum length: 255
Job_Sheet_Section__s	JSON	Optional
Job_Sheet_Section__s (anyOf 1)	string	Alternative	Represents the job sheet section displayed to the user for a completed appointment. Maximum length: 120
Job_Sheet_Section__s (anyOf 2)	null	Alternative	Represents the job sheet section displayed to the user for a completed appointment. Maximum length: 120
Last_Activity_Time	JSON	Optional
Last_Activity_Time (anyOf 1)	null	Alternative	Represents the date and time of the last activity on the appointment record. Maximum length: 120
Last_Activity_Time (anyOf 2)	string	Alternative	Represents the date and time of the last activity on the appointment record. Maximum length: 120
Location	string	Required within parent	Represents the location where the appointment service is offered. Maximum length: 120
Modified_By	Model	Optional	Expand Get Appointment Records — response body — data item Modified By
Modified_Time	string	Optional	Represents the date and time when the appointment record was last modified. Maximum length: 120
Owner	Model	Required within parent	Expand Get Appointment Records — response body — data item Owner
Record_Status__s	string	Optional	Represents the availability status of the appointment record. Maximum length: 255
Remind_At	JSON	Optional
Remind_At (anyOf 1)	array	Alternative	Represents the list of reminder configurations for the appointment. Maximum items: 100
Remind_At (anyOf 1)[]	Model	Each item	Expand Get Appointment Records — response body — data item Remind At null item
Remind_At (anyOf 2)	null	Alternative	Represents the list of reminder configurations for the appointment. Maximum items: 100
Remind_At (anyOf 2)[]	Model	Each item	Expand Get Appointment Records — response body — data item Remind At null item
Reschedule_Count	JSON	Optional
Reschedule_Count (anyOf 1)	integer	Alternative	Represents the number of times the appointment has been rescheduled. Format: int32
Reschedule_Count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Reschedule_Note	JSON	Optional
Reschedule_Note (anyOf 1)	null	Alternative	Represents the note explaining the reason for rescheduling the appointment. Maximum length: 2000
Reschedule_Note (anyOf 2)	string	Alternative	Represents the note explaining the reason for rescheduling the appointment. Maximum length: 2000
Reschedule_Reason	JSON	Optional
Reschedule_Reason (anyOf 1)	null	Alternative	Denotes who rescheduled the appointment. Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'. Maximum length: 120
Reschedule_Reason (anyOf 2)	string	Alternative	Denotes who rescheduled the appointment. Possible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'. Maximum length: 120
Rescheduled_By	JSON	Optional
Rescheduled_By (anyOf 1)	null	Alternative	Represents the user who rescheduled the appointment.
Rescheduled_By (anyOf 2)	object	Alternative	Represents the user who rescheduled the appointment.
Rescheduled_From	JSON	Optional
Rescheduled_From (anyOf 1)	null	Alternative	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. Maximum length: 120
Rescheduled_From (anyOf 2)	string	Alternative	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. Maximum length: 120
Rescheduled_Time	JSON	Optional
Rescheduled_Time (anyOf 1)	null	Alternative	Represents the date and time when the appointment was rescheduled. Maximum length: 120
Rescheduled_Time (anyOf 2)	string	Alternative	Represents the date and time when the appointment was rescheduled. Maximum length: 120
Rescheduled_To	JSON	Optional
Rescheduled_To (anyOf 1)	null	Alternative	Represents the new appointment start time after rescheduling. Maximum length: 120
Rescheduled_To (anyOf 2)	string	Alternative	Represents the new appointment start time after rescheduling. Maximum length: 120
Service_Name	Model	Required within parent	Expand Get Appointment Records — response body — data item Service Name
Status	string	Optional	Represents the current status of the appointment. Maximum length: 120
Tag	array	Optional	Represents the list of tags associated with the appointment record. Maximum items: 10
Tag[]	string	Each item	Represents a single tag name associated with the appointment. Maximum length: 2000
id	string	Optional	Represents the unique ID of the appointment record. Maximum length: 255

Referenced models: Get Appointment Records — response body — data item Created By, Get Appointment Records — response body — data item Modified By, Get Appointment Records — response body — data item Owner, Get Appointment Records — response body — data item Appointment For, Get Appointment Records — response body — data item Service Name, Get Appointment Records — response body — data item Remind At null item

Get Appointment Records — response body — data item Appointment For

Field	Type	Presence	Description and constraints
$	object	Root	Represents the customer for whom the appointment was created, including the record ID, name, and module information. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the customer record. Maximum length: 255
module	Model	Required within parent	Expand Get Appointment Records — response body — data item Appointment For module
name	string	Required within parent	Represents the full name of the customer. Maximum length: 255

Referenced models: Get Appointment Records — response body — data item Appointment For module

Get Appointment Records — response body — data item Appointment For module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module details for the Appointment_For customer record, including the module API name and ID. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the module for the customer record. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the module. Maximum length: 255

Get Appointment Records — response body — data item Created By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the user who created the appointment record. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the user who created the record. Maximum length: 255
name	string	Required within parent	Represents the full name of the user who created the record. Maximum length: 255

Get Appointment Records — response body — data item Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the user who last modified the appointment record. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the user who last modified the record. Maximum length: 255
name	string	Required within parent	Represents the full name of the user who last modified the record. Maximum length: 255

Get Appointment Records — response body — data item Owner

Field	Type	Presence	Description and constraints
$	object	Root	Represents the service member assigned as the appointment owner, including the user ID, full name, and email address. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the appointment owner. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the appointment owner. Maximum length: 255
name	string	Required within parent	Represents the full name of the appointment owner. Maximum length: 255

Get Appointment Records — response body — data item Remind At null item

Field	Type	Presence	Description and constraints
$	JSON	Root	Each object represents a single reminder configuration, including the time unit and numeric value.
period	string	Optional	Represents the unit of time for the reminder. **Possible values**: - minutes - The reminder is sent a specified number of minutes before the appointment. - hours - The reminder is sent a specified number of hours before the appointment. - days - The reminder is sent a specified number of days before the appointment. Known values: minutes, hours, days
unit	JSON	Optional
unit (anyOf 1)	integer	Alternative	Represents the numeric value of the reminder time. The value of a unit key can be only from **0 to 100**. Format: int32
unit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Appointment Records — response body — data item Service Name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the service for which the appointment was created, including the service ID and name. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the service. Maximum length: 255
name	string	Required within parent	Represents the name of the service for which the appointment was created. Maximum length: 255

Update an Appointment Record by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the request to update appointment records. Additional keys: not allowed
data	array	Optional	Represents the list of result objects for each updated appointment record. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Delete an Appointment by ID — response body — data item

Referenced models: Delete an Appointment by ID — response body — data item

Update appointment records — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for updating appointment records. Additional keys: not allowed
data	array	Required within parent	Represents the data array containing the appointment objects to update. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Create Appointment records — request body — body data item

Referenced models: Create Appointment records — request body — body data item

Update appointment records — response body — data / data / item / code: INVALID DATA, message: the id given seems to be invalid, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the appointment ID provided in the request is invalid. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: INVALID_DATA
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: the id given seems to be invalid
status	string	Required within parent	Indicates the response status. Known values: error