Skip to content

Zoho: Publish a function

Zoho functions.publishFunction: arguments, response, policy and SDK examples.

← Functions operations · Get started

Operation zoho.publishfunction

Provider route: POST /crm/v8/settings/functions/{fxIdentifier}/actions/publish. Alter supplies the connection’s credentials and routing.

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["functions"]["publishFunction"]>[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.functions.publishFunction(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.functions.publish_function(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathModelRequired within parentExpand Publish a function — request body — path
bodyModelOptionalExpand Publish a function — request body — body

Referenced models: Publish a function — request body — body, Publish a function — request body — path

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Publish a function — response body

Referenced models: Publish a function — response body

Publish a function — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the successful response returned after a publish operation, containing the results of the publish action.
Additional keys: not allowed
publisharrayRequired within parentRepresents the list of results returned for the publish operation.
Maximum items: 1
publish[]ModelEach itemExpand Publish a function — response body — publish item

Referenced models: Publish a function — response body — publish item

Publish a function — request body — body
FieldTypePresenceDescription and constraints
$objectRootThe request body for publishing a post, containing the publish configuration.
Additional keys: not allowed
publishModelOptionalExpand Publish a function — request body — body publish
This object will be used for publish info

Referenced models: Publish a function — request body — body publish

Publish a function — request body — path
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
fxIdentifierstringRequired within parentMaximum length: 255
fxIdentifier (anyOf 1)JSONAlternativeNumeric identifier of the function.
fxIdentifier (anyOf 1) (allOf 1)stringAll variants applyNumeric identifier of the function.
Format: int64
Maximum length: 19
Minimum length: 5
Pattern: ^[0-9]+$
fxIdentifier (anyOf 2)JSONAlternativeAPI name of the function.
fxIdentifier (anyOf 2) (allOf 1)stringAll variants applyAPI name of the function.
Maximum length: 100
Pattern: ^[A-Za-z][A-Za-z0-9_-]*$
Publish a function — response body — publish item
FieldTypePresenceDescription and constraints
$objectRootRepresents a successful result item for a standalone publish operation, including the result code, function ID, status, and message.
Additional keys: not allowed
codestringRequired within parentRepresents the result code for the operation. Possible values: **SUCCESS** - The operation completed successfully.
Known values: SUCCESS
detailsModelRequired within parentExpand Publish a function — response body — publish item details
messagestringRequired within parentRepresents the success message describing the completed operation.
Maximum length: 255
statusstringRequired within parentRepresents the overall status of the operation. Possible values: **success** - The operation completed without errors.
Known values: success

Referenced models: Publish a function — response body — publish item details

Publish a function — request body — body publish
FieldTypePresenceDescription and constraints
$objectRootSpecify the publish configuration for the function. For **Deluge** functions, specifying this object records the changelog for the published revision. Deluge functions are published automatically regardless of whether this object is specified or not. For **Java, Node.js**, and **Python** functions, specifying this object attempts to publish the function after it is created. If this object is omitted, the function is created in the unpublished state. In that case, use the [Publish Function API](functions.yaml#$.paths./settings/functions/{fxIdentifier}/actions/publish.post) to publish the function later.
Additional keys: not allowed
changelogstring or nullOptionalChangelog message for revision tracking. For Deluge functions, recorded as part of the auto-publish. For non-Deluge functions, recorded when the publish step succeeds.
Maximum length: 250
Publish a function — response body — publish item details
FieldTypePresenceDescription and constraints
$objectRootDetails object returned in success responses, containing the unique identifier of the affected resource.
Additional keys: not allowed
idstringOptionalRepresents the unique identifier of the function that was created, updated, or deleted.
Format: int64

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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.