Zoho: Cancel a Meeting

← Cancel meetings operations · Get started

Operation zoho.cancelmeetings

Provider route: POST /crm/v8/Events/{event}/actions/cancel. 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["cancelMeetings"]["cancelMeetings"]>[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.cancelMeetings.cancelMeetings(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.cancel_meetings.cancel_meetings(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.event	string	Required within parent	Maximum length: 255
body	object	Required within parent	The request body for the cancel meeting operation. Additional keys: not allowed
body.data	array	Required within parent	Array containing the cancellation notification preference. Mandatory. Maximum items: 10
body.data[]	object	Each item	Object specifying whether to send a cancellation notification email to participants. Additional keys: not allowed
body.data[].cancelled_by	object	Optional	The user who cancelled the meeting. If specified, send_cancelling_mail must be true. Additional keys: not allowed
body.data[].cancelled_by.id	string	Required within parent	The ID of the user who cancelled the meeting. Maximum length: 255
body.data[].send_cancelling_mail	boolean	Required within parent	Indicates whether to send a meeting cancellation notification email to all participants. Mandatory. Possible values: true - Sends a cancellation notification email to all participants. false - Cancels the meeting without sending a notification email

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
$	object	Root	Successful response containing the cancellation result. Additional keys: not allowed
data	array	Required within parent	Array containing the cancellation result for the meeting. Maximum items: 10
data[]	object	Each item	Object containing the result of the cancellation operation. Additional keys: not allowed
data[].code	string	Required within parent	The status code of the operation. Known values: SUCCESS
data[].details	object	Required within parent	Object containing the ID of the cancelled meeting. Additional keys: not allowed
data[].details.id	string	Required within parent	The unique identifier of the cancelled meeting. Maximum length: 255
data[].message	string	Required within parent	A message describing the result of the operation. Maximum length: 255
data[].status	string	Required within parent	The status of the operation. Known values: success

Policy, approvals and errors

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