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 Notes API

The Notes API from Zoho — 4 operation(s) for notes.

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

Tagged areas include Notes. 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 14 operations across 4 paths, and defines 24 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

14 operations 4 paths 24 schemas 4 DELETE4 GET2 POST4 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 Notes API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 14

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

Notes 14
GET
/{parentRecordModule}/{parentRecordId}/Notes
List Notes for a Record
getNotes 7 params → 200204400401404500
POST
/{parentRecordModule}/{parentRecordId}/Notes
Create Notes for a Record
createNotes 2 params body → 201207400401403404500
PUT
/{parentRecordModule}/{parentRecordId}/Notes
Update Multiple Notes for a Record
updateBulkNotes 2 params body → 200207400401404500
DELETE
/{parentRecordModule}/{parentRecordId}/Notes
Delete Note(s) for a Record
deleteBulkNotes 3 params → 200207400401404500
GET
/{parentRecordModule}/{parentRecordId}/Notes/{noteId}
Get a Specific Note
getNotesById 3 params → 200204400401404500
PUT
/{parentRecordModule}/{parentRecordId}/Notes/{noteId}
Update a Note
updateNotes 3 params body → 200400401404500
DELETE
/{parentRecordModule}/{parentRecordId}/Notes/{noteId}
Delete a Specific Note
deleteNotes 3 params → 200400401404500
GET
/Notes
Get Notes
getNotesModule 7 params → 200204400401404500
POST
/Notes
Create Notes
createNotesModule body → 201207400401403404500
PUT
/Notes
Update Notes
updateNotesModule body → 200207400401404500
DELETE
/Notes
Delete Notes
deleteNotesModule 1 param → 200207400401404500
GET
/Notes/{id}
Get a Specific Note
getNoteById 2 params → 200204400401404500
PUT
/Notes/{id}
Update a Specific Note
updateNoteById 1 param body → 200400401404500
DELETE
/Notes/{id}
Delete a Specific Note
deleteNoteById 1 param → 200400401404500

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are InvalidDataLimitExceededError (4 properties), InvalidIdError (4 properties), ExpiredValueError (4 properties), RequiredParamMissingError (4 properties). Each schema is shown below with its type and property counts.

MandatoryNotFoundError
object
Error response for mandatory field not found
1 property 1 required
CannotPerformActionError
object
Error response when user cannot perform action on a record
1 property 1 required
NotAllowedError
object
Error response when operation is not allowed
1 property 1 required
DiscretePaginationLimitExceededError
object
Error response for pagination limit exceeded
4 properties 4 required
BadRequestError
object
Error response schema for bad requests (INVALIDMODULE, INVALIDDATA, NOTSUPPORTED)
4 properties 4 required
RequiredParamMissingError
object
Error response for required parameter missing
4 properties 4 required
InvalidDataError
object
Error response for invalid data
1 property 1 required
ExpectedFieldMissingError
object
Error response for missing expected fields
1 property 1 required
NotAllowedErrorSingle
object
Error response when operation is not allowed in single record operations
1 property 1 required
CannotPerformActionErrorSingle
object
Error response when user cannot perform action on a record in single record operations
1 property 1 required
FileSizeExceedsError
object
Error response when attachment file size exceeds the limit
1 property 1 required
NoPermissionError
object
Error response when user lacks required permissions
1 property 1 required
MandatoryNotFoundError_2
object
Error response for mandatory field not found
1 property 1 required
CannotPerformActionError_2
object
Error response when user cannot perform action on a record
1 property 1 required
InvalidDataLimitExceededError
object
Error response when data array exceeds maximum limit
4 properties 4 required
NotAllowedError_2
object
Error response when operation is not allowed
1 property 1 required
InvalidIdError
object
Error response when an invalid record ID is provided
4 properties 4 required
ExpectedFieldMissingErrorSingle
object
Error response for missing expected fields in single record operations
1 property 1 required
InvalidDataError_2
object
Error response for invalid field data
1 property 1 required
ExpectedFieldMissingError_2
object
Error response for missing expected fields
1 property 1 required
InvalidDataErrorSingle
object
Error response for invalid data in single record operations
1 property 1 required
ExpiredValueError
object
Error response when a token or value has expired
4 properties 4 required
FileSizeExceedsError_2
object
Error response when attachment file size exceeds the limit
1 property 1 required
NoPermissionError_2
object
Error response when user lacks required permissions
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-notes-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