Zoho: Update appointment records

← Appointments operations · Get started

Operation zoho.updateappointmentss

Provider route: PUT /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"]["updateAppointmentsS"]>[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.updateAppointmentsS(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.update_appointments_s(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 Update appointment records — request body — body

Referenced models: Update appointment records — 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 Update an Appointment Record by ID — response body
$ (anyOf 2)	object	Alternative	Represents the Multi-Status response body returned when the update request produces a mix of successfully updated and failed appointment updates. The response contains at least one success and at least one error. Additional keys: not allowed
$ (anyOf 2).data	array	Required within parent	Represents the list of result objects returned for each appointment update attempt. Each item is either a success response for a successfully updated record or an error response for a failed update. Maximum items: 200 Minimum items: 2
$ (anyOf 2).data[]	JSON	Each item	Represents a single result in the response array. it is either a success object containing the updated record details with a status code and message, or an error object indicating a failed update due to an invalid appointment ID.
$ (anyOf 2).data[] (anyOf 1)	Model	Alternative	Expand Create Appointment records — response body — data data item code, details, message, status
$ (anyOf 2).data[] (anyOf 2)	Model	Alternative	Expand Update appointment records — response body — data / data / item / code: INVALID DATA, message: the id given seems to be invalid, status: error
$ (anyOf 2).data (allOf 1)	JSON	All variants apply	Constrains the data array to contain at least one success response object, ensuring the response always reflects at least one successfully updated appointment record.
$ (anyOf 2).data (allOf 2)	JSON	All variants apply	Constrains the data array to contain at least one error response object, ensuring the response always reflects at least one failed appointment update attempt.

Referenced models: Create Appointment records — response body — data data item code, details, message, status, Update appointment records — response body — data / data / item / code: INVALID DATA, message: the id given seems to be invalid, status: error, Update an Appointment Record by ID — response body

Schemas

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

Create Appointment records — response body — data data item code, details, message, status

Field	Type	Presence	Description and constraints
$	object	Root	Represents a successful result item in the Multi-Status response, containing the result code, details, message, and status. Additional keys: not allowed
code	string	Optional	Represents the result code for the appointment record 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 appointment record operation. Maximum length: 255
status	string	Optional	Indicates the result status of the appointment record operation. Maximum length: 255

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

Update appointment records — response body — data / data / item / code: INVALID DATA, message: the id given seems to be invalid, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error when the appointment ID provided in the request is invalid. Additional keys: not allowed
code	string	Required within parent	Represents the error code for this response. Known values: INVALID_DATA
details	object	Required within parent	Represents the details about the field that caused the validation failure. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the field that caused the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field in the request that caused the error. Maximum length: 1000
message	string	Required within parent	Represents the error message describing the validation failure. Known values: the id given seems to be invalid
status	string	Required within parent	Indicates the response status. Known values: error

Update an Appointment Record by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success response for the request to update appointment records. Additional keys: not allowed
data	array	Optional	Represents the list of result objects for each updated appointment record. Maximum items: 100 Minimum items: 1
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

Update appointment records — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body schema for updating appointment records. Additional keys: not allowed
data	array	Required within parent	Represents the data array containing the appointment objects to update. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Create Appointment records — request body — body data item

Referenced models: Create Appointment records — request body — body data item

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

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 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

Create Appointment records — request body — body data item Appointment For

Field	Type	Presence	Description and constraints
$	object	Root	Represents the customer for whom the appointment is created, including the record ID, name, and module API name. Test4 Additional keys: not allowed
id	string or null	Optional	Represents the list of result objects for each appointment deletion is attempted. Each item is either a success confirmation or an error response. Test7 Maximum length: 18
module	Model	Optional	Expand Create Appointment records — request body — body data item Appointment For module module name
name	string or null	Optional	Represents the full name of the customer record in the associated module. Maximum length: 2

Referenced models: Create Appointment records — request body — body data item Appointment For module

Create Appointment records — request body — body data item 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	string or null	Optional	Represents the email address of the user who created the appointment record. Format: email Maximum length: 33
id	string or null	Optional	Represents the unique identifier of the user who created the appointment record. Maximum length: 255
name	string or null	Optional	Represents the full name of the user who created the appointment record. Maximum length: 255

Policy, approvals and errors

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