Zoho: Get email sharing details for a record

← Emails sharing details operations · Get started

Operation zoho.getemailsharingdetail

Provider route: GET /crm/v8/{moduleApiName}/{id}/__emails_sharing_details. 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["emailsSharingDetails"]["getEmailSharingDetail"]>[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.emailsSharingDetails.getEmailSharingDetail(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.emails_sharing_details.get_email_sharing_detail(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.moduleApiName	string	Required within parent	One of: Leads, Contacts, Accounts, Deals, CustomModule1
path.id	string	Required within parent	Record ID Maximum length: 100

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 body for the Get Email Shared Details operation, containing the email sharing configuration for the requested record. Additional keys: not allowed
__emails_sharing_details	array	Optional	A JSON array representing the list of email sharing configurations for the record, including the users whose emails can be shared and the available email filter options. Maximum items: 1
__emails_sharing_details[]	object	Each item	Represents the email sharing configuration for the record, containing the list of users whose emails are accessible and the available email filter options. Additional keys: not allowed
__emails_sharing_details[].available_types	array	Required within parent	Represents the available email filter options for the record’s email view. Always returned in the response. Maximum items: 5 Minimum items: 1
__emails_sharing_details[].available_types[]	string	Each item	Represents an email filter option. Possible values: emails_sent_from_crm, all_contacts_emails, all_imap_shared_users, all_pop_shared_users, all_emails. Known values: emails_sent_from_crm, all_contacts_emails, all_imap_shared_users, all_pop_shared_users, all_emails
__emails_sharing_details[].shared_from_users	JSON	Required within parent
__emails_sharing_details[].shared_from_users (anyOf 1)	array	Alternative	Specifies the list of users whose email accounts are accessible when viewing the record’s emails. Always returned in the response. Maximum items: 50
__emails_sharing_details[].shared_from_users (anyOf 1)[]	Model	Each item	Expand Get email sharing details for a record — response body — emails sharing details item shared from users null item
__emails_sharing_details[].shared_from_users (anyOf 2)	null	Alternative	Specifies the list of users whose email accounts are accessible when viewing the record’s emails. Always returned in the response. Maximum items: 50
__emails_sharing_details[].shared_from_users (anyOf 2)[]	Model	Each item	Expand Get email sharing details for a record — response body — emails sharing details item shared from users null item

Referenced models: Get email sharing details for a record — response body — emails sharing details item shared from users null item

Schemas

Get email sharing details for a record — response body — emails sharing details item shared from users null item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a user whose email account is accessible for the record's email view, including the user's name, unique ID, and email account type. Additional keys: not allowed
_type	string	Required within parent	Represents the type of email account used by the user. Possible values: **imap**, **pop**, **api**. Always returned in the response. Known values: imap, pop, api
id	string	Required within parent	Represents the unique ID of the user. Always returned in the response. Maximum length: 100
name	string	Required within parent	Represents the name of the user with email access. Maximum length: 250

Policy, approvals and errors

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