Add notes to a record

POST/{parentRecordModule}/{parentRecordId}/Notes

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Add notes to a record action (under Notes).
Fill in the fields below, then reference the result from later steps as {{addNotesToARecord.response.data}}.

Request

Path parameters

parentRecordModulestringrequired

Specify the API name of the parent record module. Refer to [Get Modules](modules.yaml#$.paths./settings/modules.get) for the list of supported modules.

parentRecordIdstring (int64)required

Specify the unique numeric ID of the parent record.

Request body

Enter the body as JSON in the step's Body field.

dataarray<object>required

A JSON array containing the notes to create.

Note_Contentstring

Specify the content of the note.

Note_Titlestring

Provide the title of the note.

Parent_Idobject2 fields

Specify the parent record for this note.

json

{
  "data": [
    {
      "Note_Content": "string",
      "Note_Title": "string",
      "Parent_Id": {
        "module": {
          "api_name": "string",
          "id": "string"
        },
        "id": "string"
      }
    }
  ]
}

Response

Returns 201 with an object. Read it in later steps with {{addNotesToARecord.response.data.<field>}}.

dataarray<object>

JSON array representing the list of action status objects for each note created in this request.

codestringrequired

Represents the result code for this note creation.

One ofSUCCESS

messagestringrequired

Represents the result message for this note creation.

statusstringrequired

Represents the status of this note creation.

One ofsuccess

detailsobjectrequired5 fields

Contains the details of the created note record.

json

{
  "data": [
    {
      "code": "SUCCESS",
      "message": "string",
      "status": "success",
      "details": {
        "id": "string",
        "Modified_Time": "2025-01-01T00:00:00Z",
        "Created_Time": "2025-01-01T00:00:00Z",
        "Created_By": {
          "name": "string",
          "id": "string"
        },
        "Modified_By": {
          "name": "string",
          "id": "string"
        }
      }
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?