Zoho: Update a Specific Note

← Notes operations · Get started

Operation zoho.updatenotebyid

Provider route: PUT /crm/v8/Notes/{id}. 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["notes"]["updateNoteById"]>[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.notes.updateNoteById(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.notes.update_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.id	string	Required within parent	Format: int64
body	object	Required within parent	Request payload for updating a note Additional keys: not allowed
body.data	array	Required within parent	Array containing the note to update (single item only) Maximum items: 1
body.data[]	object	Each item	Note object with title and/or content to update Additional keys: allowed
body.data[].Note_Content	string or null	Optional	The content/body of the note Maximum length: 65535
body.data[].Note_Title	string or null	Optional	The 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 note update Additional keys: not allowed
data	array	Required within parent	Array of update results Maximum items: 1
data[]	Model	Each item	Expand Update a Specific Note — response body — data item

Referenced models: Update a Specific Note — response body — data item

Schemas

Update a Specific Note — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Individual note update result Additional keys: not allowed
code	string	Required within parent	Result code Known values: SUCCESS
details	Model	Required within parent	Expand Update a Specific Note — response body — data item details
message	string	Required within parent	Result message Maximum length: 500
status	string	Required within parent	Status of the operation Known values: success

Referenced models: Update a Specific Note — response body — data item details

Update a Specific Note — response body — data item details

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

Policy, approvals and errors

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