Create a Note

Purpose

To create a note in a record.

Request URL

https://fsm.zoho.com/fsm/v1/<module_api_name>/<record_id>/Notes

module_api_name - The API name of the module in whose record you want to create the note

record_id - The unique ID of the record.

Request Method

POST

Scope

scope=ZohoFSM.modules.<module_name>.CREATE

Request Body Parameters

NameTypeDescription
Note_ContentStringThe body of the note
Note_TitleStringThe heading for the note
$attachmentsArrayThe file IDs (file_id) of the attachments you obtain after uploading them to ZFS

Supported Modules

Module NameAPI Name
RequestsRequests
EstimatesEstimates
WorkOrdersWork_Orders
ServiceAppointmentsService_Appointments
ContactsContacts
AssetsAssets

Sample Request

Copiedcurl --request POST 'https://fsm.zoho.com/fsm/v1/Work_Orders/1011000000215001/Notes' \
--header 'Authorization: Zoho-oauthtoken 1000.axxxxxxxxx.xxxxxxxxxx1' \
-d "@newNote.json"

Sample Input

Copied{
    "data": [
        {
            "Note_Content": "This is a test note.",
            "Note_Title": "Test",
            "$attachments": [
                "16806156XXXXXXGwAz1lB"
            ]
        }
    ]
}

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-08-11T11:40:47+05:30",
                "Modified_By": {
                    "name": "Mary Cooper",
                    "id": "1439000000161001"
                },
                "Created_Time": "2023-08-11T11:40:47+05:30",
                "id": "1439000000639003",
                "Created_By": {
                    "name": "Mary Cooper",
                    "id": "1439000000161001"
                }
            },
            "message": "record added",
            "status": "success"
        }
    ]
}