Notes. 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": "Notes",
"description": "Notes",
"version": "8.0"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"paths": {
"/Notes": {
"get": {
"operationId": "getNotesModule",
"summary": "Get Notes",
"description": "Retrieves a list of notes.",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.notes.READ"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/Fields"
},
{
"$ref": "#/components/parameters/Ids"
},
{
"$ref": "#/components/parameters/PerPage"
},
{
"$ref": "#/components/parameters/Page"
},
{
"$ref": "#/components/parameters/PageToken"
},
{
"$ref": "#/components/parameters/SortOrder"
},
{
"$ref": "#/components/parameters/SortBy"
}
],
"responses": {
"200": {
"description": "Successful response with note records",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Response containing note data and pagination information",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "Array of note records",
"maxItems": 200,
"items": {
"type": "object",
"description": "A note record with static fields and dynamic additional properties",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the note",
"format": "int64"
},
"Note_Title": {
"type": [
"string",
"null"
],
"description": "The title of the note",
"maxLength": 120
},
"Note_Content": {
"type": [
"string",
"null"
],
"description": "The content/body of the note",
"maxLength": 65535
},
"$attachments": {
"type": [
"array",
"null"
],
"description": "Attachments associated with the note",
"maxItems": 5,
"items": {
"type": "object",
"description": "Attachment file details",
"additionalProperties": true,
"properties": {
"$file_id": {
"type": "string",
"description": "Unique file identifier for the attachment",
"maxLength": 255
},
"File_Name": {
"type": "string",
"description": "Name of the attached file",
"maxLength": 255
},
"Size": {
"type": "string",
"description": "File size in bytes",
"format": "int64"
},
"id": {
"type": "string",
"description": "Unique identifier of the attachment record",
"format": "int64"
}
}
}
},
"Parent_Id": {
"type": "object",
"description": "Parent record information",
"additionalProperties": false,
"properties": {
"module": {
"type": "object",
"description": "Module information of the parent record",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the parent module",
"maxLength": 50
},
"id": {
"type": "string",
"description": "Module ID",
"format": "int64"
}
},
"required": [
"api_name",
"id"
]
},
"name": {
"type": "string",
"description": "Name of the parent record",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the parent record",
"format": "int64"
}
},
"required": [
"module",
"id",
"name"
]
}
},
"required": [
"id"
]
}
},
"info": {
"type": "object",
"description": "Pagination metadata",
"additionalProperties": false,
"properties": {
"page": {
"type": "integer",
"format": "int32",
"description": "Current page number"
},
"per_page": {
"type": "integer",
"format": "int32",
"description": "Number of records per page"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Number of records in current page"
},
"more_records": {
"type": "boolean",
"description": "Indicates if more records are available"
},
"next_page_token": {
"type": [
"string",
"null"
],
"description": "Token for fetching the next page",
"maxLength": 2000
},
"previous_page_token": {
"type": [
"string",
"null"
],
"description": "Token for fetching the previous page",
"maxLength": 2000
},
"page_token_expiry": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Expiry time of page tokens"
},
"sort_by": {
"type": "string",
"description": "Field by which the results are sorted",
"maxLength": 50
},
"sort_order": {
"type": "string",
"description": "Sort order of the results",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"page",
"per_page",
"count",
"more_records"
]
}
},
"required": [
"data",
"info"
]
}
}
}
},
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"description": "Bad Request - Invalid parameters or malformed request",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/RequiredParamMissingError"
},
{
"$ref": "#/components/schemas/DiscretePaginationLimitExceededError"
},
{
"$ref": "#/components/schemas/ExpiredValueError"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
},
"post": {
"operationId": "createNotesModule",
"summary": "Create Notes",
"description": "Creates one or more note records.",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.notes.CREATE"
]
}
],
"requestBody": {
"description": "Request body containing note data to create",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Request payload for creating notes",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "Array of note objects to create",
"maxItems": 100,
"items": {
"type": "object",
"description": "Note object with title, content, and parent information",
"additionalProperties": true,
"properties": {
"Note_Content": {
"type": [
"string",
"null"
],
"description": "The content/body of the note",
"maxLength": 65535
},
"Note_Title": {
"type": [
"string",
"null"
],
"description": "The title of the note",
"maxLength": 120
},
"Parent_Id": {
"type": "object",
"description": "Parent record information",
"additionalProperties": false,
"properties": {
"module": {
"type": "object",
"description": "Module information of the parent record",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"description": "API name of the parent module",
"maxLength": 50
},
"id": {
"type": "string",
"description": "Module ID",
"format": "int64"
}
}
},
"id": {
"type": "string",
"description": "Unique identifier of the parent record",
"format": "int64"
}
},
"required": [
"module",
"id"
]
}
}
}
}
},
"required": [
"data"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created - Note(s) successfully created",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Success response for note creation",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "Array of creation results",
"maxItems": 100,
"items": {
"type": "object",
"description": "Individual note creation result",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Result code",
"enum": [
"SUCCESS"
]
},
"message": {
"type": "string",
"description": "Result message",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the operation",
"enum": [
"success"
]
},
"details": {
"type": "object",
"description": "Created note details",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the created note",
"format": "int64"
},
"Modified_Time": {
"type": "string",
"description": "Timestamp when the note was last modified",
"format": "date-time"
},
"Created_Time": {
"type": "string",
"description": "Timestamp when the note was created",
"format": "date-time"
},
"Created_By": {
"type": "object",
"description": "User who created the note",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the user",
"maxLength": 120
},
"id": {
"type": "string",
"description": "Unique identifier of the user",
"format": "int64"
}
},
"required": [
"name",
"id"
]
},
"Modified_By": {
"type": "object",
"description": "User who last modified the note",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the user",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the user",
"format": "int64"
}
},
"required": [
"name",
"id"
]
}
},
"required": [
"id",
"Modified_Time",
"Created_Time",
"Created_By",
"Modified_By"
]
}
},
"required": [
"code",
"message",
"status",
"details"
]
}
}
},
"required": [
"data"
]
}
}
}
},
"207": {
"description": "Multi-Status - Partial success with some records created and some failed",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Multi-status response for note creation with mixed results",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "Array of creation results with mixed success and error statuses",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"description": "Successful note creation result",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Result code",
"enum": [
"SUCCESS"
]
},
"message": {
"type": "string",
"description": "Result message",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the operation",
"enum": [
"success"
]
},
"details": {
"type": "object",
"description": "Created note details",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the created note",
"format": "int64"
},
"Modified_Time": {
"type": "string",
"description": "Timestamp when the note was last modified",
"format": "date-time"
},
"Created_Time": {
"type": "string",
"description": "Timestamp when the note was created",
"format": "date-time"
},
"Created_By": {
"type": "object",
"description": "User who created the note",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the user",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the user",
"format": "int64"
}
},
"required": [
"name",
"id"
]
},
"Modified_By": {
"type": "object",
"description": "User who last modified the note",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name of the user",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the user",
"format": "int64"
}
},
"required": [
"name",
"id"
]
}
},
"required": [
"id",
"Modified_Time",
"Created_Time",
"Created_By",
"Modified_By"
]
}
},
"required": [
"code",
"message",
"status",
"details"
]
},
{
"type": "object",
"description": "Failed note creation result",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"EXPECTED_FIELD_MISSING",
"INVALID_DATA"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 500
},
"status": {
"type": "string",
"description": "Status of the operation",
"enum": [
"error"
]
},
"details": {
"type": "object",
"description": "Error details",
"additionalProperties": true
}
},
"required": [
"code",
"message",
"status",
"details"
]
}
]
}
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "Bad Request - Invalid parameters or malformed request",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ExpectedFieldMissingError"
},
{
"$ref": "#/components/schemas/InvalidDataError"
},
{
"$ref": "#/components/schemas/InvalidDataLimitExceededError"
},
{
"$ref": "#/components/schemas/NotAllowedError"
},
{
"$ref": "#/components/schemas/FileSizeExceedsError"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"description": "Forbidden - User lacks required permissions",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoPermissionError"
}
}
}
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"500": {
"$ref": "#/components/responses/InternalServerError"
}
}
},
"put": {
"operationId": "updateNotesModule",
"summary": "Update Notes",
"description": "Updates one or more existing note records. Either note content or note title must be provided (at least one is mandatory) for each note.",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.modules.notes.UPDATE"
]
}
],
"requestBody": {
"description": "Request body containing note data to update",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Request payload for updating notes",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "Array of note objects to update",
"maxItems": 100,
"items": {
"type": "object",
"description": "Note object with id, title and/or content to update",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the note to update",
"format": "int64"
},
"Note_Content": {
"type": [
"string",
"null"
],
"description": "The content/body of the note",
"maxLength": 65535
},
"Note_Title": {
"type": [
"string",
"null"
],
"description": "The title of the note",
"maxLength": 120
}
},
"required": [
"id"
]
}
}
},
"required": [
"data"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success - Note(s) successfully updated",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Success response for note update",
"additionalProperties": false,
"properties": {
"data": {
"type": "array",
"description": "Array of update results",
"maxItems": 100,
"items": {
"type": "obj
# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-notes-openapi.json