Zoho: Share records schemas
8 Zoho schemas with complete fields and constraints.
← Share records operations · All schemas
Update share permissions — response body — Represents the partial success response / share / item / value / code: INVALID DATA, message: cannot share the related records, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when **share_related_records** is set on a module that does not support sharing related records. Additional keys: not allowed |
code | string | Required within parent | Represents the response code returned by the API. Known values: INVALID_DATA |
details | object | Required within parent | Represents the additional information about the response. Additional keys: not allowed |
details.api_name | string | Required within parent | Represents the API name of the parameter that caused the error. Maximum length: 50 |
details.json_path | string | Required within parent | Represents the JSON path of the parameter that caused the error. Maximum length: 100 |
message | string | Required within parent | Represents the response message returned by the API. Known values: cannot share the related records |
status | string | Required within parent | Represents the status of the API call. Known values: error |
Update share permissions — response body — Represents the partial success response / share / item / value / code: INVALID DATA, message: invalid data, status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the additional information about the response. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the parameter that caused the error. Maximum length: 50 |
dependee | object | Required within parent | Represents the details of the parameter on which this parameter depends. Additional keys: not allowed |
dependee.api_name | string | Required within parent | Represents the API name of the parameter that caused the error. Maximum length: 50 |
dependee.json_path | string | Required within parent | Represents the JSON path of the parameter that caused the error. Maximum length: 100 |
json_path | string | Required within parent | Represents the JSON path of the parameter that caused the error. Maximum length: 100 |
Update share permissions — response body — Represents the partial success response / share / item / value / code: INVALID DATA, message: invalid data, status: error — Invalid Share With Value Error Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the **shared_with** object in a share entry is invalid due to a dependent field mismatch. Additional keys: not allowed |
code | string | Required within parent | Represents the response code returned by the API. Known values: INVALID_DATA |
details | Model | Required within parent | Expand Update share permissions — response body — Represents the partial success response / share / item / value / code: INVALID DATA, message: invalid data, status: error details |
message | string | Required within parent | Represents the response message returned by the API. Known values: invalid data |
status | string | Required within parent | Represents the status of the API call. Known values: error |
Update share permissions — response body — Represents the partial success response / share / item / value / code: INVALID DATA, message: invalid data, status: error — Invalid Type Error Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the `type` or `permission` field in a share entry does not match the expected pattern. Additional keys: not allowed |
code | string | Required within parent | Represents the response code returned by the API. Known values: INVALID_DATA |
details | object | Required within parent | Represents the additional information about the response. Additional keys: not allowed |
details.api_name | string | Required within parent | Represents the API name of the parameter that caused the error. **Possible values**: - type - permission Known values: type, permission |
details.json_path | string | Required within parent | Represents the JSON path of the parameter that caused the error. Maximum length: 100 |
details.regex | string | Required within parent | Represents the regular expression pattern expected for the parameter value. Known values: private|public, read_only|read_write|full_access |
message | string | Required within parent | Represents the response message returned by the API. Known values: invalid data |
status | string | Required within parent | Represents the status of the API call. Known values: error |
Update share permissions — response body — Represents the partial success response / share / item / value / code: INVALID DATA, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the recipient ID in **shared_with** is invalid or when the record cannot be shared with the specified entity. Additional keys: not allowed |
code | string | Required within parent | Represents the response code returned by the API. Known values: INVALID_DATA |
details | object | Required within parent | Represents the additional information about the response. Additional keys: not allowed |
details.api_name | string | Required within parent | Represents the API name of the parameter that caused the error. Maximum length: 50 |
details.json_path | string | Required within parent | Represents the JSON path of the parameter that caused the error. Maximum length: 100 |
message | string | Required within parent | Represents the response message returned by the API. **Possible values**: - invalid data - invalid user Id - invalid role Id - invalid group Id - cannot share to the user Known values: invalid data, invalid user Id, invalid role Id, invalid group Id, cannot share to the user |
status | string | Required within parent | Represents the status of the API call. Known values: error |
Update share permissions — response body — Represents the partial success response / share / item / value / code: LIMIT EXCEEDED, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when the share entry exceeds the per-record sharing limit for the recipient type. Additional keys: not allowed |
code | string | Required within parent | Represents the response code returned by the API. Known values: LIMIT_EXCEEDED |
details | object | Required within parent | Represents the additional information about the response. Additional keys: not allowed |
details.api_name | string | Optional | Represents the API name of the parameter that caused the error. Known values: type |
details.json_path | string | Optional | Represents the JSON path of the parameter that caused the error. Maximum length: 100 |
details.limit | JSON | Optional | |
details.limit (anyOf 1) | integer | Alternative | Represents the maximum number of share records allowed for the entity type. Format: int32 |
details.limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
message | string | Required within parent | Represents the response message returned by the API. Maximum length: 100 |
status | string | Required within parent | Represents the status of the API call. Known values: error |
Update share permissions — response body — Represents the partial success response / share / item / value / code: MANDATORY NOT FOUND, message: required field not found, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the error response returned when a mandatory field is missing from the share entry. Additional keys: not allowed |
code | string | Required within parent | Represents the response code returned by the API. Known values: MANDATORY_NOT_FOUND |
details | object | Required within parent | Represents the additional information about the response. Additional keys: not allowed |
details.api_name | string | Required within parent | Represents the API name of the parameter that caused the error. Maximum length: 50 |
details.json_path | string | Required within parent | Represents the JSON path of the parameter that caused the error. Maximum length: 100 |
message | string | Required within parent | Represents the response message returned by the API. Known values: required field not found |
status | string | Required within parent | Represents the status of the API call. Known values: error |
Update share permissions — response body — share share item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the per-entry success result of a share record create or update operation. Additional keys: not allowed |
code | string | Required within parent | Represents the response code returned by the API. Known values: SUCCESS |
details | object | Required within parent | Represents the additional information about the response. Additional keys: not allowed |
message | string | Required within parent | Represents the response message returned by the API. Known values: record will be shared successfully |
status | string | Required within parent | Represents the status of the API call. Known values: success |