Zoho: Notifications schemas
7 Zoho schemas with complete fields and constraints.
← Notifications operations · All schemas
Create notification channels — response body — watch
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the partial create results, where each entry in the watch array is either a success or an error. Additional keys: not allowed |
watch | array | Optional | Represents the list of result entries, where each item is either a successful create result or an error response. Maximum items: 50 |
watch[] | JSON | Each item | |
watch[] (anyOf 1) | Model | Alternative | Expand Create notification channels — response body — watch / watch / item / code: SUCCESS, status: success |
watch[] (anyOf 2) | Model | Alternative | Expand Create notification channels — response body — watch / watch / item / status: error |
Referenced models: Create notification channels — response body — watch / watch / item / status: error, Create notification channels — response body — watch / watch / item / code: SUCCESS, status: success
Create notification channels — response body — watch / watch / item / code: SUCCESS, status: success
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a successful create result for a single notification channel. Additional keys: not allowed |
code | string | Optional | Represents the result code for a successful operation. **Possible values:** **SUCCESS** - The operation completed successfully. Known values: SUCCESS |
details | object | Optional | Created event channel details. Additional keys: allowed |
message | string | Optional | Result message. Maximum length: 255 |
status | string | Optional | Status string. Known values: success |
Create notification channels — response body — watch / watch / item / status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the standard error response structure returned when a request fails. Additional keys: not allowed |
code | string | Required within parent | Represents the specific error code identifying the type of failure. Known values: INVALID_DATA, INVALID_QUERY, NOT_SUBSCRIBED, EXPECTED_PARAM_MISSING, LIMIT_REACHED, NOT_SUPPORTED, INVALID_REQUEST_METHOD, AUTHORIZATION_FAILED, OAUTH_SCOPE_MISMATCH, NO_PERMISSION, INVALID_URL_PATTERN, INTERNAL_ERROR, RATE_LIMIT_EXCEEDED, SERVICE_UNAVAILABLE, INVALID_MODULE, MANDATORY_NOT_FOUND, EXPECTED_FIELD_MISSING, AMBIGUITY_DURING_PROCESSING, DEPENDENT_FIELD_MISSING |
details | Model | Optional | Expand Create notification channels — response body — watch / watch / item / status: error details |
message | string | Required within parent | Represents the error message describing the issue. Maximum length: 1000 |
status | string | Required within parent | Represents the response status. **Possible values:** **error** - Indicates an error response. Known values: error Default: error |
Referenced models: Create notification channels — response body — watch / watch / item / status: error details
Create notification channels — response body — watch / watch / item / status: error details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the detailed error information associated with a specific parameter or field that caused the request to fail. Additional keys: not allowed |
ambiguity_due_to | array | Optional | Represents the list of fields that caused ambiguity during request processing. Maximum items: 2 |
ambiguity_due_to[] | object | Each item | Represents a field that contributed to the ambiguity during processing. Additional keys: not allowed |
ambiguity_due_to[].api_name | string | Required within parent | Represents the API name of the field that caused ambiguity. Maximum length: 64 |
ambiguity_due_to[].json_path | string | Required within parent | Represents the JSON path indicating the location of the ambiguous field in the request payload. Maximum length: 256 |
api_name | string | Optional | Represents the API name of the parameter or field that caused the error. Maximum length: 64 |
dependee | object | Optional | Represents the details of a required dependent field that was missing from the request. Additional keys: not allowed |
dependee.api_name | string | Required within parent | Represents the API name of the missing dependent field. Maximum length: 64 |
dependee.json_path | string | Required within parent | Represents the JSON path indicating the location of the missing dependent field in the request payload. Maximum length: 256 |
expected_data_type | string | Optional | Represents the expected data type for the parameter or field that caused the error. Maximum length: 64 |
expected_fields | array | Optional | Represents the list of fields required when at least one of several expected fields is missing. Maximum items: 2 |
expected_fields[] | object | Each item | Represents a field that is required but was not found in the request. Additional keys: not allowed |
expected_fields[].api_name | string | Required within parent | Represents the API name of the required field. Maximum length: 64 |
expected_fields[].json_path | string | Required within parent | Represents the JSON path indicating the location of the required field in the request payload. Maximum length: 256 |
json_path | string | Optional | Represents the JSON path indicating the location of the error in the request payload. Maximum length: 256 |
maximum_length | JSON | Optional | |
maximum_length (anyOf 1) | integer | Alternative | Represents the maximum allowed length for the parameter or field that caused the error. Format: int32 |
maximum_length (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
supported_values | array | Optional | Represents the list of supported values for the parameter or field that caused the error. Maximum items: 2 |
supported_values[] | string | Each item | Represents a single supported value for the parameter or field. Maximum length: 64 |
List active notification channels — response body — watch item notification condition null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single field-selection condition associated with the notification channel. Additional keys: not allowed |
field_selection | Model | Optional | Expand List active notification channels — response body — watch item notification condition null item field selection |
module | object | Optional | Represents the CRM module context associated with the field-selection condition. Additional keys: not allowed |
module.api_name | string | Optional | Represents the API name of the CRM module associated with the condition. Maximum length: 255 |
module.id | string | Optional | Represents the unique identifier of the CRM module associated with the condition. Maximum length: 64 |
type | string | Optional | Represents the type of notification condition. Maximum length: 32 |
Referenced models: List active notification channels — response body — watch item notification condition null item field selection
List active notification channels — response body — watch item notification condition null item field selection
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the field selection configuration, including the grouping operator and the list of field criteria. Additional keys: not allowed |
group | array | Optional | Represents the list of field condition groups used to filter which record field changes trigger the notification. Maximum items: 2 |
group[] | Model | Each item | Expand List active notification channels — response body — watch item notification condition null item field selection group item |
group_operator | string | Optional | Represents the logical operator applied to the field condition groups within the field selection configuration. Maximum length: 3 |
Referenced models: List active notification channels — response body — watch item notification condition null item field selection group item
List active notification channels — response body — watch item notification condition null item field selection group item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single field condition entry, including the field reference, grouping operator, and optional sub-groups. Additional keys: not allowed |
field | object | Optional | Represents the CRM field that the condition monitors for changes. Additional keys: not allowed |
field.api_name | string | Optional | Represents the API name of the CRM field being monitored in the condition. Maximum length: 128 |
field.id | string | Optional | Represents the unique identifier of the CRM field being monitored in the condition. Maximum length: 64 |
group | JSON | Optional | |
group (anyOf 1) | array | Alternative | Represents an optional nested sub-group of field conditions within the parent group. Maximum items: 10 |
group (anyOf 1)[] | JSON | Each item | |
group (anyOf 2) | null | Alternative | Represents an optional nested sub-group of field conditions within the parent group. Maximum items: 10 |
group (anyOf 2)[] | JSON | Each item | |
group_operator | JSON | Optional | |
group_operator (anyOf 1) | string | Alternative | Represents the logical operator applied to the conditions within this sub-group. Possible values: and - All conditions in the sub-group must be satisfied. or - Any condition in the sub-group must be satisfied. null - No grouping operator is applied. Known values: and, or |
group_operator (anyOf 2) | null | Alternative | Represents the logical operator applied to the conditions within this sub-group. Possible values: and - All conditions in the sub-group must be satisfied. or - Any condition in the sub-group must be satisfied. null - No grouping operator is applied. Known values: and, or |