Zoho CRM: Share Records Create Share Records

Share a Zoho CRM record with other users, choosing read-only or read-write access.

Tool ID: zoho_crm_share_records_create_share_records

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_share_records_create_share_records',
  {
    "moduleApiName": "Example",
    "recordId": "record_123",
    "share": [
      {
        "type": "private",
        "permission": "read_only",
        "shared_with": {
          "type": "roles",
          "id": "id_123"
        }
      }
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_share_records_create_share_records --input '{
  "moduleApiName": "Example",
  "recordId": "record_123",
  "share": [
    {
      "type": "private",
      "permission": "read_only",
      "shared_with": {
        "type": "roles",
        "id": "id_123"
      }
    }
  ]
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "share": [
      {
        "code": "SUCCESS",
        "details": {},
        "message": "record will be shared successfully",
        "status": "success"
      }
    ]
  }
}

Use deepline describe zoho_crm_share_records_create_share_records --json for the latest machine-readable contract.

Input reference

Create Share Records Request

Name	Type	Required	Default	Details
`payload.moduleApiName`	`string`	Yes	—	API name of the module Maximum length: 100.
`payload.recordId`	`string`	Yes	—	ID of the record Maximum length: 20.
`payload.share`	`array`	Yes	—	additional information Maximum items: 20.
`payload.notify_shared_members`	`boolean`	No	—	indicates whether to notify the shared members
`payload.notify_on_completion`	`boolean`	No	—	indicates whether to notify on completion

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Create Share Records Success Response
`result.data.share`	`array`	No	—	list of share record creation responses Maximum items: 20.
`result.data.share[].code`	`"SUCCESS"`	Yes	—	response code Allowed: `SUCCESS`.
`result.data.share[].details`	`record`	Yes	—	additional information
`result.data.share[].message`	`"record will be shared successfully"`	Yes	—	response message Allowed: `record will be shared successfully`.
`result.data.share[].status`	`"success"`	Yes	—	response status Allowed: `success`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation