Zoho: Create User

← Users operations · Get started

Operation zoho.createuser

Provider route: POST /crm/v8/users. 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"]["createUser"]>[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.createUser(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.create_user(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Optional	Represents the request payload schema for creating a user in Zoho CRM. Contains the `users` array with user detail objects. Additional keys: not allowed
body.users	array	Required within parent	The request body must contain a `users` array. You can include a maximum of one object 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 response payload schema returned upon successful user creation. Contains the `users` array with the result objects. Additional keys: not allowed
users	array	Optional	Contains the result of the user creation request, including the status, response code, confirmation message, and the unique ID of the newly created user. Maximum items: 1
users[]	object	Each item	Represents the outcome of the user creation request. Each object contains a status indicating success, a response code, a confirmation message, and a object that holds the unique ID of the newly created user. Additional keys: not allowed
users[].code	string	Optional	Indicates the result code for the user creation request. Possible values: `SUCCESS`. Known values: SUCCESS
users[].details	object	Optional	Contains additional information about the created user, including the unique ID assigned to the user record in Zoho CRM. Additional keys: not allowed
users[].details.id	string	Required within parent	Represents the unique ID of the user record created in Zoho CRM. Maximum length: 19
users[].message	string	Optional	Indicates the confirmation message returned upon successful user creation. Possible values: `User added`. Known values: User added
users[].status	string	Optional	Indicates the overall status of the user creation request. Possible values: `success`. 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.createuser. Catalog operation: createUser. 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