Zoho: Enroll Records to Cadences

← Cadences execution operations · Get started

Operation zoho.postenrolincadences

Provider route: POST /crm/v8/{module}/actions/enrol_in_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["cadencesExecution"]["postEnrolInCadences"]>[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.cadencesExecution.postEnrolInCadences(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_execution.post_enrol_in_cadences(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.module	string	Required within parent	Maximum length: 100
body	Model	Optional	Expand Enroll Records to Cadences — request body — body

Referenced models: Enroll Records to Cadences — 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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Enroll Records to Cadences — response body — data — Postcadences Response200
$ (anyOf 2)	Model	Alternative	Expand Enroll Records to Cadences — response body — data — Postcadences Response202
$ (anyOf 3)	Model	Alternative	Expand Enroll Records to Cadences — response body — data — Postcadences Response207

Referenced models: Enroll Records to Cadences — response body — data — Postcadences Response200, Enroll Records to Cadences — response body — data — Postcadences Response202, Enroll Records to Cadences — response body — data — Postcadences Response207

Schemas

Enroll Records to Cadences — response body — data — Postcadences Response200

Field	Type	Presence	Description and constraints
$	object	Root	Represents the successful response body for a Cadence enrollment or un-enrollment operation. Additional keys: not allowed
data	array	Optional	Represents the list of operation results for the request. Maximum items: 100
data[]	Model	Each item	Expand Enroll Records to Cadences — response body — data data item — Success Data Nested

Referenced models: Enroll Records to Cadences — response body — data data item — Success Data Nested

Enroll Records to Cadences — response body — data — Postcadences Response202

Field	Type	Presence	Description and constraints
$	object	Root	Represents the asynchronous acceptance response returned when the enrollment or unenrollment request is queued for background processing. Additional keys: not allowed
data	array	Optional	Represents a single-entry array containing the SCHEDULED status marker for the queued enrollment request. Maximum items: 1
data[]	Model	Each item	Expand Enroll Records to Cadences — response body — data data item — Scheduled Data Nested

Referenced models: Enroll Records to Cadences — response body — data data item — Scheduled Data Nested

Enroll Records to Cadences — response body — data — Postcadences Response207

Field	Type	Presence	Description and constraints
$	object	Root	Specify the multi-status response body for a Cadence enrollment or un-enrollment operation where some records succeeded and others failed. Additional keys: not allowed
data	array	Optional	Specify the list of per-record operation results. Each item indicates success or failure for the corresponding record in the request. Maximum items: 100
data[]	JSON	Each item	Specify a single per-record result that indicates success or failure for a specific record in the request.
data[] (anyOf 1)	Model	Alternative	Expand Enroll Records to Cadences — response body — data data item — Success Data Nested
data[] (anyOf 2)	Model	Alternative	Expand Enroll Records to Cadences — response body — data / data / item / code: INVALID DATA, status: error

Referenced models: Enroll Records to Cadences — response body — data / data / item / code: INVALID DATA, status: error, Enroll Records to Cadences — response body — data data item — Success Data Nested

Enroll Records to Cadences — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request payload for enrolling or un-enrolling records in one or more Cadences. Additional keys: not allowed
cadences_ids	array	Required within parent	A list of Cadence IDs to use for the enrollment or un-enrollment operation. Maximum items: 5 Maximum length: 255
cadences_ids[]	string	Each item	A unique identifier of a Cadence. Maximum length: 255
ids	array	Required within parent	Specify the list of record IDs to enroll in or un-enroll from the specified Cadences. Maximum items: 100
ids[]	string	Each item	A unique identifier of a record. Maximum length: 255

Enroll Records to Cadences — response body — data data item — Success Data Nested

Field	Type	Presence	Description and constraints
$	object	Root	Represents a successful per-record operation result. Additional keys: not allowed
code	string	Optional	Represents the result code for the record operation. Maximum length: 255
details	Model	Optional	Expand Enroll Records to Cadences — response body — data data item details
message	string	Optional	Represents the message indicating the outcome of the record operation. Maximum length: 255
status	string	Optional	The status of the record operation. Maximum length: 255

Referenced models: Enroll Records to Cadences — response body — data data item details

Enroll Records to Cadences — response body — data data item — Scheduled Data Nested

Field	Type	Presence	Description and constraints
$	object	Root	Represents the status marker returned with HTTP 202 when the enrollment or unenrollment request is queued for background processing. Additional keys: not allowed
code	string	Optional	Represents the processing status code. For 202 responses, this is always **SCHEDULED**. Known values: SCHEDULED Maximum length: 255
details	object	Optional	Represents additional details about the scheduled operation. This object is currently empty and reserved for future use. Additional keys: allowed
message	string	Optional	Represents the message describing the current processing state of the enrollment request. Maximum length: 255
status	string	Optional	Represents the overall status of the scheduled operation. For 202 responses, this is always **success**. Known values: success Maximum length: 255

Enroll Records to Cadences — response body — data / data / item / code: INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents a failed per-record operation result in a multi-status response. Additional keys: not allowed
code	string	Optional	Indicates the error code for the per-record failure. Possible values: **INVALID_DATA**. Known values: INVALID_DATA Maximum length: 255
details	object	Optional	JSON object specifying the details of the per-record error, including the affected field name and JSON path. Additional keys: allowed
details.api_name	string	Optional	Represents the API name of the request field that caused the per-record error. Possible values: **ids**. Known values: ids Maximum length: 255
details.json_path	string	Optional	Indicates the JSON path to the specific value in the request that triggered the per-record error. Maximum length: 255
message	string	Optional	Represents the error message describing the reason for the per-record failure. Maximum length: 255
status	string	Optional	Indicates the status of the per-record result. Possible values: **error**. Known values: error Maximum length: 255

Enroll Records to Cadences — response body — data data item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of a successful per-record operation result, including the record ID and the associated Cadences. Additional keys: not allowed
cadences	array	Optional	Specify the list of Cadences associated with the operation result. Maximum items: 2
cadences[]	Model	Each item	Expand Enroll Records to Cadences — response body — data data item details cadences item
id	string	Optional	Represents the unique ID of the record. Maximum length: 255

Referenced models: Enroll Records to Cadences — response body — data data item details cadences item

Enroll Records to Cadences — response body — data data item details cadences item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a Cadence in the operation result, including its unique ID and name. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the Cadence. Maximum length: 255
name	string	Optional	Represents the name of the Cadence. Maximum length: 255

Policy, approvals and errors

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