Share a record

POST/{moduleApiName}/{recordId}/actions/share

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Share a record action (under Records).
Fill in the fields below, then reference the result from later steps as {{shareARecord.response.data}}.

Request

Path parameters

moduleApiNamestringrequired

Specify the API name of the module that owns the record. Refer to the [Get Modules API](modules.yaml#$.paths./settings/modules.get) for valid values.

recordIdstring (int64)required

Specify the unique ID of the record. Refer to the [Get Records API](record.yaml#$.paths./{module}.get) for valid values.

Request body

Enter the body as JSON in the step's Body field.

sharearray<object>required

Specify the list of share entries to apply. Each entry defines a recipient, the access level, and the type of sharing. You can provide a maximum of **20** entries in a single request.

typestringrequired

Specify the type of sharing to apply to the record. **Possible values**: - private - public

One ofprivatepublic

share_related_recordsboolean

Specify whether to share the related records along with the record. **Possible values**: - true - false

permissionstringrequired

Specify the level of access to grant for the shared record. **Possible values**: - read_only - read_write - full_access

One ofread_onlyread_writefull_access

shared_withoneOfrequired

Specify the details of the entity (user, role, or group) with which to share the record.

notify_shared_membersboolean

Specify whether to send a notification to the members with whom the record is shared. **Possible values**: - true - false

notify_on_completionboolean

Specify whether to send an email notification to the record owner once the share action is completed. **Possible values**: - true - false

json

{
  "share": [
    {
      "type": "private",
      "permission": "read_only",
      "shared_with": null,
      "share_related_records": false
    }
  ],
  "notify_shared_members": false,
  "notify_on_completion": false
}

Response

Returns 201 with an object. Read it in later steps with {{shareARecord.response.data.<field>}}.

sharearray<object>

Represents details of each share record creation result.

codestringrequired

Represents the response code returned by the API.

One ofSUCCESS

detailsobjectrequired

Represents the additional information about the response.

messagestringrequired

Represents the response message returned by the API.

One ofrecord will be shared successfully

statusstringrequired

Represents the status of the API call.

One ofsuccess

json

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

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?