Zoho: Services schemas

← Services operations · All schemas

Create service records in Zoho CRM — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body schema for creating services. Contains a data array of service objects to be created and an optional skip_mandatory flag. Additional keys: not allowed
data	array	Required within parent	Specify the array of service objects to be created. You can include up to 100 objects. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Create service records in Zoho CRM — request body — body data item
skip_mandatory	boolean or null	Optional	Specify whether to skip mandatory-field validation when creating service records.

Referenced models: Create service records in Zoho CRM — request body — body data item

Create service records in Zoho CRM — request body — body data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a service object in the create request payload, including its name, duration, price, location, members, availability configuration, layout reference, and Zia owner assignment. Additional keys: not allowed
$zia_owner_assignment	string or null	Optional	Specify the Zia owner-assignment recommendation behavior for the service record. Maximum length: 32
Availability_Type	string	Required within parent	Specify how the service availability is defined. **Possible values**: - Every Business Days - service is available on every business day. - Specific Date Range - service is available within an Available_From and Available_Till range. - Specific Date(s) - service is available on the dates listed in Available_Dates. - Specific Day(s) - service is available on the weekdays listed in Available_Days. One of: Specific Day(s), Specific Date Range, Every Business Days, Specific Date(s) Maximum length: 100
Available_Dates	array or null	Optional	Specify the list of dates on which the service is available, in YYYY-MM-DD format. This key is mandatory when Availability_Type is Specific Date(s). Maximum items: 20
Available_Dates[]	string	Each item	Each string specifies one date on which the service is available, in YYYY-MM-DD format. Maximum length: 255
Available_Days	array or null	Optional	Specify the list of business days on which the service is available. This key is mandatory when Availability_Type is Specific Day(s). Maximum items: 7
Available_Days[]	string	Each item	Each string specifies a business day on which the service is available. Maximum length: 225
Available_From	string or null	Optional	Specify the date from which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range. Format: date Maximum length: 100
Available_Till	string or null	Optional	Specify the date until which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range. Format: date Maximum length: 100
Available_Timings	array or null	Optional	Specify the available time windows for the service on each available day or date. The total available time must be at least equal to the service Duration. If not mentioned, the configured business hours are used. Maximum items: 4
Available_Timings[]	Model	Each item	Expand Create service records in Zoho CRM — request body — body data item Available Timings item
Description	string or null	Optional	Specify a description of the service. Maximum length: 32000
Duration	integer	Required within parent	Specify the duration of the service, in minutes. Must be greater than 5 minutes and less than 24 hours. Format: int32
Job_Sheet_Required	string or null	Optional	Specify whether a job sheet is required for the service. **Possible values**: Yes, No. One of: Yes, No Maximum length: 3
Layout	Model	Optional	Expand Create service records in Zoho CRM — request body — body data item Layout Layout id
Location	string	Required within parent	Specify where the service is delivered. **Possible values**: Client Address, Business Address, Business Address and Client Address. One of: Business Address, Business Address and Client Address, Client Address Maximum length: 100
Members	array	Required within parent	Specify the users who deliver the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Maximum items: 5
Members[]	Model	Each item	Expand Create service records in Zoho CRM — request body — body data item Members item
Owner	Model	Optional	Expand Create service records in Zoho CRM — request body — body data item Owner owner of the service
Price	integer	Required within parent	Specify the price charged for the service in the organization currency, with up to 16 digits and 2 decimal places. Format: int32
Service_Name	string	Required within parent	Specify the name of the service. The key accepts alphanumeric characters. Maximum length: 120
Tax	array or null	Optional	Specify the taxes applied to the service cost. Each entry carries a tax ID and the tax value label. Maximum items: 2
Tax[]	Model	Each item	Expand Create service records in Zoho CRM — request body — body data item Tax item
zia_suggested_users	object or null	Optional	Specify the Zia-suggested users payload associated with the service record. Additional keys: not allowed

