Zoho: Update a single user by user ID

← Users operations · Get started

Operation zoho.updatesingleuser

Provider route: PUT /crm/v8/users/{user}. 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["users"]["updateSingleUser"]>[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.users.updateSingleUser(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.users.update_single_user(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.user	string	Required within parent	Represents the unique identifier of the user. Maximum length: 19
body	object	Optional	Represents the structure of the user update request body. Contains a users array with the details of the user to update. Additional keys: not allowed
body.users	array	Required within parent	Specify the user details to update. Only one user record can be submitted per request. Maximum items: 1
body.users[]	Model	Each item	Expand Create User — request body — body users item

Referenced models: Create User — request body — body users item

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
$	object	Root	Represents the structure of the user update success response. Contains a users array with the outcome of the update operation. Additional keys: not allowed
users	array	Optional	Represents the list of outcome objects returned after processing the user update request. Each element reports the result status for the updated user record. Maximum items: 10
users[]	object	Each item	Represents the outcome of a single user update operation. Contains the status code, a message, the unique identifier of the updated user, and the overall request status. Additional keys: not allowed
users[].code	string	Optional	Indicates the API-level result code for the user update operation. Possible values: SUCCESS - The user record updates successfully. Known values: SUCCESS
users[].details	object	Optional	Represents an object containing identifying information about the updated user. Includes the unique ID of the user. Additional keys: not allowed
users[].details.id	string	Required within parent	Represents the unique system-generated identifier of the updated user. Maximum length: 19
users[].message	string	Optional	Indicates the message describing the outcome of the user update operation. Possible values: User updated - The user record updates successfully. Known values: User updated
users[].status	string	Optional	Indicates the overall processing status of the user update request. Possible values: success - The request processes and the user record updates without errors. Known values: success

Schemas

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

Policy, approvals and errors

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