Zoho CRM: Appointment Preference Get Appointment Preference

Get your Zoho CRM appointment preferences, including deal creation, job sheet visibility and mark-as-complete rules.

Tool ID: zoho_crm_appointment_preference_get_appointment_preference

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_appointment_preference_get_appointment_preference',
  {
    "include": "deal_record_configuration"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_appointment_preference_get_appointment_preference --input '{
  "include": "deal_record_configuration"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe zoho_crm_appointment_preference_get_appointment_preference --json for the complete live contract.

Input reference

Fetches the existing configuration for appointment preferences, including rules for deal creation, job sheet visibility, and mark as complete configurations.

Name	Type	Required	Default	Details
`payload.include`	`"deal_record_configuration"`	No	—	Include additional related data in the response. For example, specify `deal_record_configuration` to include deal configuration details. Allowed: `deal_record_configuration`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	A JSON object containing the appointment preferences configured in the CRM.
`result.data.appointment_preferences`	`object`	Yes	—	The complete set of appointment preferences configured in CRM.
`result.data.appointment_preferences.show_job_sheet`	`boolean`	Yes	—	Indicates whether job sheets are shown for appointments.
`result.data.appointment_preferences.when_duration_exceeds`	`"mark_as_complete" \| "ask_appointment_provider_to_complete"`	No	—	Defines how to handle appointments when the scheduled duration is exceeded. Allowed: `mark_as_complete`, `ask_appointment_provider_to_complete`.
`result.data.appointment_preferences.when_appointment_completed`	`"do_not_create_deal" \| "create_deal"`	Yes	—	Determines whether a deal is automatically created when an appointment is completed. Allowed: `do_not_create_deal`, `create_deal`.
`result.data.appointment_preferences.allow_booking_outside_service_availability`	`boolean`	Yes	—	If true, allows booking appointments outside defined service availability.
`result.data.appointment_preferences.allow_booking_outside_businesshours`	`boolean`	Yes	—	If true, allows appointments to be scheduled beyond business hours.
`result.data.appointment_preferences.deal_record_configuration`	`object`	Yes	—	Configuration for creating deal records after an appointment is completed.
`result.data.appointment_preferences.deal_record_configuration.layout`	`object`	Yes	—	Details of the layout used when creating deal records.
`result.data.appointment_preferences.deal_record_configuration.layout.name`	`string`	Yes	—	Name of the layout as shown in the CRM UI. Maximum length: 255.
`result.data.appointment_preferences.deal_record_configuration.layout.id`	`string`	No	—	Unique identifier for the layout (Zoho internal ID). Maximum length: 64.
`result.data.appointment_preferences.deal_record_configuration.field_mappings`	`array`	Yes	—	List of field mappings from appointment data to deal fields. Maximum items: 100.
`result.data.appointment_preferences.deal_record_configuration.field_mappings[].type`	`"static" \| "merge_field"`	Yes	—	Specifies whether the mapping uses a static value or data from another field. Allowed: `static`, `merge_field`.
`result.data.appointment_preferences.deal_record_configuration.field_mappings[].value`	`record`	Yes	—	Value assigned to the mapped field.
`result.data.appointment_preferences.deal_record_configuration.field_mappings[].field`	`object`	Yes	—	The target field in the deal module.
`result.data.appointment_preferences.deal_record_configuration.field_mappings[].field.api_name`	`string`	Yes	—	API name of the deal field. Maximum length: 100.
`result.data.appointment_preferences.deal_record_configuration.field_mappings[].field.id`	`string`	Yes	—	Unique identifier of the deal field (Zoho internal ID). Maximum length: 20.
`result.data.appointment_preferences.deal_record_configuration.id`	`string`	Yes	—	Unique identifier for the deal record configuration. Maximum length: 20.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation