Zoho: Update Contact Roles

← Contact roles operations · Get started

Operation zoho.updatecontactroles

Provider route: PUT /crm/v8/Contacts/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["contactRoles"]["updateContactRoles"]>[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.contactRoles.updateContactRoles(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.contact_roles.update_contact_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	Specify the contact role details to update in the CRM organization. Additional keys: not allowed
body.contact_roles	array	Required within parent	Specify the list of contact roles to update. Maximum items: 100
body.contact_roles[]	object	Each item	Specify the details of a single contact role to update. Additional keys: not allowed
body.contact_roles[].id	string	Required within parent	Specify the unique ID of the contact role to update. Use the [List Contact Roles](contact_roles.yaml#$.paths./contacts/roles.get) resource to retrieve contact role IDs. Maximum length: 19
body.contact_roles[].name	string	Required within parent	Specify the name of the contact role. Maximum length: 50 Pattern: [A-Za-z0-9 ]{1,50}
body.contact_roles[].sequence_number	number	Optional	Specify the display position of the contact role in the CRM UI picklist.

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
$	JSON	Root
$ (anyOf 1)	object	Alternative	Contains the results of the contact role update operation. Additional keys: not allowed
$ (anyOf 1).contact_roles	array	Required within parent	Contains the update results for each contact role in the request. Maximum items: 100
$ (anyOf 1).contact_roles[]	object	Each item	Represents the update result for a single contact role in the request. Additional keys: not allowed
$ (anyOf 1).contact_roles[].code	string	Required within parent	Represents the status code of the update operation. Possible values: - SUCCESS - The contact role update completed successfully. Known values: SUCCESS
$ (anyOf 1).contact_roles[].details	object	Required within parent	Represents the details of the updated contact role. Additional keys: not allowed
$ (anyOf 1).contact_roles[].details.id	string	Required within parent	Represents the unique ID of the updated contact role. Maximum length: 19
$ (anyOf 1).contact_roles[].message	string	Required within parent	Represents the message describing the result of the update operation. Maximum length: 255
$ (anyOf 1).contact_roles[].status	string	Required within parent	Represents the overall status of the update operation. Possible values: - success - The contact role update completed successfully. Known values: success
$ (anyOf 2)	object	Alternative	Contains mixed success and error results for bulk contact role update. Additional keys: not allowed
$ (anyOf 2).contact_roles	array	Required within parent	Contains the mixed results for each contact role in the request. Maximum items: 100
$ (anyOf 2).contact_roles[]	JSON	Each item	Represents a single result entry, which is either a success record or an error record.
$ (anyOf 2).contact_roles[] (anyOf 1)	Model	Alternative	Expand Create Contact Roles — response body — contact_roles / contact_roles / item / code: MANDATORY NOT FOUND, status: error
$ (anyOf 2).contact_roles[] (anyOf 2)	Model	Alternative	Expand Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error
$ (anyOf 2).contact_roles[] (anyOf 3)	Model	Alternative	Expand Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error
$ (anyOf 2).contact_roles[] (anyOf 4)	Model	Alternative	Expand Update Contact Roles — response body — contact roles contact roles item array
$ (anyOf 2).contact_roles[] (anyOf 5)	Model	Alternative	Expand Create Contact Roles — response body — contact roles contact roles item
$ (anyOf 2).contact_roles (allOf 1)	JSON	All variants apply	Ensures the array contains at least one successfully updated contact role.
$ (anyOf 2).contact_roles (allOf 2)	JSON	All variants apply	Ensures the array contains at least one contact role that failed validation.

Referenced models: Update Contact Roles — response body — contact roles contact roles item array, Create Contact Roles — response body — contact roles contact roles item, Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error, Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error, Create Contact Roles — response body — contact_roles / contact_roles / item / code: MANDATORY NOT FOUND, status: error

Schemas

Update Contact Roles — response body — contact roles contact roles item array

Field	Type	Presence	Description and constraints
$	array	Root	Contains the list of duplicate data errors for contact role operations. Maximum items: 100
$[]	object	Each item	Represents a duplicate data error for a contact role field. Additional keys: not allowed
$[].code	string	Required within parent	Represents the error code. **Possible values:** - **DUPLICATE_DATA** - A contact role with the same name already exists. Known values: DUPLICATE_DATA
$[].details	JSON	Required within parent	Represents the error details for the duplicate data.
$[].details (anyOf 1)	Model	Alternative	Expand Update Contact Roles — response body — contact roles contact roles item array item details api name, id, json path
$[].details (anyOf 2)	object	Alternative	Represents duplicate data error details that include the API name and JSON path of the conflicting field. Additional keys: not allowed
$[].details (anyOf 2).api_name	string	Required within parent	Represents the API name of the field that contains a duplicate value. Maximum length: 100
$[].details (anyOf 2).json_path	string	Required within parent	Represents the JSON path to the field that contains a duplicate value. Maximum length: 255
$[].message	string	Required within parent	Represents the error message. Maximum length: 255
$[].status	string	Required within parent	Represents the error status. **Possible values:** - **error** - The request failed. Known values: error

Referenced models: Update Contact Roles — response body — contact roles contact roles item array item details api name, id, json path

Create Contact Roles — response body — contact roles contact roles item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a successful contact role operation. Additional keys: not allowed
code	string	Required within parent	Represents the status code of the operation. **Possible values:** - **SUCCESS** - The contact role operation completed successfully. Known values: SUCCESS
details	object	Required within parent	Represents the details of the contact role for the create or update operation. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique ID of the contact role. Maximum length: 19
message	string	Required within parent	Represents the message describing the result of the operation. Maximum length: 255
status	string	Required within parent	Represents the overall status of the operation. **Possible values:** - **success** - The contact role operation completed successfully. Known values: success

Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents an error when a contact role with the same name already exists in the CRM organization. Additional keys: not allowed
code	string	Required within parent	Represents the error code. **Possible values:** - **DUPLICATE_DATA** - A contact role with the same name already exists. Known values: DUPLICATE_DATA
details	Model	Required within parent	Expand Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error details
message	string	Required within parent	Represents the error message. Maximum length: 255
status	string	Required within parent	Represents the error status. **Possible values:** - **error** - The request failed. Known values: error

Referenced models: Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error details

Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents an invalid data error for a contact role field in an update operation. Additional keys: not allowed
code	string	Required within parent	Represents the error code. **Possible values:** - **INVALID_DATA** - The contact role data is invalid. Known values: INVALID_DATA
details	Model	Required within parent	Expand Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details
message	string	Required within parent	Represents the error message. Maximum length: 255
status	string	Required within parent	Represents the error status. **Possible values:** - **error** - The request failed. Known values: error

Referenced models: Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details

Create Contact Roles — response body — contact_roles / contact_roles / item / code: MANDATORY NOT FOUND, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents an error when a required field is missing from the request. Additional keys: not allowed
code	string	Required within parent	Represents the error code. **Possible values:** - **MANDATORY_NOT_FOUND** - A required field is missing from the request. Known values: MANDATORY_NOT_FOUND
details	object	Required within parent	Represents the error details for the missing field. Additional keys: not allowed
details.api_name	string	Required within parent	Represents the API name of the missing required field. Maximum length: 100
details.json_path	string	Required within parent	Represents the JSON path to the missing required field. Maximum length: 255
message	string	Required within parent	Represents the error message. Maximum length: 255
status	string	Required within parent	Represents the error status. **Possible values:** - **error** - The request failed. Known values: error

Update Contact Roles — response body — contact roles contact roles item array item details api name, id, json path

Field	Type	Presence	Description and constraints
$	object	Root	Represents duplicate data error details that include the ID of the conflicting record. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that contains a duplicate value. Maximum length: 100
id	string	Required within parent	Represents the ID of the existing contact role that conflicts with the duplicate name. Maximum length: 19
json_path	string	Required within parent	Represents the JSON path to the field that contains a duplicate value. Maximum length: 255

Update Contact Roles — response body — contact_roles / contact_roles / item / code: DUPLICATE DATA, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details for the duplicate data. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that contains a duplicate value. Maximum length: 100
id	string	Optional	Represents the ID of the contact role that has the duplicate name. Maximum length: 19
json_path	string	Required within parent	Represents the JSON path to the field that contains a duplicate value. Maximum length: 255

Update Contact Roles — response body — contact_roles / contact_roles / item / code: INVALID DATA, status: error details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the error details for the invalid data. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the field that contains invalid data. Maximum length: 100
id	string	Optional	Represents the ID of the contact role that triggered the invalid data error. Maximum length: 19
json_path	string	Required within parent	Represents the JSON path to the field that contains invalid data. Maximum length: 255

Policy, approvals and errors

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