Zoho: Upload a record photo

← Record photo operations · Get started

Operation zoho.uploadrecordphoto

Provider route: POST /crm/v8/{module}/{record}/photo. 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["recordPhoto"]["uploadRecordPhoto"]>[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.recordPhoto.uploadRecordPhoto(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.record_photo.upload_record_photo(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.module	string	Required within parent	Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores. Maximum length: 50
path.record	string	Required within parent	Represents the unique identifier of the RecordGETDataItem record. Format: int64
query	object	Optional	Additional keys: not allowed
query.restrict_triggers	string	Optional	Comma-separated trigger names to restrict. Maximum length: 100
body	object	Required within parent	Represents the schema for the photo upload request, containing the photo file in multipart/form-data format. Additional keys: not allowed
body.file	object	Required within parent	Specify the photo file to upload for the record. Additional keys: not allowed
body.file.filename	string	Required within parent	Minimum length: 1
body.file.content_type	string	Required within parent	Minimum length: 1
body.file.content_base64	string	Required within parent

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	Represents the success response returned when the record photo is uploaded successfully. Additional keys: not allowed
code	string	Required within parent	Represents the success code for the photo upload operation. Possible values: SUCCESS. Known values: SUCCESS
details	object	Required within parent	Represents additional details about the upload operation. Additional keys: not allowed
message	string	Required within parent	Represents the success message describing the result of the upload operation. Maximum length: 1000
status	string	Required within parent	Represents the status of the response. Possible values: success. Known values: success

Policy, approvals and errors

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