Zoho: Share Record Emails — record Share Email share Bulk Emails

← Record share email operations · Get started

Operation zoho.sharebulkemails

Provider route: POST /crm/v8/{moduleApiName}/actions/share_emails. 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["recordShareEmail"]["shareBulkEmails"]>[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.recordShareEmail.shareBulkEmails(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.record_share_email.share_bulk_emails(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
body	object	Required within parent	Represents the request body schema for sharing emails in bulk, containing an array of record IDs. Additional keys: not allowed
body.ids	array	Required within parent	Specify the list of record IDs whose emails you want to share. Accepts up to 100 record IDs per request. Maximum items: 100
body.ids[]	string	Each item	Represents the unique identifier of a CRM record. Format: string

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	Represents the 200 response schema for the shareBulkEmails operation, containing an array of per-record email sharing results. Additional keys: not allowed
$ (anyOf 1).data	array	Optional	Represents the list of per-record email sharing results. Always present in the response. Maximum items: 100
$ (anyOf 1).data[]	object	Each item	Represents the result for a single record in the bulk email sharing response. Additional keys: not allowed
$ (anyOf 1).data[].code	string	Required within parent	Represents the result code for the email sharing operation. Possible values: SUCCESS - the email sharing completed successfully. Always present in the response. Known values: SUCCESS
$ (anyOf 1).data[].details	object	Required within parent	Represents the details of the record that was shared. Always present in the response. Additional keys: not allowed
$ (anyOf 1).data[].details.id	string	Required within parent	Represents the unique identifier of the shared record. Always present in the response. Format: string
$ (anyOf 1).data[].message	string	Required within parent	Represents the result message for the email sharing operation. Always present in the response. Known values: Successfully shared
$ (anyOf 1).data[].status	string	Required within parent	Represents the overall operation status. Possible values: success - the email sharing completed successfully. Always present in the response. Known values: success
$ (anyOf 2)	object	Alternative	Represents the 207 partial success response schema for the shareBulkEmails operation, where each item indicates an individual record’s outcome. Additional keys: not allowed
$ (anyOf 2).data	array	Optional	Represents the list of per-record results for the partial success response. Always present in the response. Maximum items: 100
$ (anyOf 2).data[]	JSON	Each item	Represents the outcome for a single record in the partial success response. Each item contains a result code, record details, and status.
$ (anyOf 2).data[] (anyOf 1)	object	Alternative	Represents a per-record result where the email threads are already shared with colleagues. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).code	string	Required within parent	Represents the result code for a record whose emails are already shared. Possible values: ALREADY_SHARED - the emails for this record are already shared with colleagues. Known values: ALREADY_SHARED
$ (anyOf 2).data[] (anyOf 1).details	object	Required within parent	Represents additional details about the already-shared record. Always present in the response. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 1).details.id	string	Required within parent	Represents the unique identifier of the already-shared record. Always present in the response. Format: string
$ (anyOf 2).data[] (anyOf 1).message	string	Required within parent	Represents the message describing the already-shared status. Always present in the response. Known values: Emails are already shared to the colleagues already
$ (anyOf 2).data[] (anyOf 1).status	string	Required within parent	Represents the status for this result item. Possible values: error - the emails are already shared. Always present in the response. Known values: error
$ (anyOf 2).data[] (anyOf 2)	object	Alternative	Represents a per-record result where email sharing completed successfully. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 2).code	string	Required within parent	Represents the result code for a successfully shared record. Possible values: SUCCESS - the email sharing completed successfully for this record. Known values: SUCCESS
$ (anyOf 2).data[] (anyOf 2).details	object	Required within parent	Represents the details of the successfully shared record. Always present in the response. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 2).details.id	string	Required within parent	Represents the unique identifier of the successfully shared record. Always present in the response. Format: string
$ (anyOf 2).data[] (anyOf 2).message	string	Required within parent	Represents the result message for the successfully shared record. Always present in the response. Known values: Successfully shared
$ (anyOf 2).data[] (anyOf 2).status	string	Required within parent	Represents the status for this result item. Possible values: success - the email sharing completed for this record. Always present in the response. Known values: success
$ (anyOf 2).data[] (anyOf 3)	Model	Alternative	Expand Unshare emails in bulk — response body — data / item / code: INVALID DATA, message: the related id given seems to be invalid, status: error
$ (anyOf 2).data[] (anyOf 4)	object	Alternative	Represents a per-record result where the email sharing operation was not permitted for the record. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 4).code	string	Required within parent	Represents the result code for a record where the operation is not allowed. Possible values: NOT_ALLOWED - the operation is not permitted for this record. Known values: NOT_ALLOWED
$ (anyOf 2).data[] (anyOf 4).details	object	Required within parent	Represents additional error context for the not-allowed result. Always present in the response. Additional keys: not allowed
$ (anyOf 2).data[] (anyOf 4).details.resource_path_index	JSON	Required within parent
$ (anyOf 2).data[] (anyOf 4).details.resource_path_index (anyOf 1)	integer	Alternative	Represents the index of the resource path element associated with this error. Always present in the response. Format: int32
$ (anyOf 2).data[] (anyOf 4).details.resource_path_index (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2).data[] (anyOf 4).message	string	Required within parent	Represents the error message for the not-allowed result. Always present in the response. Format: string
$ (anyOf 2).data[] (anyOf 4).status	string	Required within parent	Represents the status for this result item. Possible values: error - the operation is not allowed. Always present in the response. Known values: error
$ (anyOf 2).data[] (anyOf 5)	Model	Alternative	Expand Unshare emails in bulk — response body — data / item / code: DUPLICATE DATA, message: Duplicate Data, status: error

Referenced models: Unshare emails in bulk — response body — data / item / code: DUPLICATE DATA, message: Duplicate Data, status: error, Unshare emails in bulk — response body — data / item / code: INVALID DATA, message: the related id given seems to be invalid, status: error

Schemas

Unshare emails in bulk — response body — data / item / code: DUPLICATE DATA, message: Duplicate Data, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-record result where the record ID was submitted more than once in the request. Additional keys: not allowed
code	string	Required within parent	Represents the result code for a duplicate record ID. Possible values: **DUPLICATE_DATA** - this record ID appears more than once in the request. Known values: DUPLICATE_DATA
details	object	Required within parent	Represents additional details about the duplicate record. Always present in the response. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the duplicate record. Always present in the response. Format: string
message	string	Required within parent	Represents the message for the duplicate data result. Always present in the response. Known values: Duplicate Data
status	string	Required within parent	Represents the status for this result item. Possible values: **error** - a duplicate record ID was found. Always present in the response. Known values: error

Unshare emails in bulk — response body — data / item / code: INVALID DATA, message: the related id given seems to be invalid, status: error

Field	Type	Presence	Description and constraints
$	object	Root	Represents a per-record result where the record ID failed validation. Additional keys: not allowed
code	string	Required within parent	Represents the result code for a record that failed validation. Possible values: **INVALID_DATA** - the record ID is invalid or not found. Known values: INVALID_DATA
details	object	Required within parent	Represents additional details about the invalid record. Always present in the response. Additional keys: not allowed
details.id	string	Required within parent	Represents the unique identifier of the invalid record. Always present in the response. Format: string
message	string	Required within parent	Represents the error message for the invalid data result. Always present in the response. Known values: the related id given seems to be invalid
status	string	Required within parent	Represents the status for this result item. Possible values: **error** - the record ID is invalid. Always present in the response. Known values: error

Policy, approvals and errors

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