appointments module api. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 7 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Appointments API",
"description": "appointments module api",
"version": "8"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server for /crm",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"com",
"eu",
"in",
"cn",
"au",
"ca",
"jp"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"paths": {
"/Appointments__s": {
"get": {
"summary": "GET /Appointments__s",
"description": "appointment records get",
"operationId": "getAppointmentsS",
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetappointmentssResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.appointments.READ"
]
}
]
},
"put": {
"summary": "PUT /Appointments__s",
"description": "appointment module records update",
"operationId": "putAppointmentsS",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutappointmentssRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutappointmentssResponse200"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped response containing data",
"properties": {
"data": {
"type": "array",
"allOf": [
{
"contains": {
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
"description": "success response in data",
"minContains": 1
},
{
"contains": {
"$ref": "#/components/schemas/ErrorResponseCore1544688711"
},
"description": "error response in data",
"minContains": 1
}
],
"description": "Array of success or failure data items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1544688711"
}
]
},
"maxItems": 200,
"minItems": 2
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1720623915"
},
{
"$ref": "#/components/schemas/ErrorResponseCore622374562"
},
{
"$ref": "#/components/schemas/ErrorResponseCore261228299"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1207168962"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1818284114"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1277582131"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1593946428"
},
{
"$ref": "#/components/schemas/ErrorResponseCore2114620743"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1332683101"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1090893661"
},
{
"$ref": "#/components/schemas/ErrorResponseCore653152835"
},
{
"$ref": "#/components/schemas/ErrorResponseCore899638570"
},
{
"$ref": "#/components/schemas/ErrorResponseCore496791912"
},
{
"$ref": "#/components/schemas/ErrorResponseCore201487910"
},
{
"$ref": "#/components/schemas/ErrorResponseCore55175210"
}
]
},
"maxItems": 25
}
},
"required": [
"data"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1009543207"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.appointments.UPDATE"
]
}
]
},
"post": {
"summary": "POST /Appointments__s",
"description": "appointment module records creation",
"operationId": "postAppointmentsS",
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostappointmentssRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostappointmentssResponse200"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped response containing data",
"properties": {
"data": {
"type": "array",
"allOf": [
{
"contains": {
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
"description": "success response in data",
"minContains": 1
},
{
"contains": {
"$ref": "#/components/schemas/ErrorResponseCore1168955151"
},
"description": "error response in data",
"minContains": 1
}
],
"description": "Array of success or failure data items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Post207multistatusResponse207"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1168955151"
}
]
},
"maxItems": 200,
"minItems": 2
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1720623915"
},
{
"$ref": "#/components/schemas/ErrorResponseCore622374562"
},
{
"$ref": "#/components/schemas/ErrorResponseCore261228299"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1207168962"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1818284114"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1277582131"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1593946428"
},
{
"$ref": "#/components/schemas/ErrorResponseCore2114620743"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1332683101"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1090893661"
},
{
"$ref": "#/components/schemas/ErrorResponseCore653152835"
},
{
"$ref": "#/components/schemas/ErrorResponseCore899638570"
},
{
"$ref": "#/components/schemas/ErrorResponseCore496791912"
},
{
"$ref": "#/components/schemas/ErrorResponseCore201487910"
},
{
"$ref": "#/components/schemas/ErrorResponseCore55175210"
}
]
},
"maxItems": 25
}
},
"required": [
"data"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1009543207"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.appointments.CREATE"
]
}
]
},
"delete": {
"summary": "DELETE /Appointments__s/{ids}",
"description": "appointment module record delete",
"operationId": "deleteAppointmentsS",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryIds"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteappointmentssResponse200"
}
}
}
},
"207": {
"description": "Multi-Status — Response contains mixed status results",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Wrapped response containing data",
"properties": {
"data": {
"type": "array",
"allOf": [
{
"contains": {
"$ref": "#/components/schemas/Delete207SuccessResponse"
},
"description": "success response in data",
"minContains": 1
},
{
"contains": {
"$ref": "#/components/schemas/ErrorResponseCore2137699283"
},
"description": "error response in data",
"minContains": 1
}
],
"description": "Array of success or failure data items",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Delete207SuccessResponse"
}
]
},
"maxItems": 200,
"minItems": 2
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"$ref": "#/components/schemas/ErrorResponseCore2137699283"
},
"maxItems": 25
}
},
"required": [
"data"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.appointments.DELETE"
]
}
]
}
},
"/Appointments__s/{appointmentId}": {
"get": {
"summary": "GET /Appointments__s/{appointmentId}",
"description": "appointment mode record get by id",
"operationId": "getAppointmentById",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathAppointmentid"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetappointmentssResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.appointments.READ"
]
}
]
},
"put": {
"summary": "PUT /Appointments__s/{id}",
"description": "appointment module records update by appointment id",
"operationId": "updateAppointmentById",
"parameters": [
{
"$ref": "#/components/parameters/ParamQueryId"
},
{
"$ref": "#/components/parameters/ParamPathAppointmentid"
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutappointmentssRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutappointmentssResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorResponseCore1720623915"
},
{
"$ref": "#/components/schemas/ErrorResponseCore622374562"
},
{
"$ref": "#/components/schemas/ErrorResponseCore261228299"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1207168962"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1818284114"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1277582131"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1593946428"
},
{
"$ref": "#/components/schemas/ErrorResponseCore2114620743"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1332683101"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1090893661"
},
{
"$ref": "#/components/schemas/ErrorResponseCore653152835"
},
{
"$ref": "#/components/schemas/ErrorResponseCore899638570"
},
{
"$ref": "#/components/schemas/ErrorResponseCore496791912"
},
{
"$ref": "#/components/schemas/ErrorResponseCore201487910"
},
{
"$ref": "#/components/schemas/ErrorResponseCore55175210"
}
]
},
"maxItems": 25
}
},
"required": [
"data"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1944579470"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.appointments.UPDATE"
]
}
]
},
"delete": {
"summary": "DELETE /Appointments__s/id",
"description": "appointment module record delete by id",
"operationId": "deleteId",
"parameters": [
{
"$ref": "#/components/parameters/ParamPathAppointmentid"
}
],
"responses": {
"200": {
"description": "OK - Successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteidResponse200"
}
}
}
},
"400": {
"description": "Bad Request - The request cannot be processed due to invalid syntax.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "Wrapped error response with data",
"properties": {
"data": {
"type": "array",
"description": "Array of error objects",
"items": {
"$ref": "#/components/schemas/ErrorResponseCore2137699283"
},
"maxItems": 25
}
},
"required": [
"data"
]
},
{
"$ref": "#/components/schemas/ErrorResponseCore1875045219"
},
{
"$ref": "#/components/schemas/ErrorResponseCore1604218709"
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.appointments.DELETE"
]
}
]
}
}
},
"components": {
"schemas": {
"GETDataNested": {
"type": "object",
"additionalProperties": false,
"description": "Nested schema for data",
"properties": {
"Owner": {
"$ref": "#/components/schemas/GETOwnerNested"
},
"$currency_symbol": {
"type": "string",
"description": "Field: $currency_symbol",
"maxLength": 255
},
"Address": {
"type": [
"null",
"string"
],
"description": "Field: Address",
"maxLength": 255
},
"Appointment_Start_Time": {
"type": "string",
"description": "Field: Appointment_Start_Time",
"maxLength": 120
},
"Cancellation_Reason": {
"type": [
"null",
"string"
],
"description": "Field: Cancellation_Reason",
"maxLength": 120
},
"$field_states": {
"type": [
"null",
"string"
],
"maxLength": 255,
"description": "Field: $field_states"
},
"Appointment_For": {
"$ref": "#/components/schemas/GETAppointmentForNested"
},
"Rescheduled_To": {
"type": [
"null",
"string"
],
"description": "Field: Rescheduled_To",
"maxLength": 120
},
"$sharing_permission": {
"type": "string",
"description": "Field: $sharing_permission",
"maxLength": 255
},
"Reschedule_Reason": {
"type": [
"null",
"string"
],
"description": "Field: Reschedule_Reason",
"maxLength": 120
},
"Job_Sheet_Name__s": {
"type": [
"null",
"string"
],
"maxLength": 255,
"description": "Field: Job_Sheet_Name__s"
},
"Additional_Information": {
"type": [
"null",
"string"
],
"description": "Field: Additional_Information",
"maxLength": 32000
},
"Last_Activity_Time": {
"type": [
"null",
"string"
],
"description": "Field: Last_Activity_Time",
"maxLength": 120
},
"Job_Sheet_Created__s": {
"type": "boolean",
"description": "Field: Job_Sheet_Created__s"
},
"Cancelled_Time": {
"type": [
"null",
"string"
],
"description": "Field: Cancelled_Time",
"maxLength": 120
},
"Cancellation_Note": {
"type": [
"null",
"string"
],
"description": "Field: Cancellation_Note",
"maxLength": 2000
},
"Modified_By": {
"$ref": "#/components/schemas/GETModifiedByNested"
},
"Reschedule_Count": {
"type": "integer",
"format": "int32",
"description": "Field: Reschedule_Count"
},
"Rescheduled_By": {
"type": [
"null",
"object"
],
"description": "Field: Rescheduled_By"
},
"Date_1": {
"type": [
"null",
"string"
],
"description": "Field: Date_1",
"maxLength": 20
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"Rescheduled_Time": {
"type": [
"null",
"string"
],
"description": "Field: Rescheduled_Time",
"maxLength": 120
},
"Remind_At": {
"type": [
"array",
"null"
],
"items": {
"description": "reminder time object",
"properties": {
"period": {
"type": "string",
"description": "unit of time for reminder",
"enum": [
"minutes",
"hours",
"days"
]
},
"unit": {
"type": "integer",
"format": "int32",
"description": "value for reminder time"
}
}
},
"description": "Contains the list of units and period of when you want to get the reminders for the appointment.",
"maxItems": 100
},
"Appointment_End_Time": {
"type": "string",
"description": "Appointment End time",
"maxLength": 120
},
"Status": {
"type": "string",
"description": "Appointment Status",
"maxLength": 120
},
"Modified_Time": {
"type": "string",
"description": "Field: Modified_Time",
"maxLength": 120
},
"Service_Name": {
"$ref": "#/components/schemas/GETServiceNameNested"
},
"Created_Time": {
"type": "string",
"description": "Field: Created_Time",
"maxLength": 120
},
"Rescheduled_From": {
"type": [
"null",
"string"
],
"description": "Field: Rescheduled_From",
"maxLength": 120
},
"Cancelled_By": {
"type": [
"null",
"object"
],
"description": "Field: Cancelled_By"
},
"$editable": {
"type": "boolean",
"description": "Field: $editable"
},
"Appointment_Name": {
"type": "string",
"description": "Field: Appointment_Name",
"maxLength": 255
},
"Dura
# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-appointments-openapi.json