openapi: 3.1.0 info: title: Helpcenter Notes API version: 1.0.0 tags: - name: Notes paths: /{parentRecordModule}/{parentRecordId}/Notes: get: summary: List Notes for a Record description: Retrieves a paginated list of notes associated with a specific parent record in a CRM module. operationId: getNotes security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Contacts.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Accounts.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Deals.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Tasks.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Events.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Calls.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Products.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Vendors.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Cases.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Solutions.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Pricebooks.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Quotes.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Salesorders.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Purchaseorders.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Custom.READ - ZohoCRM.modules.notes.READ parameters: - $ref: '#/components/parameters/ParentRecordModule' - $ref: '#/components/parameters/ParentRecordId' - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' - $ref: '#/components/parameters/SortBy' - $ref: '#/components/parameters/SortOrder' 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: 255 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 previous_page_token: type: - string - 'null' description: Token for fetching the previous page page_token_expiry: type: - string - 'null' format: date-time description: Expiry time of page tokens 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: description: Error response for note retrieval failures oneOf: - $ref: '#/components/schemas/BadRequestError' - $ref: '#/components/schemas/RequiredParamMissingError' - $ref: '#/components/schemas/DiscretePaginationLimitExceededError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes post: summary: Create Notes for a Record description: Creates one or more notes associated with a specific parent record. Either note content or note title must be provided (at least one is mandatory). operationId: createNotes security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Events.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Products.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Pricebooks.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Salesorders.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Purchaseorders.READ - ZohoCRM.modules.notes.CREATE - iam-oauth2-schema: - ZohoCRM.modules.Custom.READ - ZohoCRM.modules.notes.CREATE parameters: - $ref: '#/components/parameters/ParentRecordModule' - $ref: '#/components/parameters/ParentRecordId' 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: 200 items: type: object description: Note object with title, content, and parent information additionalProperties: true properties: Note_Content: type: string description: The content/body of the note maxLength: 65535 Note_Title: type: string 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: 200 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: 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 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: 200 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: description: Error response for note creation failures oneOf: - $ref: '#/components/schemas/BadRequestError' - $ref: '#/components/schemas/ExpectedFieldMissingError' - $ref: '#/components/schemas/InvalidDataError' - $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' tags: - Notes put: summary: Update Multiple Notes for a Record description: Updates one or more notes associated with a specific parent record. Either note content or note title must be provided (at least one is mandatory) for each note. operationId: updateBulkNotes security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Events.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Products.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Pricebooks.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Salesorders.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Purchaseorders.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Custom.READ - ZohoCRM.modules.notes.UPDATE parameters: - $ref: '#/components/parameters/ParentRecordModule' - $ref: '#/components/parameters/ParentRecordId' 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: 200 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 description: The content/body of the note maxLength: 65535 Note_Title: type: string 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: 200 items: type: object description: Individual note update 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: Updated note details additionalProperties: false properties: id: type: string description: Unique identifier of the updated 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 required: - data '207': description: Multi-Status - Partial success with some records updated and some failed content: application/json: schema: type: object description: Multi-status response for note update with mixed results additionalProperties: false properties: data: type: array description: Array of update results with mixed success and error statuses maxItems: 200 items: oneOf: - type: object description: Successful note update 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: Updated note details additionalProperties: false properties: id: type: string description: Unique identifier of the updated 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 update result additionalProperties: false properties: code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING - MANDATORY_NOT_FOUND - 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: description: Error response for note update failures oneOf: - $ref: '#/components/schemas/BadRequestError' - $ref: '#/components/schemas/ExpectedFieldMissingError' - $ref: '#/components/schemas/MandatoryNotFoundError' - $ref: '#/components/schemas/InvalidDataError' - $ref: '#/components/schemas/NotAllowedError' - $ref: '#/components/schemas/CannotPerformActionError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes delete: summary: Delete Note(s) for a Record description: Deletes one or more notes associated with a specific parent record using comma-separated note IDs in the query parameter. operationId: deleteBulkNotes security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Deals.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Events.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Calls.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Products.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Cases.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Pricebooks.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Salesorders.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Purchaseorders.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Custom.READ - ZohoCRM.modules.notes.DELETE parameters: - $ref: '#/components/parameters/ParentRecordModule' - $ref: '#/components/parameters/ParentRecordId' - $ref: '#/components/parameters/Ids' responses: '200': description: Success - Note(s) successfully deleted content: application/json: schema: type: object description: Success response for note deletion additionalProperties: false properties: data: type: array description: Array of deletion results maxItems: 200 items: type: object description: Individual note deletion 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: Deleted note details additionalProperties: false properties: id: type: string description: Unique identifier of the deleted note format: int64 required: - id required: - code - message - status - details required: - data '207': description: Multi-Status - Partial success with some records deleted and some failed content: application/json: schema: type: object description: Multi-status response for note deletion with mixed results additionalProperties: false properties: data: type: array description: Array of deletion results with mixed success and error statuses maxItems: 200 items: oneOf: - type: object description: Successful note deletion 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: Deleted note details additionalProperties: false properties: id: type: string description: Unique identifier of the deleted note format: int64 required: - id required: - code - message - status - details - type: object description: Failed note deletion result additionalProperties: false properties: code: type: string description: Error code enum: - 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 properties: id: type: string description: Unique identifier of the note that failed to delete format: int64 required: - code - message - status - details required: - data '400': description: Bad Request - Invalid parameters or missing required parameter content: application/json: schema: description: Error response for note deletion failures oneOf: - $ref: '#/components/schemas/BadRequestError' - $ref: '#/components/schemas/RequiredParamMissingError' - $ref: '#/components/schemas/InvalidDataError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes /{parentRecordModule}/{parentRecordId}/Notes/{noteId}: get: summary: Get a Specific Note description: Retrieves details of a specific note record associated with a parent record in a CRM module. operationId: getNotesById security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Contacts.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Accounts.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Deals.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Tasks.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Events.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Calls.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Products.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Vendors.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Cases.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Solutions.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Pricebooks.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Quotes.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Salesorders.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Purchaseorders.READ - ZohoCRM.modules.notes.READ - iam-oauth2-schema: - ZohoCRM.modules.Custom.READ - ZohoCRM.modules.notes.READ parameters: - $ref: '#/components/parameters/ParentRecordModule' - $ref: '#/components/parameters/ParentRecordId' - $ref: '#/components/parameters/NoteId' responses: '200': description: Successful response with a specific note record content: application/json: schema: type: object description: Response containing note data additionalProperties: false properties: data: type: array description: Array containing the requested note record maxItems: 1 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: 50 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 required: - id required: - data '204': $ref: '#/components/responses/NoContent' '400': description: Bad Request - Invalid parameters content: application/json: schema: description: Error response for single note retrieval failures $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes put: summary: Update a Note description: Updates an existing note associated with a specific parent record. Either note content or note title must be provided (at least one is mandatory). operationId: updateNotes security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Deals.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Events.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Calls.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Products.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Cases.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Pricebooks.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Salesorders.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Purchaseorders.READ - ZohoCRM.modules.notes.UPDATE - iam-oauth2-schema: - ZohoCRM.modules.Custom.READ - ZohoCRM.modules.notes.UPDATE parameters: - $ref: '#/components/parameters/ParentRecordModule' - $ref: '#/components/parameters/ParentRecordId' - $ref: '#/components/parameters/NoteId' requestBody: description: Request body containing note data to update content: application/json: schema: type: object description: Request payload for updating a note additionalProperties: false properties: data: type: array description: Array of note objects to update maxItems: 1 items: type: object description: Note object with title and/or content to update additionalProperties: true properties: Note_Content: type: string description: The content/body of the note maxLength: 65535 Note_Title: type: string description: The title of the note maxLength: 120 required: - data required: true responses: '200': description: Success - Note 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: 200 items: type: object description: Individual note update 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: Updated note details additionalProperties: false properties: id: type: string description: Unique identifier of the updated 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 required: - data '400': description: Bad Request - Invalid parameters or malformed request content: application/json: schema: description: Error response for single note update failures oneOf: - $ref: '#/components/schemas/BadRequestError' - $ref: '#/components/schemas/ExpectedFieldMissingError' - $ref: '#/components/schemas/NotAllowedErrorSingle' - $ref: '#/components/schemas/CannotPerformActionErrorSingle' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes delete: summary: Delete a Specific Note description: Deletes a specific note record associated with a parent record using the note ID in the path. operationId: deleteNotes security: - iam-oauth2-schema: - ZohoCRM.modules.Leads.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Contacts.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Accounts.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Deals.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Tasks.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Events.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Calls.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Products.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Vendors.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Campaigns.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Cases.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Solutions.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Pricebooks.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Quotes.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Salesorders.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Purchaseorders.READ - ZohoCRM.modules.notes.DELETE - iam-oauth2-schema: - ZohoCRM.modules.Custom.READ - ZohoCRM.modules.notes.DELETE parameters: - $ref: '#/components/parameters/ParentRecordModule' - $ref: '#/components/parameters/ParentRecordId' - $ref: '#/components/parameters/NoteId' responses: '200': description: Success - Note(s) successfully deleted content: application/json: schema: type: object description: Success response for note deletion additionalProperties: false properties: data: type: array description: Array of deletion results maxItems: 200 items: type: object description: Individual note deletion 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: Deleted note details additionalProperties: false properties: id: type: string description: Unique identifier of the deleted note format: int64 required: - id required: - code - message - status - details required: - data '400': description: Bad Request - Invalid parameters content: application/json: schema: description: Error response for single note deletion failures $ref: '#/components/schemas/BadRequestError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes /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_2' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/PerPage_2' - $ref: '#/components/parameters/Page_2' - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/SortOrder_2' - $ref: '#/components/parameters/SortBy_2' 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' tags: - Notes 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_2' - $ref: '#/components/schemas/InvalidDataError_2' - $ref: '#/components/schemas/InvalidDataLimitExceededError' - $ref: '#/components/schemas/NotAllowedError_2' - $ref: '#/components/schemas/FileSizeExceedsError_2' '401': $ref: '#/components/responses/Unauthorized' '403': description: Forbidden - User lacks required permissions content: application/json: schema: $ref: '#/components/schemas/NoPermissionError_2' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes 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: object description: Individual note update 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: Updated note details additionalProperties: false properties: id: type: string description: Unique identifier of the updated 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 required: - data '207': description: Multi-Status - Partial success with some records updated and some failed content: application/json: schema: type: object description: Multi-status response for note update with mixed results additionalProperties: false properties: data: type: array description: Array of update results with mixed success and error statuses maxItems: 100 items: oneOf: - type: object description: Successful note update 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: Updated note details additionalProperties: false properties: id: type: string description: Unique identifier of the updated 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 update result additionalProperties: false properties: code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING - MANDATORY_NOT_FOUND - 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_2' - $ref: '#/components/schemas/MandatoryNotFoundError_2' - $ref: '#/components/schemas/InvalidDataError_2' - $ref: '#/components/schemas/InvalidDataLimitExceededError' - $ref: '#/components/schemas/NotAllowedError_2' - $ref: '#/components/schemas/CannotPerformActionError_2' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes delete: operationId: deleteNotesModule summary: Delete Notes description: Permanently deletes one or more notes using comma-separated note IDs. security: - iam-oauth2-schema: - ZohoCRM.modules.notes.DELETE parameters: - $ref: '#/components/parameters/Ids_2' responses: '200': description: Success - Note(s) successfully deleted content: application/json: schema: type: object description: Success response for note deletion additionalProperties: false properties: data: type: array description: Array of deletion results maxItems: 100 items: type: object description: Individual note deletion 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: Deleted note details additionalProperties: false properties: id: type: string description: Unique identifier of the deleted note format: int64 required: - id required: - code - message - status - details required: - data '207': description: Multi-Status - Partial success with some records deleted and some failed content: application/json: schema: type: object description: Multi-status response for note deletion with mixed results additionalProperties: false properties: data: type: array description: Array of deletion results with mixed success and error statuses maxItems: 100 items: oneOf: - type: object description: Successful note deletion 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: Deleted note details additionalProperties: false properties: id: type: string description: Unique identifier of the deleted note format: int64 required: - id required: - code - message - status - details - type: object description: Failed note deletion result additionalProperties: false properties: code: type: string description: Error code enum: - 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 properties: id: type: string description: Unique identifier of the note that failed to delete format: int64 required: - code - message - status - details required: - data '400': description: Bad Request - Invalid parameters or missing required parameter content: application/json: schema: oneOf: - $ref: '#/components/schemas/RequiredParamMissingError' - $ref: '#/components/schemas/InvalidDataError_2' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes /Notes/{id}: get: operationId: getNoteById summary: Get a Specific Note description: Retrieves details of a specific note by its ID. security: - iam-oauth2-schema: - ZohoCRM.modules.notes.READ parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields_2' responses: '200': description: Successfully retrieved the note content: application/json: schema: type: object description: Response containing a single note additionalProperties: false properties: data: type: array description: Array containing the single requested note maxItems: 1 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 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 required: - data '204': $ref: '#/components/responses/NoContent' '400': description: Bad Request - Invalid parameters or malformed request content: application/json: schema: $ref: '#/components/schemas/RequiredParamMissingError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes put: operationId: updateNoteById summary: Update a Specific Note description: Updates a specific note by its ID. Either note content or note title must be provided (at least one is mandatory). security: - iam-oauth2-schema: - ZohoCRM.modules.notes.UPDATE parameters: - $ref: '#/components/parameters/Id' requestBody: description: Request body containing note data to update content: application/json: schema: type: object description: Request payload for updating a note additionalProperties: false properties: data: type: array description: Array containing the note to update (single item only) maxItems: 1 items: type: object description: Note object with title and/or content to update 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 required: - data required: true responses: '200': description: Success - Note 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: 1 items: type: object description: Individual note update 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: Updated note details additionalProperties: false properties: id: type: string description: Unique identifier of the updated 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 required: - data '400': description: Bad Request - Invalid parameters or malformed request content: application/json: schema: oneOf: - $ref: '#/components/schemas/ExpectedFieldMissingErrorSingle' - $ref: '#/components/schemas/InvalidDataErrorSingle' - $ref: '#/components/schemas/InvalidIdError' - $ref: '#/components/schemas/NotAllowedErrorSingle' - $ref: '#/components/schemas/CannotPerformActionErrorSingle' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes delete: operationId: deleteNoteById summary: Delete a Specific Note description: Permanently deletes a specific note by its ID. security: - iam-oauth2-schema: - ZohoCRM.modules.notes.DELETE parameters: - $ref: '#/components/parameters/Id' responses: '200': description: Success - Note successfully deleted content: application/json: schema: type: object description: Success response for note deletion additionalProperties: false properties: data: type: array description: Array of deletion results maxItems: 1 items: type: object description: Individual note deletion 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: Deleted note details additionalProperties: false properties: id: type: string description: Unique identifier of the deleted note format: int64 required: - id required: - code - message - status - details required: - data '400': description: Bad Request - Invalid data content: application/json: schema: oneOf: - $ref: '#/components/schemas/InvalidDataErrorSingle' - $ref: '#/components/schemas/InvalidIdError' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' tags: - Notes components: schemas: MandatoryNotFoundError: type: object description: Error response for mandatory field not found additionalProperties: false properties: data: type: array description: Array of error results maxItems: 200 items: type: object description: Error details for missing mandatory field additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - MANDATORY_NOT_FOUND details: type: object description: Additional details about the error additionalProperties: true properties: api_name: type: string description: The API name of the missing mandatory field maxLength: 255 json_path: type: string description: The JSON path to the missing field maxLength: 500 message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data CannotPerformActionError: type: object description: Error response when user cannot perform action on a record additionalProperties: false properties: data: type: array description: Array of error results maxItems: 200 items: type: object description: Error details for cannot perform action additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - CANNOT_PERFORM_ACTION details: type: object description: Additional details about the error additionalProperties: false message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data NotAllowedError: type: object description: Error response when operation is not allowed additionalProperties: false properties: data: type: array description: Array of error results maxItems: 200 items: type: object description: Error details for not allowed operation additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - NOT_ALLOWED details: type: object description: Additional details about the error additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 500 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data DiscretePaginationLimitExceededError: type: object description: Error response for pagination limit exceeded additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - DISCRETE_PAGINATION_LIMIT_EXCEEDED details: type: object description: Additional details about the pagination limit additionalProperties: true properties: limit: type: integer description: Maximum number of records that can be retrieved without page_token format: int32 message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status BadRequestError: type: object description: Error response schema for bad requests (INVALID_MODULE, INVALID_DATA, NOT_SUPPORTED) additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INVALID_MODULE - INVALID_DATA - NOT_SUPPORTED details: type: object description: Additional details about the error additionalProperties: true message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status RequiredParamMissingError: type: object description: Error response for required parameter missing additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - REQUIRED_PARAM_MISSING details: type: object description: Additional details about the error additionalProperties: true properties: param_name: type: string description: The name of the missing parameter maxLength: 255 message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status InvalidDataError: type: object description: Error response for invalid data additionalProperties: false properties: data: type: array description: Array of error results maxItems: 200 items: type: object description: Error details for invalid data additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INVALID_DATA details: type: object description: Additional details about the error, can include various constraint information additionalProperties: true message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data ExpectedFieldMissingError: type: object description: Error response for missing expected fields additionalProperties: false properties: data: type: array description: Array of error results maxItems: 200 items: type: object description: Error details for missing expected fields additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - EXPECTED_FIELD_MISSING details: type: object description: Additional details about the error additionalProperties: false properties: expected_fields: type: array description: List of expected fields that are missing maxItems: 2 items: type: object description: Expected field details additionalProperties: false properties: api_name: type: string description: API name of the expected field maxLength: 255 json_path: type: string description: JSON path to the expected field maxLength: 500 required: - api_name - json_path required: - expected_fields message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data NotAllowedErrorSingle: type: object description: Error response when operation is not allowed in single record operations additionalProperties: false properties: data: type: array description: Array of error results for single record maxItems: 1 items: type: object description: Error details for not allowed operation additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - NOT_ALLOWED details: type: object description: Additional details about the error additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 500 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data CannotPerformActionErrorSingle: type: object description: Error response when user cannot perform action on a record in single record operations additionalProperties: false properties: data: type: array description: Array of error results for single record maxItems: 1 items: type: object description: Error details for cannot perform action additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - CANNOT_PERFORM_ACTION details: type: object description: Additional details about the error additionalProperties: false message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data FileSizeExceedsError: type: object description: Error response when attachment file size exceeds the limit additionalProperties: false properties: data: type: array description: Array of error results maxItems: 200 items: type: object description: Error details for file size exceeded additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - FILE_SIZE_EXCEEDS details: type: object description: Additional details about the error additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 255 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data NoPermissionError: type: object description: Error response when user lacks required permissions additionalProperties: false properties: data: type: array description: Array of error results maxItems: 200 items: type: object description: Error details for permission denied additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - NO_PERMISSION details: type: object description: Additional details about required permissions additionalProperties: false properties: permissions: type: array description: List of required permissions maxItems: 10 items: type: string description: Permission name maxLength: 255 required: - permissions message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data MandatoryNotFoundError_2: type: object description: Error response for mandatory field not found additionalProperties: false properties: data: type: array description: Array of error results maxItems: 100 items: type: object description: Error details for missing mandatory field additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - MANDATORY_NOT_FOUND details: type: object description: Additional details about the error additionalProperties: false properties: api_name: type: string description: The API name of the missing mandatory field maxLength: 255 json_path: type: string description: The JSON path to the missing field maxLength: 500 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data CannotPerformActionError_2: type: object description: Error response when user cannot perform action on a record additionalProperties: false properties: data: type: array description: Array of error results maxItems: 100 items: type: object description: Error details for cannot perform action additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - CANNOT_PERFORM_ACTION details: type: object description: Additional details about the error additionalProperties: false message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data InvalidDataLimitExceededError: type: object description: Error response when data array exceeds maximum limit additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INVALID_DATA details: type: object description: Additional details about the error additionalProperties: false properties: maximum_length: type: integer description: Maximum allowed number of elements in data array format: int32 api_name: type: string description: API name of the field that exceeded the limit maxLength: 255 json_path: type: string description: JSON path to the field that exceeded the limit maxLength: 500 required: - maximum_length - api_name - json_path message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status NotAllowedError_2: type: object description: Error response when operation is not allowed additionalProperties: false properties: data: type: array description: Array of error results maxItems: 100 items: type: object description: Error details for not allowed operation additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - NOT_ALLOWED details: type: object description: Additional details about the error additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 500 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data InvalidIdError: type: object description: Error response when an invalid record ID is provided additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INVALID_DATA details: type: object description: Additional details about the error additionalProperties: false properties: resource_path_index: type: integer description: Index in the resource path where the invalid ID was found format: int32 required: - resource_path_index message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status ExpectedFieldMissingErrorSingle: type: object description: Error response for missing expected fields in single record operations additionalProperties: false properties: data: type: array description: Array of error results for single record maxItems: 1 items: type: object description: Error details for missing expected fields additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - EXPECTED_FIELD_MISSING details: type: object description: Additional details about the error additionalProperties: false properties: expected_fields: type: array description: List of expected fields that are missing maxItems: 2 items: type: object description: Expected field details additionalProperties: false properties: api_name: type: string description: API name of the expected field maxLength: 255 json_path: type: string description: JSON path to the expected field maxLength: 500 required: - expected_fields message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data InvalidDataError_2: type: object description: Error response for invalid field data additionalProperties: false properties: data: type: array description: Array of error results maxItems: 100 items: type: object description: Error details for invalid data additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INVALID_DATA details: type: object description: Additional details about the error, can include various constraint information additionalProperties: true message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data ExpectedFieldMissingError_2: type: object description: Error response for missing expected fields additionalProperties: false properties: data: type: array description: Array of error results maxItems: 100 items: type: object description: Error details for missing expected fields additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - EXPECTED_FIELD_MISSING details: type: object description: Additional details about the error additionalProperties: false properties: expected_fields: type: array description: List of expected fields that are missing maxItems: 2 items: type: object description: Expected field details additionalProperties: false properties: api_name: type: string description: API name of the expected field maxLength: 255 json_path: type: string description: JSON path to the expected field maxLength: 500 required: - api_name - json_path required: - expected_fields message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data InvalidDataErrorSingle: type: object description: Error response for invalid data in single record operations additionalProperties: false properties: data: type: array description: Array of error results for single record maxItems: 1 items: type: object description: Error details for invalid data additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INVALID_DATA details: type: object description: Additional details about the error additionalProperties: true message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data ExpiredValueError: type: object description: Error response when a token or value has expired additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - EXPIRED_VALUE details: type: object description: Additional details about the expired value additionalProperties: false properties: param_name: type: string description: Name of the parameter with expired value maxLength: 100 required: - param_name message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status FileSizeExceedsError_2: type: object description: Error response when attachment file size exceeds the limit additionalProperties: false properties: data: type: array description: Array of error results maxItems: 100 items: type: object description: Error details for file size exceeded additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - FILE_SIZE_EXCEEDS details: type: object description: Additional details about the error additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 255 json_path: type: string description: JSON path to the field maxLength: 255 required: - api_name - json_path message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data NoPermissionError_2: type: object description: Error response when user lacks required permissions additionalProperties: false properties: data: type: array description: Array of error results maxItems: 100 items: type: object description: Error details for permission denied additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - NO_PERMISSION details: type: object description: Additional details about required permissions additionalProperties: false properties: permissions: type: array description: List of required permissions maxItems: 10 items: type: string description: Permission name maxLength: 255 required: - permissions message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status required: - data parameters: Fields: name: fields in: query required: false description: Comma-separated list of field names to include in the response. Field names must follow API naming conventions. schema: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]*(,[A-Za-z_][A-Za-z0-9_]*)*$ maxLength: 1000 PerPage: name: perPage in: query required: false description: Number of records to return per page schema: type: integer format: int32 minimum: 1 maximum: 200 default: 200 SortBy: name: sort_by in: query required: false description: Field name to sort the notes by schema: type: string enum: - id - Created_Time - Modified_Time maxLength: 50 ParentRecordModule: name: parentRecordModule in: path required: true description: The module API name of the parent record (e.g., Contacts, Leads, Deals, Accounts) schema: type: string pattern: ^[A-Za-z_][A-Za-z0-9_]*$ maxLength: 50 Ids: name: ids in: query required: true description: Comma-separated list of note record IDs to delete. Required for bulk deletion operations. schema: type: string pattern: ^[0-9]+(,[0-9]+)*$ maxLength: 2000 SortOrder: name: sort_order in: query required: false description: Sort order for the results schema: type: string enum: - asc - desc maxLength: 10 ParentRecordId: name: parentRecordId in: path required: true description: The unique identifier of the parent record. Must be a valid numeric record ID. schema: type: string pattern: ^[0-9]+$ format: int64 Page: name: page in: query required: false description: Page number for pagination (starting from 1) schema: type: integer format: int32 minimum: 1 maximum: 10000 default: 1 NoteId: name: noteId in: path required: true description: The unique identifier of the specific note record. Must be a valid numeric record ID. schema: type: string pattern: ^[0-9]+$ format: int64 Fields_2: name: fields in: query required: false description: Comma-separated list of field API names to include in the response schema: type: string maxLength: 1024 PageToken: name: page_token in: query required: false description: Page token for fetching more than 2000 records schema: type: string maxLength: 2000 PerPage_2: name: per_page in: query required: false description: Number of records per page schema: type: integer format: int32 Id: name: id in: path required: true description: Unique identifier of the note schema: type: string format: int64 SortBy_2: name: sort_by in: query required: false description: Field name to sort results by schema: type: string enum: - Modified_Time - Created_Time - id Ids_2: name: ids in: query required: false description: Comma-separated list of note IDs to retrieve specific notes schema: type: string maxLength: 1024 SortOrder_2: name: sort_order in: query required: false description: Sort order (ascending or descending) schema: type: string enum: - asc - desc Page_2: name: page in: query required: false description: Page number for pagination schema: type: integer format: int32 responses: NoContent: description: No content - The request was successful but there are no records to return Unauthorized: description: Unauthorized - Authentication failed content: application/json: schema: type: object description: Error response for authentication failures additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - AUTHENTICATION_FAILURE - OAUTH_SCOPE_MISMATCH details: type: object description: Additional details about the error additionalProperties: false message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status NotFound: description: Not Found - The requested resource does not exist content: application/json: schema: type: object description: Error response for not found requests additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INVALID_URL_PATTERN details: type: object description: Additional details about the error additionalProperties: false message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status InternalServerError: description: Internal Server Error - An unexpected error occurred on the server content: application/json: schema: type: object description: Error response for internal server errors additionalProperties: false properties: code: type: string description: Error code indicating the type of error enum: - INTERNAL_ERROR details: type: object description: Additional details about the error additionalProperties: false message: type: string description: Human-readable error message maxLength: 500 status: type: string description: Status of the response enum: - error required: - code - details - message - status securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter