Zoho: Publish a Cadence

← Cadences operations · Get started

Operation zoho.postpublish

Provider route: POST /crm/v8/settings/automation/cadences/{id}/actions/publish. 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["cadences"]["postPublish"]>[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.cadences.postPublish(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.cadences.post_publish(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	Maximum length: 255
body	Model	Optional	Expand Publish a Cadence — request body — body

Referenced models: Publish a Cadence — request body — body

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
$	Model	Root	Expand Cadence — response body

Referenced models: Cadence — response body

Schemas

Cadence — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response returned after a Cadence operation is completed successfully. Additional keys: not allowed
cadences	array	Optional	Represents the list of Cadences with their result status from the operation. Maximum items: 100
cadences[]	Model	Each item	Expand Cadence — response body — cadences item

Referenced models: Cadence — response body — cadences item

Publish a Cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for publishing one or more Cadences. Additional keys: not allowed
cadences	array	Required within parent	Represents the list of Cadences to publish. Maximum items: 1
cadences[]	object or null	Each item	Represents the publish configuration for a single Cadence. Additional keys: not allowed
cadences[].process_existing_records	boolean	Optional	Represents whether existing records should be enrolled in the Cadence upon publication.

Cadence — response body — cadences item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single Cadence operation result, including the result code, message, status, and details. Additional keys: not allowed
code	string	Optional	Represents the result code for the individual Cadence record operation. Maximum length: 255
details	Model	Optional	Expand Cadence — response body — cadences item details
message	string	Optional	Represents the result message for the individual Cadence record operation. Maximum length: 255
status	string	Optional	Represents the result status for the individual Cadence record operation. Maximum length: 255

Referenced models: Cadence — response body — cadences item details

Cadence — response body — cadences item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the nested details of a Cadence operation result, including follow-up actions and resource identifiers. Additional keys: not allowed
draft_cadence	object	Optional	Represents the draft version of the Cadence associated with the operation. Additional keys: not allowed
draft_cadence.id	string	Optional	Represents the unique identifier of the draft Cadence. Maximum length: 255
follow_ups	JSON	Optional
follow_ups (anyOf 1)	null	Alternative	Represents the list of follow-up actions involved in the operation. Maximum items: 100
follow_ups (anyOf 1)[]	Model	Each item	Expand Cadence — response body — cadences item details follow ups null item
follow_ups (anyOf 2)	array	Alternative	Represents the list of follow-up actions involved in the operation. Maximum items: 100
follow_ups (anyOf 2)[]	Model	Each item	Expand Cadence — response body — cadences item details follow ups null item
id	string	Optional	Represents the unique identifier of the resource associated with the operation. Maximum length: 255

Referenced models: Cadence — response body — cadences item details follow ups null item

Cadence — response body — cadences item details follow ups null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a follow-up action, including its identifier and associated action details. Additional keys: not allowed
action	object	Optional	Represents the action associated with the follow-up item. Additional keys: not allowed
action.id	string	Optional	Represents the unique identifier of the follow-up action. Maximum length: 255
action.type	string	Optional	Represents the type of the follow-up action. Maximum length: 255
id	string	Optional	Represents the unique identifier of the follow-up item. Maximum length: 255

Policy, approvals and errors

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