Zoho: Create a role

← Roles operations · Get started

Operation zoho.createroles

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

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	object	Required within parent	Represents the request body for creating one or more CRM roles. Additional keys: not allowed
body.roles	array	Required within parent	Specify the array of role objects to create. You can include exactly one object per request (bulk create/update is not supported). Maximum items: 1
body.roles[]	object	Each item	Specify the details of an individual role to create. Additional keys: not allowed
body.roles[].description	string or null	Optional	Specify the description of the role to provide additional context about its purpose and responsibilities. Maximum length: 250
body.roles[].name	string	Required within parent	Specify the display name for the role. Maximum length: 200
body.roles[].reporting_to	object	Required within parent	Specify the parent role to which this new role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values. Additional keys: not allowed
body.roles[].reporting_to.id	string	Optional	Specify the unique ID of the parent role in the role hierarchy. Maximum length: 19
body.roles[].share_with_peers	boolean or null	Optional	Specify whether users assigned to this role can share records with users in peer roles at the same level. Possible values: true - Users assigned to this role can share records with peer role users. false - Users assigned to this role cannot share records with peer role users.

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 successful response for the role creation operation. Additional keys: not allowed
roles	array	Required within parent	Represents the list of role creation results. Maximum items: 1
roles[]	object	Each item	Represents the creation result for an individual role in the request. Additional keys: not allowed
roles[].code	string	Required within parent	Represents the result code of the role creation operation. Possible values: SUCCESS - The role creation succeeded. Known values: SUCCESS
roles[].details	object	Required within parent	Represents additional details about the created role. Additional keys: not allowed
roles[].details.id	string	Required within parent	Represents the unique ID of the newly created role. Maximum length: 19
roles[].message	string	Required within parent	Represents the status message for the role creation result. Maximum length: 100
roles[].status	string	Required within parent	Represents the status of the role creation operation. Possible values: success - The role creation succeeded. Known values: success

Policy, approvals and errors

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