Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Appointments S API

The Appointments S API from Zoho — 2 operation(s) for appointments s.

Zoho Appointments S API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Appointments S. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 7 operations across 2 paths, and defines 47 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

7 operations 2 paths 47 schemas 2 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho Appointments S API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 7

Across 2 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Appointments S 7
GET
/Appointments__s
GET /Appointmentss
getAppointmentsS → 200400
PUT
/Appointments__s
PUT /Appointmentss
putAppointmentsS body → 200207400
POST
/Appointments__s
POST /Appointmentss
postAppointmentsS body → 200207400
DELETE
/Appointments__s
DELETE /Appointmentss/{ids}
deleteAppointmentsS 1 param → 200207400
GET
/Appointments__s/{appointmentId}
GET /Appointmentss/{appointmentId}
getAppointmentById 1 param → 200400
PUT
/Appointments__s/{appointmentId}
PUT /Appointmentss/{id}
updateAppointmentById 2 params body → 200400
DELETE
/Appointments__s/{appointmentId}
DELETE /Appointmentss/id
deleteId 1 param → 200400

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are DataNested (42 properties), GETDataNested (41 properties), DetailsNested (5 properties), ErrorResponseCore1944579470 (4 properties). Each schema is shown below with its type and property counts.

ErrorResponseCore1944579470
object
the id given seems to be invalid
4 properties 4 required
ErrorResponseCore201487910
object
Appointment cannot be scheduled for past dates
4 properties 4 required
DataNested1
object
Nested schema for data
4 properties
PutappointmentssRequest
object
Request body schema
1 property 1 required
ErrorResponseCore1604218709
object
invalid module
4 properties 4 required
ErrorResponseCore1544688711
object
Auto-generated from 207 Multi-Status error item
4 properties 4 required
GETOwnerNested
object
Nested schema for Owner
3 properties 3 required
ErrorResponseCore2137699283
object
Auto-generated from 207 Multi-Status error item
4 properties 4 required
PostappointmentssResponse200
object
appointment creation success response
1 property
ErrorResponseCore1875045219
object
invalid method request
4 properties 4 required
AppointmentForNested
object
Contains the name, ID and the module's API name of the customer for whom you are creating the appointment.
3 properties
ErrorResponseCore1277582131
object
Appointment Owner is not a part of Service Members
4 properties 4 required
ErrorResponseCore1168955151
object
Auto-generated from 207 Multi-Status error item
4 properties 4 required
ModifiedByNested
object
modified by
3 properties
CreatedByNested
object
appointment created by
3 properties
ErrorResponseCore1009543207
object
Invalid data type for field: data
4 properties 4 required
ErrorResponseCore2114620743
object
the given module name is not exist in multimodulelookup for AppointmentFor.module.apiname
4 properties 4 required
GETDataNested
object
Nested schema for data
41 properties 35 required
ErrorResponseCore653152835
object
Appointment cannot be marked as completed before the appointment ends
4 properties 4 required
ErrorResponseCore1720623915
object
"appointment for " mandatory not found
4 properties 4 required
GETAppointmentForNested
object
Nested schema for AppointmentFor
3 properties 3 required
ErrorResponseCore1593946428
object
invalid data expected "jsonobject" for AppointmentFor.module
4 properties 4 required
DeleteappointmentssResponse200
object
appointment delete success response
1 property
ErrorResponseCore261228299
object
RescheduledFrom cannot be empty
4 properties 4 required
OwnerNested
object
Represents the ID of the service member who will provide the service for this appointment.
3 properties
PutappointmentssResponse200
object
appointment update success response
1 property
ModuleNested
object
module name
2 properties
DeleteidResponse200
object
appointment delete success response
1 property
ErrorResponseCore1332683101
object
To Update the fields of Cancellation Information Section, value of Status should be Cancelled
4 properties 4 required
ErrorResponseCore899638570
object
Job Sheet can be created only for completed appointment
4 properties 4 required
ErrorResponseCore1090893661
object
Appointment cannot be marked as completed without creating the jobsheet
4 properties 4 required
GETModifiedByNested
object
Nested schema for ModifiedBy
3 properties 3 required
GETServiceNameNested
object
Nested schema for ServiceName
2 properties 2 required
GetappointmentssResponse200
object
appointment records get , success response
1 property 1 required
PostappointmentssRequest
object
Request body schema
1 property 1 required
ErrorResponseCore622374562
object
RescheduleFrom and AppointmentStartTime cannot be same
4 properties 4 required
ErrorResponseCore55175210
object
mandatory key missing unit.
4 properties 4 required
ServiceNameNested
object
Contains the name and distinctive ID of the service for which you are creating the appointment.
2 properties
DetailsNested
object
Nested schema for details
5 properties
Delete207SuccessResponse
object
Success response schema for DELETE 207 multi-status
4 properties 4 required
ErrorResponseCore1207168962
object
Service is not available on the given time
4 properties 4 required
GETModuleNested
object
Nested schema for module
2 properties 2 required
GETCreatedByNested
object
Nested schema for CreatedBy
3 properties 3 required
ErrorResponseCore496791912
object
Appointment cannot be marked as overdue before the appointment ends
4 properties 4 required
DataNested
object
data array contains post request body
42 properties 4 required
Post207multistatusResponse207
object
Generated schema for dataSuccess
4 properties
ErrorResponseCore1818284114
object
Appointment time does not falls under business hours
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-appointments-s-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