Zoho: Delete one or more appointment records

← Appointments operations · Get started

Operation zoho.deleteappointmentss

Provider route: DELETE /crm/v8/Appointments__s. 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["appointments"]["deleteAppointmentsS"]>[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.appointments.deleteAppointmentsS(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.appointments.delete_appointments_s(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.ids	number	Optional	One of: 111115000000147280, 111115000000147230

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 Delete one or more appointment records — response body — data
$ (anyOf 2)	object	Alternative	Represents the Multi-Status response body returned when a bulk deletion request results in a mix of successful and failed appointment deletion attempts. Additional keys: not allowed
$ (anyOf 2).data	array	Required within parent	Represents the list of result objects for each appointment deletion attempt. Each item is either a success confirmation or an error response. Maximum items: 200 Minimum items: 2
$ (anyOf 2).data[]	JSON	Each item	Represents a single result item for an appointment deletion attempt, which is either a success confirmation or an error response.
$ (anyOf 2).data[] (anyOf 1)	Model	Alternative	Expand Delete one or more appointment records — response body — data data item code, details, message, status
$ (anyOf 2).data (allOf 1)	JSON	All variants apply	Represents the constraint that the data array contains at least one successful deletion result, where each matching item holds the deleted record ID.
$ (anyOf 2).data (allOf 2)	JSON	All variants apply	Represents the constraint that the data array contains at least one failed deletion result, where each matching item describes an appointment record that could not be deleted.

Referenced models: Delete one or more appointment records — response body — data data item code, details, message, status, Delete one or more appointment records — response body — data

Schemas

Delete one or more appointment records — response body — data data item code, details, message, status

Field	Type	Presence	Description and constraints
$	object	Root	Represents a successful deletion result in the multi-Status response, containing the deleted record ID. Additional keys: not allowed
code	string	Required within parent	Represents the response code for the delete operation. Maximum length: 255
details	object	Required within parent	Represents the details of the deleted appointment record, including the record ID. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the deleted appointment record. Maximum length: 255
message	string	Required within parent	Represents the message for the record deletion. Maximum length: 255
status	string	Required within parent	Indicates the status of the record deletion. Maximum length: 255

Delete one or more appointment records — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the bulk appointment deletion request. Additional keys: not allowed
data	array	Optional	Represents the list of deletion result objects for each appointment record in the request. Maximum items: 3
data[]	Model	Each item	Expand Delete an Appointment by ID — response body — data item

Referenced models: Delete an Appointment by ID — response body — data item

Delete an Appointment by ID — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single item in the response, containing the operation outcome code, details, message, and status. Additional keys: not allowed
code	string	Optional	Represents the result code for the operation. Maximum length: 255
details	Model	Optional	Expand Delete an Appointment by ID — response body — data item details
message	string	Optional	Represents the result message for the operation. Maximum length: 255
status	string	Optional	Indicates the status of the operation. Maximum length: 255

Referenced models: Delete an Appointment by ID — response body — data item details

Delete an Appointment by ID — response body — data item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details of an appointment record, including its ID, creation timestamp, and last modification timestamp. Additional keys: not allowed
Created_By	Model	Optional	Expand Delete an Appointment by ID — response body — data item details Created By
Created_Time	string	Optional	Represents the date and time when the appointment record was created. Maximum length: 120
Modified_By	Model	Optional	Expand Delete an Appointment by ID — response body — data item details Modified By
Modified_Time	string	Optional	Represents the date and time when the appointment record was last modified. Maximum length: 120
id	string	Optional	Represents the unique identifier of the appointment record. Maximum length: 255

Referenced models: Delete an Appointment by ID — response body — data item details Created By, Delete an Appointment by ID — response body — data item details Modified By

Delete an Appointment by ID — response body — data item details Created By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	JSON	Optional
email (anyOf 1)	string	Alternative	Represents the email address of the user who created the appointment record. Format: email Maximum length: 33
email (anyOf 2)	null	Alternative	Represents the email address of the user who created the appointment record. Format: email Maximum length: 33
id	JSON	Optional
id (anyOf 1)	string	Alternative	Represents the unique identifier of the user who created the appointment record. Maximum length: 255
id (anyOf 2)	null	Alternative	Represents the unique identifier of the user who created the appointment record. Maximum length: 255
name	JSON	Optional
name (anyOf 1)	string	Alternative	Represents the full name of the user who created the appointment record. Maximum length: 255
name (anyOf 2)	null	Alternative	Represents the full name of the user who created the appointment record. Maximum length: 255

Delete an Appointment by ID — response body — data item details Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the appointment record, including the user ID, full name, and email address. Additional keys: not allowed
email	JSON	Optional
email (anyOf 1)	string	Alternative	Represents the email address of the user who last modified the appointment record. Format: email Maximum length: 33
email (anyOf 2)	null	Alternative	Represents the email address of the user who last modified the appointment record. Format: email Maximum length: 33
id	JSON	Optional
id (anyOf 1)	string	Alternative	Represents the unique ID of the user who last modified the appointment record. Maximum length: 255
id (anyOf 2)	null	Alternative	Represents the unique ID of the user who last modified the appointment record. Maximum length: 255
name	JSON	Optional
name (anyOf 1)	string	Alternative	Represents the full name of the user who last modified the appointment record. Maximum length: 255
name (anyOf 2)	null	Alternative	Represents the full name of the user who last modified the appointment record. Maximum length: 255

Policy, approvals and errors

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