Zoho: Related Notes — related Notes create Notes

← Related notes operations · Get started

Operation zoho.createnotes

Provider route: POST /crm/v8/{parentRecordModule}/{parentRecordId}/Notes. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["relatedNotes"]["createNotes"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.relatedNotes.createNotes(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.related_notes.create_notes(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.parentRecordModule	string	Required within parent	Maximum length: 50 Pattern: ^[A-Za-z_][A-Za-z0-9_]*$
path.parentRecordId	string	Required within parent	Format: int64 Pattern: ^[0-9]+$
body	object	Required within parent	Request payload for creating one or more notes. Additional keys: not allowed
body.data	array	Required within parent	A JSON array containing the notes to create. Maximum items: 200
body.data[]	object	Each item	A note object containing the title, content, and parent record information. Additional keys: allowed
body.data[].Note_Content	string	Optional	Specify the content of the note. Maximum length: 65535
body.data[].Note_Title	string	Optional	Provide the title of the note. Maximum length: 120
body.data[].Parent_Id	object	Optional	Specify the parent record for this note. Additional keys: not allowed
body.data[].Parent_Id.id	string	Required within parent	Specify the unique ID of the parent record. Refer to Refer the [GET Records API](record.yaml#.$path./{module}.get) to get valid record IDs. Format: int64
body.data[].Parent_Id.module	object	Required within parent	Represents the details of the requested module. It is mandatory to specify either the API name or the unique ID of the requested module. Refer to [GET Modules API](modules.yaml#$.paths./settings/modules.get) to get the details. Additional keys: not allowed
body.data[].Parent_Id.module.api_name	string	Optional	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. Maximum length: 50
body.data[].Parent_Id.module.id	string	Optional	Specify the unique identifier of the parent record module. Format: int64

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Success response for note creation, containing the action status for each created note. Additional keys: not allowed
$ (anyOf 1).data	array	Required within parent	JSON array representing the list of action status objects for each note created in this request. Maximum items: 200
$ (anyOf 1).data[]	object	Each item	Represents the action status for an individual note creation. Additional keys: not allowed
$ (anyOf 1).data[].code	string	Required within parent	Represents the result code for this note creation. Known values: SUCCESS
$ (anyOf 1).data[].details	object	Required within parent	Contains the details of the created note record. Additional keys: not allowed
$ (anyOf 1).data[].details.Created_By	object	Required within parent	Specifies the user who created the note. Additional keys: not allowed
$ (anyOf 1).data[].details.Created_By.id	string	Required within parent	Indicaates the ID of the user who created the note. Format: int64
$ (anyOf 1).data[].details.Created_By.name	string	Required within parent	Represents the name of the user who created the note. Maximum length: 255
$ (anyOf 1).data[].details.Created_Time	string	Required within parent	Represents the creation date and time of the note. Format: date-time
$ (anyOf 1).data[].details.Modified_By	object	Required within parent	Represents the user who last modified the note. Additional keys: not allowed
$ (anyOf 1).data[].details.Modified_By.id	string	Required within parent	Represents the ID of the user who last modified the note. Format: int64
$ (anyOf 1).data[].details.Modified_By.name	string	Required within parent	Specifies the name of the user who last modified the note. Maximum length: 255
$ (anyOf 1).data[].details.Modified_Time	string	Required within parent	Specifies the date and time when the note was last modified. Format: date-time
$ (anyOf 1).data[].details.id	string	Required within parent	The unique identifier of the created note. Format: int64
$ (anyOf 1).data[].message	string	Required within parent	Represents the result message for this note creation. Maximum length: 500
$ (anyOf 1).data[].status	string	Required within parent	Represents the status of this note creation. Known values: success
$ (anyOf 2)	object	Alternative	Mixed-status response for note creation where some notes were created successfully and others failed. Additional keys: not allowed
$ (anyOf 2).data	array	Required within parent	JSON array representing the list of mixed action status objects for each note in this request. Maximum items: 200
$ (anyOf 2).data[]	JSON	Each item	Represents an individual note creation result, which may be a success or an error.
$ (anyOf 2).data[] (anyOf 1)	object	Alternative	Successful note creation result with action status and note details. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).code	string	Required within parent	Represents the result code for this note creation. Known values: SUCCESS
$ (anyOf 2).data[] (anyOf 1).details	object	Required within parent	Contains the details of the created note record. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).details.Created_By	object	Required within parent	Represents the user who created the note. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).details.Created_By.id	string	Required within parent	Represents the ID of the user who created the note. Format: int64
$ (anyOf 2).data[] (anyOf 1).details.Created_By.name	string	Required within parent	Represents the name of the user who created the note. Maximum length: 255
$ (anyOf 2).data[] (anyOf 1).details.Created_Time	string	Required within parent	Represents the creation date and time of the note. Format: date-time
$ (anyOf 2).data[] (anyOf 1).details.Modified_By	object	Required within parent	Represents the user who last modified the note. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).details.Modified_By.id	string	Required within parent	Represents the ID of the user who last modified the note. Format: int64
$ (anyOf 2).data[] (anyOf 1).details.Modified_By.name	string	Required within parent	Represents the name of the user who last modified the note. Maximum length: 255
$ (anyOf 2).data[] (anyOf 1).details.Modified_Time	string	Required within parent	Represents the date and time when the note was last modified. Format: date-time
$ (anyOf 2).data[] (anyOf 1).details.id	string	Required within parent	Represents the unique identifier of the created note. Format: int64
$ (anyOf 2).data[] (anyOf 1).message	string	Required within parent	Represents the result message for this note creation. Maximum length: 500
$ (anyOf 2).data[] (anyOf 1).status	string	Required within parent	Represents the status of this note creation. Known values: success
$ (anyOf 2).data[] (anyOf 2)	object	Alternative	Failed note creation result with error code and details. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 2).code	string	Required within parent	Represents the error code for this note creation failure. Known values: EXPECTED_FIELD_MISSING, INVALID_DATA
$ (anyOf 2).data[] (anyOf 2).details	object	Required within parent	Contains additional details about the note creation error. Additional keys: allowed
$ (anyOf 2).data[] (anyOf 2).message	string	Required within parent	Represents the error message for this note creation failure. Maximum length: 500
$ (anyOf 2).data[] (anyOf 2).status	string	Required within parent	Represents the status of this note creation failure. Known values: error

Policy, approvals and errors

SDK function policy ID: zoho.createnotes. Catalog operation: createNotes. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source