Zoho: Create Appointment records
Zoho appointments.createAppointmentsS: arguments, response, policy and SDK examples.
← Appointments operations · Get started
Operation zoho.createappointmentss
Provider route: POST /crm/v8/Appointments__s. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["createAppointmentsS"]>[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.createAppointmentsS(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.create_appointments_s(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create Appointment records — request body — body |
Referenced models: Create Appointment records — request body — body
Response
Section titled “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 Create Appointment records — response body — data |
$ (anyOf 2) | Model | Alternative | Expand Create Appointment records — response body — data |
$ (anyOf 3) | object | Alternative | Represents the multi-status response body returned when bulk creating appointment records. The data array contains individual result items, each independently indicating success or failure for the corresponding submitted record. Additional keys: not allowed |
$ (anyOf 3).data | array | Required within parent | Represents the collection of result items returned for the bulk create operation. Each item independently indicates success or failure for the corresponding appointment record submitted in the request. Maximum items: 200 Minimum items: 2 |
$ (anyOf 3).data[] | JSON | Each item | Represents a single result item in the multi-status response. Each item is either a success object containing the created record details or an error object describing the reason the corresponding record could not be created. |
$ (anyOf 3).data[] (anyOf 1) | Model | Alternative | Expand Create Appointment records — response body — data data item code, details, message, status |
$ (anyOf 3).data[] (anyOf 2) | Model | Alternative | Expand Create Appointment records — response body — data data item value |
$ (anyOf 3).data (allOf 1) | JSON | All variants apply | Indicates that the data array contains at least one success item representing a successfully created appointment record. |
$ (anyOf 3).data (allOf 2) | JSON | All variants apply | Indicates that the data array may contain zero or more error items, each representing an appointment record that could not be created. |
Referenced models: Create Appointment records — response body — data data item code, details, message, status, Create Appointment records — response body — data, Create Appointment records — response body — data data item value
Schemas
Section titled “Schemas”27 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
Create Appointment records — response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the success response for the request to create appointment records, containing the result for each appointment. Additional keys: not allowed |
data | array | Optional | Represents the list of result objects for each created 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
Create Appointment records — response body — data data item value
Referenced models: Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, status: error, Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: required field not found, status: error, Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Service is not available on the given time, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment Owner is not a part of Service Members, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, status: error, Create Appointment records — response body — data / data / item / value / code: INVALID DATA, message: invalid data, INVALID DATA, status: error, Create Appointment records — response body — data / data / item / value / code: NOT ALLOWED, message: Appointment time does not falls under business hours, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be scheduled for past dates, status: error, Create Appointment records — response body — data / data / item / value / code: INVALID DATA, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD MISSING, DEPENDENT MISMATCH, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as overdue before the appointment ends, status: error, Create Appointment records — response body — data / data / item / value / code: MANDATORY NOT FOUND, message: mandatory key missing, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT FIELD UNCHANGED, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, message: Appointment cannot be marked as completed before the appointment ends, status: error, Create Appointment records — response body — data / data / item / value / code: DEPENDENT MISMATCH, status: error
Create Appointment records — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body schema for creating appointment records. Additional keys: not allowed |
data | array | Required within parent | Represents the data array containing the appointment objects to create. 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
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.createappointmentss. Catalog operation: createAppointmentsS. 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.