Zoho: Update an Appointment Record by ID

← Appointments operations · Get started

Operation zoho.updateappointmentbyid

Provider route: PUT /crm/v8/Appointments__s/{appointmentId}. 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"]["updateAppointmentById"]>[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.updateAppointmentById(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_appointment_by_id(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.appointmentId	string	Required within parent	Maximum length: 100
query	object	Optional	Additional keys: not allowed
query.id	number	Optional	One of: 111115000000147180
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
$	Model	Root	Expand Update an Appointment Record by ID — response body

Referenced models: Update an Appointment Record by ID — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

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

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

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

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

Create Appointment records — request body — body data item Owner

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user assigned as the appointment owner, including the user ID, full name, and email address. Additional keys: not allowed
email	string or null	Optional	Represents the email address of the appointment owner. Format: email Maximum length: 100
id	string or null	Optional	Represents the unique ID of the appointment owner. Maximum length: 100
name	string or null	Optional	Represents the full name of the appointment owner. Maximum length: 100

Create Appointment records — request body — body data item Service Name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the service for which the appointment is created, including the service ID and name. Additional keys: not allowed
id	string or null	Optional	Represents the unique ID of the service. Maximum length: 100
name	string or null	Optional	Represents the name of the service for which the appointment is created. Maximum length: 100

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 module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module details for the Appointment_For customer record lookup, including the module API name and ID. Test8 Additional keys: not allowed
api_name	string or null	Optional	Represents the API name of the module for the customer record. Maximum length: 8
id	string or null	Optional	Represents the unique ID of the module. Maximum length: 18

Policy, approvals and errors

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