Zoho: Upload files to ZFS

← Files operations · Get started

Operation zoho.uploadfiles

Provider route: POST /crm/v8/files. 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["files"]["uploadFiles"]>[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.files.uploadFiles(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.files.upload_files(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.inline	string	Optional	One of: inline
body	object	Required within parent	Multipart form data for uploading one or more files to the Zoho File System. Additional keys: not allowed
body.file	array	Required within parent	Upload one or more files using repeated file keys in the multipart form data. Maximum items: 10
body.file[]	object	Each item	Specify the binary content of the file to upload. 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 response schema for a successful file upload to the Zoho File System. Additional keys: not allowed
data	array	Required within parent	Contains the array of upload results, one object per file submitted in the request. The order corresponds to the order of files in the multipart request. Maximum items: 10 Minimum items: 1
data[]	object	Each item	Represents the upload result for a single file, including its status, success code, and file metadata. Additional keys: not allowed
data[].code	string	Required within parent	Represents the success code for the upload operation. Possible values: SUCCESS - The file uploaded to ZFS without errors. Known values: SUCCESS
data[].details	object	Required within parent	Contains the file metadata for the uploaded file, including the unique identifier for CRM record association. Additional keys: not allowed
data[].details.id	string	Required within parent	Unique file identifier in ZFS. Use this ID to attach the file to CRM records or retrieve it via GET /files Maximum length: 150 Minimum length: 1
data[].details.name	string	Required within parent	Represents the original filename as provided in the upload request. Maximum length: 500 Minimum length: 1
data[].message	string	Required within parent	Represents the success message confirming the file upload. Maximum length: 500
data[].status	string	Required within parent	Represents the upload result status. Possible values: success - The file uploaded to ZFS without errors. Known values: success

Policy, approvals and errors

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