Zoho: Update a specific service record by ID

← Services operations · Get started

Operation zoho.updateservicesbyid

Provider route: PUT /crm/v8/Services__s/{id}. 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["services"]["updateServiceSById"]>[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.services.updateServiceSById(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.services.update_service_s_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.id	string	Required within parent	Maximum length: 100
query	object	Optional	Additional keys: not allowed
query.affected_data	boolean	Optional	One of: true
body	Model	Optional	Expand Update a specific service record by ID — request body — body

Referenced models: Update a specific service record by ID — 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 a specific service record by ID — response body

Referenced models: Update a specific service record by ID — response body

Schemas

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

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

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

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

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

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

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

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

Policy, approvals and errors

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