Referenced models: Create service records in Zoho CRM — request body — body data item Available Timings item, Create service records in Zoho CRM — request body — body data item Layout, Create service records in Zoho CRM — request body — body data item Members item, Create service records in Zoho CRM — request body — body data item Owner, Create service records in Zoho CRM — request body — body data item Tax item

Create service records in Zoho CRM — request body — body data item Available Timings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single availability time window for the service, defined by a start time (From) and an end time (To). Additional keys: not allowed
From	string or null	Optional	Specify the start of the availability time window in HH:MM (24-hour) format. Maximum length: 5
To	string or null	Optional	Specify the end of the availability time window in HH:MM (24-hour) format. Maximum length: 5

Create service records in Zoho CRM — request body — body data item Layout

Field	Type	Presence	Description and constraints
$	object	Root	Represents the layout used to render the service record. Refer to the [Get layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values. Additional keys: not allowed
id	string or null	Optional	Specify the unique ID of the layout to use for the service record. Refer to the [Get layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values. Maximum length: 18

Create service records in Zoho CRM — request body — body data item Members item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a member who delivers the service. Identifies the user by name and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Additional keys: not allowed
Members	Model	Optional	Expand Create service records in Zoho CRM — request body — body data item Members item contains member details
id	string or null	Optional	Specify the unique ID of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Maximum length: 18
name	string or null	Optional	Specify the display name of the user who delivers the service. Maximum length: 120

Referenced models: Create service records in Zoho CRM — request body — body data item Members item

Create service records in Zoho CRM — request body — body data item Owner

Field	Type	Presence	Description and constraints
$	object	Root	Represents the owner of the service. Identifies the user who owns the service record by name, full name, and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Additional keys: not allowed
full_name	string or null	Optional	Specify the full name of the user who owns the service record. Maximum length: 120
id	string or null	Optional	Specify the unique ID of the user who owns the service record. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Maximum length: 18
name	string or null	Optional	Specify the display name of the user who owns the service record. Maximum length: 120

Create service records in Zoho CRM — request body — body data item Tax item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a tax entry applied to the service cost, identified by its tax ID and value label. Additional keys: not allowed
id	null	Optional	Specify the unique ID of the tax applied to the service cost.
value	string or null	Optional	Specify the display label of the tax applied to the service cost. Maximum length: 100

Create service records in Zoho CRM — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Wrapped response for a service create request. Contains a per-record status array with the success code, persisted ID, and audit metadata for each service record processed. Additional keys: not allowed
data	array	Optional	Represents the per-record status array, with one entry for each service record processed in the create request. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Delete a service record by ID — response body — data item

Referenced models: Delete a service record by ID — response body — data item

Create service records in Zoho CRM — response body — data / data / item / code: MANDATORY NOT FOUND

Field	Type	Presence	Description and constraints
$	object	Root	Multi-status error item returned when a service record in a bulk operation is missing a required field. Additional keys: allowed
code	string	Required within parent	Represents the error code returned for the failed request. Known values: MANDATORY_NOT_FOUND
details	object	Required within parent	Represents the details providing validation context for the error. Additional keys: allowed
details.api_name	string	Required within parent	Represents the API name of the field that triggered the error. Maximum length: 255
details.json_path	string	Required within parent	Represents the JSON path to the field that triggered the error in the request payload. Maximum length: 1000
message	string	Required within parent	Represents the error message describing that a mandatory field was not found in the multi-status request. Maximum length: 100
status	string	Required within parent	Represents the status of the response. Maximum length: 100

Delete a service record by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Wrapped response for a service DELETE request. Contains a data array with one status object carrying the success code and the deleted service ID. Additional keys: not allowed
data	array	Optional	Represents the per-record status array containing the result for each deleted service record. Maximum items: 1
data[]	Model	Each item	Expand Delete a service record by ID — response body — data item

Referenced models: Delete a service record by ID — response body — data item

Delete a service record by ID — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-record status item in a response. Carries the operation code, message, status, and details (such as audit metadata and the affected_data block) for one service record. Additional keys: not allowed
code	string	Optional	Represents the operation result code for the service record. Maximum length: 255
details	Model	Optional	Expand Delete a service record by ID — response body — data item details
message	string	Optional	Represents the result message for the operation result. Maximum length: 255
status	string	Optional	Represents the status of the operation. Maximum length: 255

Referenced models: Delete a service record by ID — response body — data item details

Delete a service record by ID — response body — data item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the details as a per-record status item. Carries audit metadata (Modified_Time, Modified_By, Created_Time, Created_By) and the persisted record ID. Additional keys: allowed
Created_By	Model	Optional	Expand Delete a service record by ID — response body — data item details Created By
Created_Time	string	Optional	Represents the timestamp when the service record was first saved to the organization. Maximum length: 255
Modified_By	Model	Optional	Expand Delete a service record by ID — response body — data item details Modified By
Modified_Time	string	Optional	Represents the timestamp when the service record was last modified. Maximum length: 255
id	string	Optional	Represents the unique ID of the affected service record. Maximum length: 255

Referenced models: Delete a service record by ID — response body — data item details Created By, Delete a service record by ID — response body — data item details Modified By

Delete a service record by ID — response body — data item details Created By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the service record, identified by name and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the user who created the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255
name	string	Optional	Represents the display name of the user who created the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255

Delete a service record by ID — response body — data item details Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the service record, identified by name and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the user who modified the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255
name	string	Optional	Represents the display name of the user who modified the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255

Delete one or more service records — response body — data / data / item / code: INVALID DATA

Field	Type	Presence	Description and constraints
$	object	Root	Multi-status error item returned when a service record in a bulk operation could not be processed because of invalid data. Additional keys: allowed
code	string	Required within parent	Represents the error code returned for the failed request. Known values: INVALID_DATA Maximum length: 255
details	object	Required within parent	Represents the details providing validation context for the error. Additional keys: allowed
details.id	string	Optional	Represents the unique ID of the service record that could not be processed. Maximum length: 255
message	string	Required within parent	Represents the error message for the failure. Maximum length: 100
status	string	Required within parent	Represents the status of the response. Maximum length: 100

Get services — response body

Field	Type	Presence	Description and constraints
$	object	Root	Wrapped response that lists the service records matching the request. Contains a data array with up to 200 service objects, each carrying the full set of service fields. Additional keys: allowed
data	array	Required within parent	Represents the array of service records returned by the request. Maximum items: 200 Minimum items: 1
data[]	Model	Each item	Expand Get services — response body — data item

Referenced models: Get services — response body — data item

Get services — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single service record returned by a GET request, including identity, status, availability configuration, members, owner, pricing, tax, audit timestamps, and sharing metadata. Additional keys: allowed
$currency_symbol	string	Optional	Represents the currency symbol used to format monetary fields on the service record. Maximum length: 255
$data_source_details	Model	Optional	Expand Get services — response body — data item $data source details
$editable	boolean	Required within parent	Indicates whether the current user can edit the service record.
$field_states	null	Required within parent	Represents the field-state metadata for the service record.
$has_more	Model	Required within parent	Expand Get services — response body — data item $has more
$photo_id	null	Required within parent	Represents the photo ID associated with the service record.
$sharing_permission	string	Required within parent	Represents the sharing permission level of the current user on the service record. Maximum length: 255
$status	string	Required within parent	Represents the internal status identifier of the service record. Maximum length: 255
Availability_Type	string	Required within parent	Represents how the service availability is defined. **Possible values**: Specific Day(s), Specific Date Range, Every Business Days, Specific Date(s). Maximum length: 255
Available_Dates	array	Required within parent	Represents the list of dates on which the service is available. Maximum items: 20
Available_Dates[]	JSON	Each item	Each string represents a date in the service availability list, in YYYY-MM-DD format.
Available_Days	array	Required within parent	Represents the list of business days on which the service is available. Maximum items: 7
Available_Days[]	JSON	Each item	Each string represents a business day in the service availability list.
Available_From	string	Required within parent	Represents the date from which the service is available. Maximum length: 255
Available_Till	JSON	Required within parent
Available_Till (anyOf 1)	string	Alternative	Represents the date until which the service is available. Maximum length: 255
Available_Till (anyOf 2)	null	Alternative	Represents the date until which the service is available. Maximum length: 255
Available_Timings	JSON	Required within parent
Available_Timings (anyOf 1)	array	Alternative	Represents the available time windows configured for the service. Maximum items: 3
Available_Timings (anyOf 1)[]	Model	Each item	Expand Get services — response body — data item Available Timings null item
Available_Timings (anyOf 2)	null	Alternative	Represents the available time windows configured for the service. Maximum items: 3
Available_Timings (anyOf 2)[]	Model	Each item	Expand Get services — response body — data item Available Timings null item
Created_By	Model	Required within parent	Expand Get services — response body — data item Created By
Created_Time	string	Required within parent	Represents the timestamp when the service record was first saved to the organization. Maximum length: 255
Description	JSON	Required within parent
Description (anyOf 1)	string	Alternative	Represents the description of the service. Maximum length: 32000
Description (anyOf 2)	null	Alternative	Represents the description of the service. Maximum length: 32000
Duration	JSON	Required within parent
Duration (anyOf 1)	integer	Alternative	Represents the duration of the service, in minutes. Format: int32
Duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Job_Sheet_Required	string	Required within parent	Represents whether a job sheet is required for the service. **Possible values**: Yes, No. Known values: Yes, No Maximum length: 255
Job_Sheet_Section__s	null	Required within parent	Represents the job sheet section associated with the service.
Last_Activity_Time	string	Required within parent	Represents the timestamp of the most recent activity on the service record. Maximum length: 255
Location	string	Required within parent	Represents where the service is delivered. **Possible values**: Client Address, Business Address, Business Address and Client Address. Maximum length: 255
Members	array	Required within parent	Represents the users who deliver the service. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum items: 2
Members[]	Model	Each item	Expand Get services — response body — data item Members item
Modified_By	Model	Required within parent	Expand Get services — response body — data item Modified By
Modified_Time	string	Required within parent	Represents the timestamp when the service record was last modified. Maximum length: 255
Owner	Model	Required within parent	Expand Get services — response body — data item Owner
Price	JSON	Required within parent
Price (anyOf 1)	integer	Alternative	Represents the price charged for the service in the organization currency. Format: int32
Price (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Record_Image	null	Required within parent	Represents the record image associated with the service.
Record_Status__s	string	Optional	Represents the system-derived record status of the service. Maximum length: 255
Service_Name	string	Required within parent	Represents the name of the service. Maximum length: 120
Status	string	Required within parent	Represents the operational status of the service. **Possible values**: Available, Not in Use, Scheduled, Temporarily Unavailable. Known values: Available, Temporarily Unavailable, Not in Use, Scheduled Maximum length: 255
Tag	JSON	Required within parent
Tag (anyOf 1)	array	Alternative	Represents the tags associated with the service record. Refer to the [Get tags](tags.yaml#$.paths./settings/tags.get) endpoint for details. Maximum items: 100
Tag (anyOf 1)[]	string	Each item	Each string represents a tag name associated with the service record. Maximum length: 2000
Tag (anyOf 2)	null	Alternative	Represents the tags associated with the service record. Refer to the [Get tags](tags.yaml#$.paths./settings/tags.get) endpoint for details. Maximum items: 100
Tag (anyOf 2)[]	string	Each item	Each string represents a tag name associated with the service record. Maximum length: 2000
Tax	array	Required within parent	Represents the taxes applied to the service cost. Maximum items: 100
Tax[]	JSON	Each item	Each string represents a tax entry applied to the service cost.
Unavailable_From	JSON	Required within parent
Unavailable_From (anyOf 1)	string	Alternative	Represents the date and time from which the service is unavailable. Maximum length: 255
Unavailable_From (anyOf 2)	null	Alternative	Represents the date and time from which the service is unavailable. Maximum length: 255
Unavailable_Till	null	Required within parent	Represents the date and time until which the service remains unavailable.
id	string	Required within parent	Represents the unique ID of the service record. Maximum length: 255

Referenced models: Get services — response body — data item Available Timings null item, Get services — response body — data item $data source details, Get services — response body — data item $has more, Get services — response body — data item Members item, Get services — response body — data item Created By, Get services — response body — data item Modified By, Get services — response body — data item Owner

Get services — response body — data item $data source details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the $data_source_details block on a returned service record. Carries metadata about the data source from which the record originated. Additional keys: not allowed

Get services — response body — data item $has more

Field	Type	Presence	Description and constraints
$	object	Root	Indicates whether additional related items exist beyond those included in the response. Additional keys: not allowed
Members	boolean	Required within parent	Indicates whether more members exist than those included in the current response.

Get services — response body — data item Available Timings null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the availability time window on a returned service record, defined by a start time (From) and an end time (To). Additional keys: not allowed
From	string	Required within parent	Represents the start of the availability time window, in HH:MM (24-hour) format. Maximum length: 255
To	string	Required within parent	Represents the end of the availability time window, in HH:MM (24-hour) format. Maximum length: 255

Get services — response body — data item Created By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who created the returned service record, identified by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the user. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255
name	string	Required within parent	Represents the display name of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255

Get services — response body — data item Members item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an entry in the Members array of a returned service record, wrapping the member identity together with the relationship ID. Additional keys: not allowed
Members	Model	Required within parent	Expand Get services — response body — data item Members item Members
id	string	Required within parent	Represents the unique ID of the member on the service record. Maximum length: 255

Referenced models: Get services — response body — data item Members item Members

Get services — response body — data item Members item Members

Field	Type	Presence	Description and constraints
$	object	Root	Represents a member who delivers the returned service, identified by module, name, and ID. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
id	string	Required within parent	Represents the unique ID of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255
module	string	Required within parent	Represents the source module of the member. Typically, the Users module. Maximum length: 255
name	string	Required within parent	Represents the display name of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255

Get services — response body — data item Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Represents the user who last modified the returned service record, identified by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the user. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255
name	string	Required within parent	Represents the display name of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255

Get services — response body — data item Owner

Field	Type	Presence	Description and constraints
$	object	Root	Represents the owner of the returned service record, identified by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Additional keys: not allowed
email	string	Required within parent	Represents the email address of the user. Maximum length: 255
id	string	Required within parent	Represents the unique ID of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255
name	string	Required within parent	Represents the display name of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255

Retrieve a specific service record by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Wrapped response that returns a single service record. Contains a data array with exactly one service object carrying the full set of service fields. Additional keys: allowed
data	array	Required within parent	Represents the array containing the requested service record. Maximum items: 1 Minimum items: 1
data[]	Model	Each item	Expand Get services — response body — data item

Referenced models: Get services — response body — data item

Update a specific service record by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body schema for updating a single service. Contains a data array with exactly one service object that carries the fields to be updated. Additional keys: not allowed
data	array	Required within parent	Specify the array containing the single service object to be updated. Maximum items: 1 Minimum items: 1
data[]	Model	Each item	Expand Update service records — request body — body data item

Referenced models: Update service records — request body — body data item

Update a specific service record by ID — response body

Field	Type	Presence	Description and constraints
$	object	Root	Wrapped response for a single service update request. Contains a data array with one status object carrying the success code, persisted ID, audit metadata, and affected_data block. Additional keys: not allowed
data	array	Optional	Represents the per-record status array containing the result for the updated service record. Maximum items: 1 Minimum items: 1
data[]	Model	Each item	Expand Delete a service record by ID — response body — data item

Referenced models: Delete a service record by ID — response body — data item

Update service records — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Request body schema for updating multiple services. Contains a data array with up to 100 service objects, each identified by its ID and carrying the fields to be updated. Additional keys: not allowed
data	array	Required within parent	Specify the array of service objects to be updated. You can include up to 100 objects. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Update service records — request body — body data item

Referenced models: Update service records — request body — body data item

Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled

Field	Type	Presence	Description and constraints
$	object	Root	Base schema for a service object payload. Defines the fields common to create and update requests, including identity, status, availability, members, pricing, and tax. Additional keys: allowed
Availability_Type	string or null	Optional	Specify how the service availability is defined. **Possible values**: Specific Day(s), Specific Date Range, Every Business Days, Specific Date(s). One of: Specific Day(s), Specific Date Range, Every Business Days, Specific Date(s) Maximum length: 19
Available_Dates	array or null	Optional	Specify the list of dates on which the service is available. The key is mandatory when Availability_Type is Specific Date(s). Maximum items: 20
Available_Dates[]	string	Each item	Each string specifies a date on which the service is available, in YYYY-MM-DD format. Maximum length: 255
Available_Days	array or null	Optional	Specify the list of business days on which the service is available. The key is mandatory when Availability_Type is Specific Day(s). Maximum items: 7
Available_Days[]	string	Each item	Each string specifies a business day on which the service is available. Maximum length: 255
Available_From	string or null	Optional	Specify the date from which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range. Maximum length: 100
Available_Till	string or null	Optional	Specify the date until which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range. One of: 2026-01-13, 2026-01-29 Maximum length: 100
Available_Timings	string or null	Optional	Specify the available time windows for the service. The total available time must be at least equal to the service Duration. Maximum length: 4
Description	string or null	Optional	Specify a description of the service. Maximum length: 32000
Duration	integer or null	Optional	Specify the duration of the service, in minutes. Must be greater than 5 minutes and less than 24 hours. Format: int32
Job_Sheet_Required	string or null	Optional	Specify whether a job sheet is required for the service. **Possible values**: Yes, No. One of: Yes, No Maximum length: 3
Job_Sheet_Section__s	string or null	Optional	Specify the job sheet section associated with the service. It can be set only when Job_Sheet_Required is Yes. Maximum length: 255
Location	string or null	Optional	Specify where the service is delivered. **Possible values**: Client Address, Business Address, Business Address and Client Address. One of: Business Address, Business Address and Client Address, Client Address Maximum length: 1000
Members	array or null	Optional	Specify the users who deliver the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Maximum items: 100
Members[]	Model	Each item	Expand Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Members item
Owner	Model	Optional	Expand Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Owner
Price	integer or null	Optional	Specify the price charged for the service in the organization currency. Format: int32
Record_Image	string or null	Optional	Specify the record image to associate with the service. Maximum length: 255
Service_Name	string or null	Optional	Specify the name of the service. Maximum length: 120
Status	string or null	Optional	Specify the operational status of the service. **Possible values**: - Available - service is active and accepting bookings. - Not in Use - service is currently inactive. - Scheduled - service is queued to become Available on Available_From. - Temporarily Unavailable - service is paused for the Unavailable_From-to-Unavailable_Till window. One of: Available, Temporarily Unavailable, Not in Use, Scheduled Maximum length: 100
Tag	array or null	Optional	Specify the tag names to associate with the service record. Refer to the [Get tags](tags.yaml#$.paths./settings/tags.get) resource for valid values. Maximum items: 100
Tag[]	string	Each item	Each string specifies one tag name to associate with the service record. Maximum length: 2000
Tax	array or null	Optional	Specify the taxes applied to the service cost. Maximum items: 2
Tax[]	string	Each item	Each string represents one tax entry applied to the service cost. Maximum length: 255
Unavailable_From	string or null	Optional	Specify the date and time from which the service becomes unavailable. Must fall within the service availability window. Maximum length: 25
Unavailable_Till	string or null	Optional	Specify the date and time until which the service remains unavailable. Must fall within the service availability window. Maximum length: 255
id	string or null	Optional	Specify the unique ID of the service record being updated. Maximum length: 100

Referenced models: Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Members item, Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Owner

Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Members item

Field	Type	Presence	Description and constraints
$	object	Root	Base schema for a member item in the service Members array. Wraps the member identity together with the relationship ID. Additional keys: allowed
Members	Model	Optional	Expand Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Members item Members
id	string or null	Optional	Specify the unique relationship ID of the member entry on the service record. Maximum length: 100

Referenced models: Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Members item Members

Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Members item Members

Field	Type	Presence	Description and constraints
$	object	Root	Base schema for a member of the service. Identifies the user by module, name, and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Additional keys: allowed
id	string or null	Optional	Specify the unique ID of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. One of: 4671651000000635001 Maximum length: 100
module	string or null	Optional	Specify the source module of the member. Typically set to the module Users. Maximum length: 100
name	string or null	Optional	Specify the display name of the user who delivers the service. One of: Madeshwaran G Maximum length: 100

Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Owner

Field	Type	Presence	Description and constraints
$	object	Root	Base schema for the service owner. Identifies the user who owns the service record by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. Additional keys: allowed
email	string or null	Optional	Specify the email address of the user who owns the service record. Maximum length: 100
id	string or null	Optional	Specify the unique ID of the user who owns the service record. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values. One of: 4671651000000635001 Maximum length: 100
name	string or null	Optional	Specify the display name of the user who owns the service record. One of: Madeshwaran G Maximum length: 100

Update service records — request body — body data item

Field	Type	Presence	Description and constraints
$	JSON	Root	Service object schema used in update requests. Extends the base service object with update-specific overrides on the Owner field.
$ (allOf 1)	Model	All variants apply	Expand Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled
$ (allOf 2)	object	All variants apply	Update specific overrides applied to the base service object schema. Additional keys: allowed
$ (allOf 2).Owner	Model	Optional	Expand Update service records — request body — body data item Owner Owner

Referenced models: Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled, Update service records — request body — body data item Owner Owner

Update service records — request body — body data item Owner Owner

Field	Type	Presence	Description and constraints
$	JSON	Root	Service owner schema used in update requests, where the email of the owner is required.
$ (allOf 1)	Model	All variants apply	Expand Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Owner
$ (allOf 2)	object	All variants apply	Required fields for the Owner object when updating a service. Additional keys: allowed

Referenced models: Update service records — request body — body / data / item / Available_Till: 2026-01-13, 2026-01-29, Job Sheet Required: Yes, No, Location: Business Address, Business Address and Client Address, Client Address, Status: Available, Temporarily Unavailable, Not in Use, Scheduled Owner

Update service records — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Wrapped response for a bulk service update request. Contains a per-record status array with the success code and audit metadata for each processed service. Additional keys: not allowed
data	array	Optional	Represents the per-record status array, with one entry for each service record processed in the bulk update. Maximum items: 100 Minimum items: 1
data[]	Model	Each item	Expand Delete a service record by ID — response body — data item

Referenced models: Delete a service record by ID — response body — data item

Update service records — response body — data data item code, details, message, status — Data Error

Field	Type	Presence	Description and constraints
$	object	Root	Standard error response object returned when a request fails. Contains the error code, the message, the status, and a details block identifying the offending field. Additional keys: allowed
code	string	Required within parent	Represents the error code returned when a data validation error occurs. Maximum length: 255
details	object	Required within parent	Represents the details providing validation context for the error. Additional keys: not allowed
details.api_name	string	Optional	Represents the API name of the field that triggered the error. Maximum length: 255
details.json_path	string	Optional	Represents the JSON path to the field that triggered the error. Maximum length: 1000
message	string	Required within parent	Represents the error message returned when the request fails. Maximum length: 1000
status	string	Required within parent	Represents the status of the response, indicating that an error occurred. Maximum length: 1000

Update service records — response body — data data item code, details, message, status — Services Post207multistatus Response207

Field	Type	Presence	Description and constraints
$	object	Root	Represents a success item in a multi-status response. Carries the success code, message, status, and details for the corresponding service record in the request. Additional keys: not allowed
code	string	Optional	Represents the operation result code for the service record. Maximum length: 255
details	Model	Optional	Expand Delete a service record by ID — response body — data item details
message	string	Optional	Represents the result message for the operation result. Maximum length: 255
status	string	Optional	Represents the status of the operation. Maximum length: 255

Referenced models: Delete a service record by ID — response body — data item details