Zoho: Update multiple Cadences (bulk form)

← Cadences operations · Get started

Operation zoho.putupdatecadences

Provider route: PUT /crm/v8/settings/automation/cadences. 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"]["putUpdateCadences"]>[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.putUpdateCadences(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.put_update_cadences(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Optional	Expand Cadence — request body — body

Referenced models: 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

17 more schemas are linked from the tables above, on the schema pages.

Cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for updating the configuration of one or more existing Cadences. Additional keys: not allowed
cadences	array	Required within parent	Represents the list of Cadences to update. Maximum items: 1
cadences[]	object	Each item	Represents the updated configuration for a single Cadence. Additional keys: not allowed
cadences[].description	string	Optional	Represents the updated description of the Cadence. Maximum length: 500
cadences[].execution_details	object	Optional	Represents the updated execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
cadences[].execution_details.unenroll_properties	array	Optional	Represents the updated conditions under which records are automatically unenrolled from the Cadence. Maximum items: 200
cadences[].execution_details.unenroll_properties[]	Model	Each item	Expand Cadence — request body — body cadences item execution details unenroll properties item
cadences[].follow_ups	array	Optional	Represents the updated list of follow-up steps for the Cadence. Maximum items: 100
cadences[].follow_ups[]	Model	Each item	Expand Cadence — request body — body cadences item follow ups item
cadences[].id	string	Optional	Represents the unique identifier of the Cadence to update. Maximum length: 255
cadences[].name	string	Optional	Represents the updated name of the Cadence. Maximum length: 100

Referenced models: Cadence — request body — body cadences item follow ups item, Cadence — request body — body cadences item execution details unenroll properties item

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

Cadence — request body — body cadences item follow ups item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a follow-up action in a Cadence, including its configuration, execution timing, and trigger conditions. Additional keys: not allowed
action	Model	Optional	Expand Cadence — request body — body cadences item follow ups item action Cadence followup action (Required)
execute_after	Model	Optional	Expand Cadence — request body — body cadences item follow ups item execute after Cadence followup execute_after
id	string	Optional	Represents the unique identifier of the follow-up action. Maximum length: 255
parent_follow_up	object	Optional	Represents the parent follow-up action in the Cadence sequence. Additional keys: not allowed
parent_follow_up.id	string	Optional	Represents the unique identifier of the parent follow-up action. Maximum length: 255
parent_follow_up.reference_id	string	Optional	Represents the reference identifier of the parent follow-up action. Maximum length: 255
reference_id	string	Optional	Represents the reference identifier of the follow-up action. Maximum length: 255
triggers	array	Optional	Represents the list of trigger conditions that initiate this follow-up action. Maximum items: 500
triggers[]	string	Each item	Represents a trigger condition for the follow-up action. Maximum length: 255

Referenced models: Cadence — request body — body cadences item follow ups item action, Cadence — request body — body cadences item follow ups item execute after

Cadence — request body — body cadences item execution details unenroll properties item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the unenrollment condition configuration for a Cadence. Additional keys: not allowed
details	object or null	Optional	Represents the additional details for the unenrollment condition.
type	string	Required within parent	Represents the type of unenrollment condition for the Cadence. Possible values: automatic_unenroll - Unenroll records automatically based on the configured condition. end_date - Unenroll records when the specified end date is reached. criteria - Unenroll records that meet the specified criteria. followup_criteria - Unenroll records based on follow-up criteria. One of: automatic_unenroll, end_date, criteria, followup_criteria

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 — request body — body cadences item follow ups item action

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a follow-up action in a Cadence, including its type, identifier, and configuration details.
$ (anyOf 1)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: tasks
$ (anyOf 2)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: email notifications
$ (anyOf 3)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call
$ (anyOf 4)	Model	Alternative	Expand Cadence — request body — body / cadences / item / follow_ups / item / action / type: whatsapp message notification

Referenced models: Cadence — request body — body / cadences / item / follow_ups / item / action / type: tasks, Cadence — request body — body / cadences / item / follow_ups / item / action / type: email notifications, Cadence — request body — body / cadences / item / follow_ups / item / action / type: schedule call, Cadence — request body — body / cadences / item / follow_ups / item / action / type: whatsapp message notification

Cadence — request body — body cadences item follow ups item execute after

Field	Type	Presence	Description and constraints
$	object	Root	Represents the execution delay configuration for a follow-up action, specifying the period unit and numeric value. Additional keys: not allowed
period	string	Required within parent	Represents the time unit for the follow-up execution delay. Possible values: minutes - Execution delay in minutes. hours - Execution delay in hours. business_hours - Execution delay in business hours. days - Execution delay in days. business_days - Execution delay in business days. months - Execution delay in months. One of: minutes, hours, business_hours, days, business_days, months
unit	integer	Required within parent	Represents the numeric value of the execution delay, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1

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

Policy, approvals and errors

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