Zoho: Create cadence

← Cadences operations · Get started

Operation zoho.postcadences

Provider route: POST /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"]["postCadences"]>[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.postCadences(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_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 Create cadence — request body — body

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

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

Create cadence — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for creating a new Cadence with follow-up steps and action configurations. Additional keys: not allowed
cadences	array	Required within parent	Represents the list of Cadences to create. Maximum items: 1
cadences[]	object	Each item	Represents the configuration for the new Cadence, including its follow-up steps, execution details, and enrollment settings. Additional keys: not allowed
cadences[].custom_view	object	Optional	Represents the Custom View used for automatic record enrollment in the Cadence. Additional keys: not allowed
cadences[].custom_view.id	string	Required within parent	Represents the unique identifier of the Custom View. Format: int64 Maximum length: 255
cadences[].description	string	Optional	Represents the description of the Cadence. Maximum length: 500
cadences[].execution_details	object	Optional	Represents the execution frequency and unenrollment configuration for the Cadence. Additional keys: not allowed
cadences[].execution_details.execute_every	Model	Optional	Expand Create cadence — request body — body cadences item execution details execute every
cadences[].execution_details.unenroll_properties	array	Optional	Represents the 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 list of follow-up steps configured for the Cadence. Maximum items: 100
cadences[].follow_ups[]	object	Each item	Represents a single follow-up step in the Cadence, including its action and trigger configuration. Additional keys: not allowed
cadences[].follow_ups[].action	Model	Required within parent	Expand Cadence — request body — body cadences item follow ups item action Cadence followup action (Required)
cadences[].follow_ups[].execute_after	Model	Optional	Expand Cadence — request body — body cadences item follow ups item execute after
cadences[].follow_ups[].parent_follow_up	object	Optional	Represents the parent follow-up step that this step branches from. Additional keys: not allowed
cadences[].follow_ups[].parent_follow_up.reference_id	string	Optional	Represents the reference identifier of the parent follow-up step. Maximum length: 255
cadences[].follow_ups[].reference_id	string	Optional	Represents the unique reference identifier for the follow-up step within the Cadence. Maximum length: 255
cadences[].follow_ups[].triggers	array	Optional	Represents the list of trigger conditions that determine when this follow-up step executes. Maximum items: 500
cadences[].follow_ups[].triggers[]	string	Each item	Represents a single trigger condition for the follow-up step. Maximum length: 255
cadences[].id	string	Optional	Represents the unique identifier of the Cadence. Maximum length: 255
cadences[].module	Model	Required within parent	Expand Get Cadence analytics — response body — cadences item module
cadences[].name	string	Required within parent	Represents the name of the Cadence. Maximum length: 100
cadences[].type	string	Required within parent	Represents the enrollment type of the Cadence. Possible values: custom_view - Automatically enrolls records matching a Custom View. manual_enrollment - Allows manual enrollment of records into the Cadence. One of: custom_view, manual_enrollment

Referenced models: Cadence — request body — body cadences item follow ups item action, Cadence — request body — body cadences item follow ups item execute after, Create cadence — request body — body cadences item execution details execute every, Get Cadence analytics — response body — cadences item module, 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 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

Create cadence — request body — body cadences item execution details execute every

Field	Type	Presence	Description and constraints
$	object or null	Root	Represents the recurring execution interval for a Cadence, specifying the frequency period and numeric value. Additional keys: not allowed
period	string	Required within parent	Represents the frequency interval for recurring Cadence execution. Possible values: immediately - Execute immediately after each enrollment trigger. hours - Execute at the specified number of hours interval. days - Execute at the specified number of days interval. weeks - Execute at the specified number of weeks interval. One of: immediately, hours, days, weeks
unit	integer	Optional	Represents the numeric value of the execution interval, expressed in the specified period unit. Format: int32 Maximum: 99 Minimum: 1

Get Cadence analytics — response body — cadences item module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the API name and identifier of a CRM module. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the CRM module. Maximum length: 255
id	string	Optional	Represents the unique identifier of the CRM module. Format: int64 Maximum length: 255

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 — request body — body / cadences / item / follow_ups / item / action / type: tasks

Field	Type	Presence	Description and constraints
$	object	Root	Represents the follow-up step configuration for a task action in a Cadence. Additional keys: not allowed
id	string	Optional	Represents the unique identifier of the task action. Maximum length: 255
type	string	Required within parent	Represents the action type for this follow-up step. One of: tasks

Policy, approvals and errors

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