Zoho: Link Emails to Deals

← Deal link emails operations · Get started

Operation zoho.linkemailstodeals

Provider route: POST /crm/v8/Contacts/{contactId}/Emails/actions/link_record. 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["dealLinkEmails"]["linkEmailsToDeals"]>[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.dealLinkEmails.linkEmailsToDeals(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_link_emails.link_emails_to_deals(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.contactId	string	Required within parent	Maximum length: 100 Pattern: ^[0-9]+$
body	object	Required within parent	The request body schema for linking emails to deals. Additional keys: not allowed
body.Emails	array	Optional	Array containing the details of the emails to link to deals. Mandatory. Maximum items: 20
body.Emails[]	object	Each item	Object containing the details of the email to link to a deal. Additional keys: not allowed
body.Emails[].linked_record	object	Required within parent	The details of the deal record to be linked to the email. Mandatory. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs Additional keys: not allowed
body.Emails[].linked_record.id	string	Required within parent	The unique ID of the deal record that the email must be linked to. Mandatory. Maximum length: 100 Pattern: ^[0-9]+$
body.Emails[].linked_record.module	object	Required within parent	The details of the Deals module. Mandatory. Additional keys: not allowed
body.Emails[].linked_record.module.api_name	string	Optional	The API name of the Deals module. Mandatory. One of: Deals
body.Emails[].linked_record.module.id	string	Required within parent	The unique ID of the Deals module. Mandatory. Maximum length: 100 Pattern: ^[0-9]+$
body.Emails[].linked_record.name	string	Optional	The name of the deal record that the email must be linked to. Mandatory. Maximum length: 255
body.Emails[].message_id	string	Required within parent	The unique message ID of the email to which the deal will be linked. Mandatory when linking multiple emails. You can obtain message ID of a record through [Get Emails of a Record API](emails.yaml#$.paths.{moduleApiName}/{id}/Emails/{messageId}.get). Maximum length: 500 Pattern: ^[a-zA-Z0-9]+$
body.Emails[].owner	object	Required within parent	The details of the user whose email you want to link. Mandatory. Additional keys: not allowed
body.Emails[].owner.id	string	Optional	The unique ID of the user whose email you want to link. Mandatory. Maximum length: 100 Pattern: ^[0-9]+$

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	Successful response containing the link operation results. Additional keys: not allowed
Emails	array	Required within parent	List of email link operation results Maximum items: 20
Emails[]	object	Each item	Email link operation result Additional keys: not allowed
Emails[].code	string	Required within parent	Result code of the link operation Known values: SUCCESS
Emails[].details	object	Required within parent	Additional details about the link operation Additional keys: not allowed
Emails[].details.message_id	string	Required within parent	Unique identifier of the email message Maximum length: 255
Emails[].message	string	Required within parent	Detailed message about the link operation Maximum length: 256
Emails[].status	string	Required within parent	Status of the link operation Known values: success

Policy, approvals and errors

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