Zoho: Related Note — related Notes update Related Note By Id

← Related notes operations · Get started

Operation zoho.updaterelatednotebyid

Provider route: PUT /crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}. 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"]["updateRelatedNoteById"]>[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.updateRelatedNoteById(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.update_related_note_by_id(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]+$
path.noteId	string	Required within parent	Format: int64 Pattern: ^[0-9]+$
body	object	Required within parent	Request payload for updating the title and content of a specific note. Additional keys: not allowed
body.data	array	Required within parent	Specify the note fields to update. Maximum items: 1
body.data[]	object	Each item	A note object containing the fields to update. Additional keys: allowed
body.data[].Note_Content	string	Optional	Specify the updated content of the note. Maximum length: 65535
body.data[].Note_Title	string	Optional	Specify the updated title of the note. Maximum length: 120

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
$	object	Root	Success response for single note update, containing the action status and details of the updated note. Additional keys: not allowed
data	array	Required within parent	Represents the list of action status objects for the updated note. Maximum items: 200
data[]	object	Each item	Represents the action status for the note update. Additional keys: not allowed
data[].code	string	Required within parent	Represents the result code for this note update. Known values: SUCCESS
data[].details	Model	Required within parent	Expand Related Note — related Notes update Related Note By Id — response body — data item details
data[].message	string	Required within parent	Represents the result message for this note update. Maximum length: 500
data[].status	string	Required within parent	Represents the status of this note update. Known values: success

Referenced models: Related Note — related Notes update Related Note By Id — response body — data item details

Schemas

Related Note — related Notes update Related Note By Id — response body — data item details

Field	Type	Presence	Description and constraints
$	object	Root	Contains the details of the updated note record. Additional keys: not allowed
Created_By	object	Required within parent	Represents the user who created the note. Additional keys: not allowed
Created_By.id	string	Required within parent	Represents the ID of the user who created the note. Format: int64
Created_By.name	string	Required within parent	Represents the name of the user who created the note. Maximum length: 255
Created_Time	string	Required within parent	Represents the creation date and time of the note. Format: date-time
Modified_By	object	Required within parent	Represents the user who last modified the note. Additional keys: not allowed
Modified_By.id	string	Required within parent	Represents the ID of the user who last modified the note. Format: int64
Modified_By.name	string	Required within parent	Represents the name of the user who last modified the note. Maximum length: 255
Modified_Time	string	Required within parent	Represents the date and time when the note was last modified. Format: date-time
id	string	Required within parent	Represents the unique identifier of the updated note. Format: int64

Policy, approvals and errors

SDK function policy ID: zoho.updaterelatednotebyid. Catalog operation: updateRelatedNoteById. 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