Zoho: Deal Contact Roles — deal Contact Roles upsert Contact Role Relations

← Deal contact roles operations · Get started

Operation zoho.upsertcontactrolerelations

Provider route: PUT /crm/v8/{module}/{dealId}/Contact_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["dealContactRoles"]["upsertContactRoleRelations"]>[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.dealContactRoles.upsertContactRoleRelations(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.deal_contact_roles.upsert_contact_role_relations(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.module	string	Required within parent	One of: Deals
path.dealId	string	Required within parent	Format: int64
body	Model	Required within parent	Expand Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — request body — body

Referenced models: Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — 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 Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — response body

Referenced models: Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — response body

Schemas

Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body of a successfully added after adding or updating contact role relations. Additional keys: not allowed
data	array	Required within parent	Status entries for each processed relation Maximum items: 100 Minimum items: 1
data[]	object	Each item	Result for processing a single relation Additional keys: not allowed
data[].code	string	Required within parent	Operation status code Must equal: SUCCESS
data[].details	object	Required within parent	Details about the processed relation Additional keys: not allowed
data[].details.id	string	Required within parent	Identifier of the processed relation Format: int64
data[].message	string	Required within parent	Result message describing the action performed Known values: relation updated, relation added
data[].status	string	Required within parent	Operation status Must equal: success

Deal Contact Roles — deal Contact Roles upsert Contact Role Relations — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for adding or updating contact role relations on a deal. Additional keys: not allowed
data	array	Required within parent	List of contact role relations to upsert Maximum items: 100 Minimum items: 1
data[]	object	Each item	Contact role relation definition Additional keys: not allowed
data[].Contact_Role	object	Required within parent	Contact role to associate with the relation Additional keys: not allowed
data[].Contact_Role.id	string	Required within parent	Contact role identifier Format: int64
data[].Contact_Role.name	string	Optional	Contact role display name Maximum length: 255
data[].id	string	Required within parent	Identifier of the contact relation for the deal Format: int64

Policy, approvals and errors

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