Zoho: Email notifications schemas
75 Zoho schemas with complete fields and constraints.
← Email notifications operations · All schemas
Create Email Notifications — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body wrapper for creating an email notification action. The body must contain an email_notifications array with exactly one object. Additional keys: not allowed |
email_notifications | array | Required within parent | Specify the email notification objects to create. The array must contain exactly one object. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Create Email Notifications — request body — body email notifications item |
Referenced models: Create Email Notifications — request body — body email notifications item
Create Email Notifications — request body — body / email_notifications / item / from_address / type: email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the sender address configuration for an email notification, used when the server assigns the address automatically or when the address resolves to a plain email address. Additional keys: not allowed |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: email details |
resource | null | Optional | Represents the resource reference for the sender address. This field is not applicable when the address type is email. |
type | string | Required within parent | Represents the type of sender address for the notification. Possible values: email - The sender address resolves to a plain email address. One of: email Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: email details
Create Email Notifications — request body — body / email_notifications / item / from_address / type: merge field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the address configuration for a merge_field type from or reply-to address in an email notification. Two hardcoded values are always available: ${!Current.User.Email} (the logged-in user's email) and ${!Record.Owner.Email} (the record owner's email). Any user lookup field available in the module can also be used as a from or reply-to address, for example, ${!Deals.Contact_Name.Email}. Use module and field metadata APIs to discover available user lookup fields. Additional keys: not allowed |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: merge field details |
resource | null | Optional | Represents the resource field, which is not applicable for merge_field address types and must be set to null. |
type | string | Required within parent | Represents the address type for this configuration. Possible values: merge_field - Indicates the address is resolved dynamically from a CRM module field or user lookup field. One of: merge_field Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: merge field details
Create Email Notifications — request body — body / email_notifications / item / from_address / type: organization email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the address configuration for an organization email sender in an email notification. The resource.id must be an organization email ID retrieved from Zoho CRM Organization APIs. Additional keys: not allowed |
details | null | Optional | Represents additional details for the address configuration. This field is not applicable when the type is organization_email. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: organization email resource Organization email resource. Use resource.id from Zoho CRM Organization APIs. |
type | string | Required within parent | Represents the address type for the email notification sender configuration. Possible values: organization_email - Indicates that the sender address is an organization email registered in the Zoho CRM organization. One of: organization_email Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: organization email resource
Create Email Notifications — request body — body / email_notifications / item / from_address / type: user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the address configuration for a Zoho CRM user recipient in an email notification. The resource.id must be a valid CRM user ID from the Zoho CRM Users APIs. Additional keys: not allowed |
details | null | Optional | Represents additional address details. This field is not applicable when the type is set to `user` and should be omitted or set to null. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: user resource User resource. Use resource.id from Zoho CRM Users APIs. |
type | string | Required within parent | Represents the address type for the email notification recipient configuration. Possible values: user - Indicates that the recipient address is resolved from a Zoho CRM user. One of: user Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: user resource
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / associated_to: team module, None, type: profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a notification recipient resolved by a CRM profile, used to notify all users sharing a specific profile or permission level. Refer to the GET /settings/profiles endpoint to retrieve valid profile IDs. For private (team) modules, set the `associated_to` field to `team_module`. Additional keys: not allowed |
associated_to | string or null | Optional | Indicates whether the notification module is a private (team) module. Set to `team_module` when the notification targets a private module. Leave null for standard modules. Possible values: team_module - The notification module is a private (team) module. One of: team_module, null Maximum length: 255 |
details | null | Optional | Represents additional recipient details. This field is not applicable for profile recipients and is always null. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile resource Profile resource (name/id) from Zoho CRM Profiles API. |
type | string | Required within parent | Represents the recipient type for this notification recipient definition. Possible values: profile - The recipient is resolved by a CRM profile, notifying all users who share that profile. One of: profile Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile resource
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / associated_to: team module, None, type: user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a specific CRM user, used when the notification must be sent to a named individual. Retrieve the user ID from the Get Users endpoint. For private modules, set the `associated_to` field to `team_module` to include team-scoped users. Additional keys: not allowed |
associated_to | string or null | Optional | Indicates the scope context for recipient resolution. Set to `team_module` when the notification module is a private module where record visibility is restricted to team members. When set, only team-scoped users and profiles are included. Leave null for standard modules. Possible values: team_module - The notification module is a private (team) module; only team-scoped users and profiles are included as recipients. null - The notification module is a standard module; all applicable users and profiles are included. One of: team_module, null Maximum length: 255 |
details | null | Optional | Represents additional details for the recipient. Not applicable for user recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: user resource User resource (name/id) from Zoho CRM Users API. |
type | string | Required within parent | Represents the recipient type for the notification target. For direct user recipients, this value is always `user`. Possible values: user - The recipient is a specific CRM user identified by their user ID. One of: user Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: user resource
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: emails
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient configuration that uses explicit email addresses to specify notification targets. Provide one or more addresses in the details.emails array. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated resource for this recipient type. Not applicable for direct email address recipients. |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails details |
resource | null | Optional | Represents the resource reference for this recipient type. Not applicable for direct email address recipients. |
type | string | Required within parent | Represents the recipient type for this configuration. Possible values: emails - Indicates that recipients are specified using explicit email addresses. One of: emails Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails details
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a CRM user group, used when all members of a group should receive an email notification. Group IDs can be retrieved from the GET /settings/groups endpoint. Not supported in the recipients.to field when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record for this recipient. Not applicable for group recipients. |
details | null | Optional | Represents additional recipient details. Not applicable for group recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group resource Group resource (name/id) from Zoho CRM Groups API. |
type | string | Required within parent | Represents the recipient type for this group recipient. Possible values: group - Indicates that the recipient is resolved from a CRM user group. One of: group Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group resource
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: merge field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved dynamically from a merge field, where the recipient address depends on the triggering record and is resolved at runtime. Merge field recipients fall into two categories: INTERNAL — fields resolving to CRM users, such as ${!Module.Owner} or ${!Module.Created_By}, for which from_address must not be provided and defaults to the first registered email address; and EXTERNAL — fields resolving to email-type fields (ui_type=25), such as ${!Module.Email} or ${!Module.Lookup.Email}, for which from_address is required. Use module and field metadata APIs to retrieve valid field API names. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated entity for the recipient. Not applicable for merge_field recipients; this field is always null. |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field details |
resource | null | Optional | Represents the resource associated with the recipient. Not applicable for merge_field recipients; this field is always null. |
type | string | Required within parent | Represents the recipient type for this entry. Possible values: merge_field - Indicates that the recipient address is resolved dynamically from a record field at runtime. One of: merge_field Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field details
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: role
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved by a CRM role, used to notify all users assigned to a specific role. The role identifier must be retrieved from the GET /settings/roles endpoint. This recipient type is not supported in the recipients.to field when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record context for the recipient. Not applicable for role recipients. |
details | null | Optional | Represents additional details about the recipient. Not applicable for role recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource Role resource (name/id) from Zoho CRM Roles API. |
type | string | Required within parent | Represents the recipient type for this role-based recipient entry. Possible values: role - Identifies the recipient as resolved by a CRM role, sending notifications to all users assigned to that role. One of: role Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: role and subordinate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a role and all subordinate roles below it in the hierarchy, used when a notification must reach a manager and everyone reporting under that role. The role ID must be retrieved from the GET /settings/roles endpoint. This recipient type is not supported in recipients.to when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record for this recipient. Not applicable for role_and_subordinate recipients. |
details | null | Optional | Represents additional details for the recipient. Not applicable for role_and_subordinate recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource Role resource (name/id) from Zoho CRM Roles API. |
type | string | Required within parent | Represents the recipient type for this notification target. Possible values: role_and_subordinate - Resolves the recipient from a role and all subordinate roles below it in the hierarchy. One of: role_and_subordinate Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: territory
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a sales territory in Zoho CRM, used to notify all users assigned to a specific territory. The territory resource ID must be retrieved from the GET /settings/territories endpoint. This recipient type is not supported in the recipients.to field when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Indicates the associated record for this recipient. Not applicable for territory recipients. |
details | null | Optional | Represents additional details for this recipient. Not applicable for territory recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource Territory resource (name/id) from Zoho CRM Territories API. |
type | string | Required within parent | Represents the recipient type for this territory-based recipient entry. Possible values: territory - Indicates that the recipient is resolved from a sales territory, notifying all users assigned to that territory. One of: territory Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource
Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: territory and subterritory
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a Territory and all its child sub-territories, used when notifying an entire territory hierarchy. The territory identifier can be retrieved from the Territories API. This recipient type is not supported in recipients.to when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record for this recipient. Not applicable for territory_and_subterritory recipients. |
details | null | Optional | Represents additional details for this recipient. Not applicable for territory_and_subterritory recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource Territory resource (name/id) from Zoho CRM Territories API. |
type | string | Required within parent | Represents the recipient type for this entry. Possible values: territory_and_subterritory - Indicates that the recipient is resolved from a Territory and all its child sub-territories. One of: territory_and_subterritory Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource
Create Email Notifications — request body — body email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the writable fields for creating an email notification action in Zoho CRM. The module, name, recipients (with at least one entry in the to array), and template fields are required. Optionally configure from_address, reply_to_address, related_module, bulk_email, and feature_type. Additional keys: not allowed |
bulk_email | boolean | Optional | Indicates whether mass email mode is enabled for this notification. When set to true, CC and BCC recipients are allowed in the recipients object; when omitted or set to false, including CC or BCC recipients returns an AMBIGUITY_DURING_PROCESSING error. When true, role, group, territory, role_and_subordinate, and territory_and_subterritory recipient types cannot be specified in the recipients.to array; use individual users or email addresses instead. This value cannot be changed after creation. Possible values: true - Mass email mode is enabled; CC and BCC recipients are permitted. false - Mass email mode is disabled; CC and BCC recipients are not permitted. Default: false |
feature_type | Model | Optional | Expand Create Email Notifications — request body — body email notifications item feature type Automation feature this email notification belongs to. Defaults to 'workflow' if omitted. All listed values are supported for creation via API. |
from_address | Model | Optional | Expand Create Email Notifications — request body — body email notifications item from address Sender (From) address. Supported types: merge_field, user, organization_email. When bulk_email is false, the From address defaults to notifications@example.com for notifications sent to internal CRM users; from_address must not be specified in this case and doing so returns DEPENDENT_MISMATCH. When bulk_email is true, the configured From address is used instead of notifications@example.com, and the From address is required for mass emails. |
module | Model | Required within parent | Expand List Email Notifications — response body — email notifications item module Primary CRM module whose records trigger this email notification (e.g., Leads, Contacts, Deals). Both api_name and id are required. If they mismatch, returns AMBIGUITY_DURING_PROCESSING. This value cannot be changed after creation. Use GET /settings/modules to discover available modules. |
name | string | Required within parent | Specify the display name of the email notification action. The following special characters are not allowed: ~`#%^&*()+={}[]|;"<>\. Maximum length: 255 |
recipients | Model | Required within parent | Expand Create Email Notifications — request body — body email notifications item recipients Recipients of the email notification. Provide a JSON object with three arrays: to (required, at least one entry), cc (optional), and bcc (optional). CC and BCC are only allowed when bulk_email is true. |
related_module | Model | Optional | Expand Create Email Notifications — request body — body email notifications item related module Related module context for this notification configuration (e.g., Notes as related module for a Leads notification). This value cannot be changed after creation. Pass null when not applicable. |
reply_to_address | Model | Optional | Expand Create Email Notifications — request body — body email notifications item reply to address Reply-to address. Supported types: merge_field, user, organization_email. When all recipients are internal CRM users, reply_to_address must not be specified and doing so returns DEPENDENT_MISMATCH. Required when any recipient resolves to an external email. |
template | Model | Required within parent | Expand List Email Notifications — response body — email notifications item template Email template to be used for this notification action. Both name and id are required. Fetch available templates from the Email Templates API for the configured module. If no template exists yet for that module, create one first via the createEmailTemplate tool and then associate it here. Templates containing Consent or Survey links are not supported for mass emails; do not use a template containing these links when bulk_email is set to true. |
Referenced models: Create Email Notifications — request body — body email notifications item feature type, List Email Notifications — response body — email notifications item module, Create Email Notifications — request body — body email notifications item related module, Create Email Notifications — request body — body email notifications item recipients, List Email Notifications — response body — email notifications item template, Create Email Notifications — request body — body email notifications item from address, Create Email Notifications — request body — body email notifications item reply to address
Create Email Notifications — request body — body email notifications item feature type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Represents the automation feature this email notification is associated with. Possible values: workflow - Standard workflow rules. approval_process - Approval workflows. blueprint - Blueprint automation stages. blueprint_transition - Blueprint automation stages (transition level). blueprint_state - Blueprint automation stages (state level). review_process - Review process actions. orchestration - Orchestration flows. assignment_rules - Lead and record assignment rules. kiosk - Kiosk mode actions. pathfinder - Pathfinder actions. connected_workflows - Connected workflow chains. commandcenter_service - CommandCenter service. cadences - Cadence and sequence actions. One of: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences Maximum length: 255 |
Create Email Notifications — request body — body email notifications item from address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the sender (From) address configuration for an email notification. Supports three types: merge_field, user, and organization_email. from_address is auto-assigned by the API (defaults to notifications@example.com) when all recipients are internal (resolve to CRM users). Providing from_address when all recipients are internal returns DEPENDENT_MISMATCH error. When bulk_email is true, the configured From address is used instead of notifications@example.com, and the From address is required for mass emails. from_address is also required when any recipient resolves to an external email address, such as a merge field that resolves to an email-type field (for example, ${!Module.Email} where ui_type=25). discriminator: {"mapping": {"email": "#/components/schemas/EmailNotificationAddressEmails", "merge_field": "#/components/schemas/EmailNotificationAddressMergeField", "organization_email": "#/components/schemas/EmailNotificationAddressOrganizationEmail", "user": "#/components/schemas/EmailNotificationAddressUser"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / from_address / type: merge field |
$ (anyOf 2) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / from_address / type: user |
$ (anyOf 3) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / from_address / type: organization email |
$ (anyOf 4) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / from_address / type: email |
Referenced models: Create Email Notifications — request body — body / email_notifications / item / from_address / type: email, Create Email Notifications — request body — body / email_notifications / item / from_address / type: merge field, Create Email Notifications — request body — body / email_notifications / item / from_address / type: organization email, Create Email Notifications — request body — body / email_notifications / item / from_address / type: user
Create Email Notifications — request body — body email notifications item recipients
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the recipient configuration for an email notification action, including primary, CC, and BCC recipient lists. The to field is mandatory and requires at least one entry. The cc and bcc fields are optional and are supported only when bulk_email is set to true. The to array can contain a maximum of 100 recipients, while the cc and bcc arrays can contain a maximum of 50 recipients each. A module can have one Multi-Select User Lookup field with up to 10 users; users selected through this lookup count toward the applicable recipient limit. For example, if 10 users are selected through the lookup, up to 90 additional recipients can be specified in the to array. Additional keys: not allowed |
bcc | array | Optional | Represents the BCC recipients of the email notification. Supported only when bulk_email is set to true. Maximum items: 50 |
bcc[] | Model | Each item | Expand Create Email Notifications — request body — body email notifications item recipients cc item |
cc | array | Optional | Represents the CC recipients of the email notification. Supported only when bulk_email is set to true. Maximum items: 50 |
cc[] | Model | Each item | Expand Create Email Notifications — request body — body email notifications item recipients cc item |
to | array | Required within parent | Represents the primary recipients of the email notification. At least one recipient entry is required. Maximum items: 100 Minimum items: 1 |
to[] | Model | Each item | Expand Create Email Notifications — request body — body email notifications item recipients cc item |
Referenced models: Create Email Notifications — request body — body email notifications item recipients cc item
Create Email Notifications — request body — body email notifications item recipients cc item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents a recipient object used in the to, cc, and bcc arrays of an email notification's recipients configuration. Choose the variant based on the intended recipient type: merge_field resolves dynamically from the record (owner, created_by, or lookup email); emails specifies explicit email addresses; user targets a specific CRM user by ID; profile targets all users assigned to a profile; group targets all users in a group; role targets all users with a role; role_and_subordinate targets a role and its reporting hierarchy; territory targets a sales territory; territory_and_subterritory targets a territory and its sub-territory hierarchy. When bulk_email is true, only merge_field, emails, and user types are permitted in the to array — role, group, territory, role_and_subordinate, and territory_and_subterritory types are not allowed. discriminator: {"mapping": {"emails": "#/components/schemas/DirectRecipientEmails", "group": "#/components/schemas/DirectRecipientGroup", "merge_field": "#/components/schemas/DirectRecipientMergeField", "profile": "#/components/schemas/DirectRecipientProfile", "role": "#/components/schemas/DirectRecipientRole", "role_and_subordinate": "#/components/schemas/DirectRecipientRoleAndSubordinate", "territory": "#/components/schemas/DirectRecipientTerritory", "territory_and_subterritory": "#/components/schemas/DirectRecipientTerritoryAndSubterritory", "user": "#/components/schemas/DirectRecipientUser"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: merge field |
$ (anyOf 2) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: emails |
$ (anyOf 3) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / associated_to: team module, None, type: user |
$ (anyOf 4) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / associated_to: team module, None, type: profile |
$ (anyOf 5) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: group |
$ (anyOf 6) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: role |
$ (anyOf 7) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: role and subordinate |
$ (anyOf 8) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: territory |
$ (anyOf 9) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: territory and subterritory |
Referenced models: Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: emails, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: group, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: merge field, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / associated_to: team module, None, type: profile, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: role, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: role and subordinate, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: territory, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / type: territory and subterritory, Create Email Notifications — request body — body / email_notifications / item / recipients / cc / item / associated_to: team module, None, type: user
Create Email Notifications — request body — body email notifications item related module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | Represents the related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed |
api_name | string | Optional | Represents the API name of the related CRM module used in the automation configuration, for example, Notes. Maximum length: 255 |
id | string | Optional | Represents the unique identifier of the related CRM module that corresponds to the api_name value. Maximum length: 255 |
Create Email Notifications — request body — body email notifications item reply to address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the reply-to address configuration for an email notification. Supports three address types: merge_field, user, and organization_email. When all recipients are internal and resolve to CRM users, the reply-to address is auto-assigned and must not be provided; supplying a reply_to_address in this case returns a DEPENDENT_MISMATCH error. When any recipient resolves to an external email address — such as a merge field that resolves to an email-type field where ui_type is 25 — the reply_to_address is required. |
$ (anyOf 1) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / from_address / type: merge field |
$ (anyOf 2) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / from_address / type: user |
$ (anyOf 3) | Model | Alternative | Expand Create Email Notifications — request body — body / email_notifications / item / from_address / type: organization email |
$ (anyOf 4) | null | Alternative | Represents a null address value, indicating that no sender or reply-to address has been configured for the email notification. |
Referenced models: Create Email Notifications — request body — body / email_notifications / item / from_address / type: merge field, Create Email Notifications — request body — body / email_notifications / item / from_address / type: organization email, Create Email Notifications — request body — body / email_notifications / item / from_address / type: user
Create Email Notifications — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when an email notification is successfully created in the Zoho CRM organization. Additional keys: not allowed |
email_notifications | array | Required within parent | Represents the list of email notification objects created in the request. Contains one item representing the successfully created email notification. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Create Email Notifications — response body — email notifications item |
Referenced models: Create Email Notifications — response body — email notifications item
Create Email Notifications — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single success result item returned when an email notification action is created successfully in Zoho CRM. Additional keys: not allowed |
code | string | Required within parent | Represents the result code for the email notification creation operation. Possible values: SUCCESS - The email notification action was created successfully. Known values: SUCCESS |
details | Model | Required within parent | Expand Create Email Notifications — response body — email notifications item details |
message | string | Required within parent | Represents the success message returned after the email notification action is created. Maximum length: 255 |
status | string | Required within parent | Represents the status of the email notification creation operation. Possible values: success - The email notification action was created successfully. Known values: success |
Referenced models: Create Email Notifications — response body — email notifications item details
Create Email Notifications — response body — email notifications item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifier details returned for the created email notification action. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the newly created email notification action. Maximum length: 20 |
Delete Email Notifications — response body — email notifications email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result item returned for a record that was successfully deleted in a bulk delete operation. Additional keys: not allowed |
code | string | Required within parent | Represents the result code for a successfully deleted record in a bulk delete operation. Possible values: SUCCESS - Indicates that the record was deleted successfully. Known values: SUCCESS |
details | Model | Required within parent | Expand Delete an Email Notification by ID — response body — email notifications item details |
message | string | Required within parent | Represents the success message returned when a record is deleted successfully in a bulk delete operation. Maximum length: 255 |
status | string | Required within parent | Represents the operation status of a bulk delete item. Possible values: success - Indicates that the deletion of the record was completed successfully. Known values: success |
Referenced models: Delete an Email Notification by ID — response body — email notifications item details
Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Mixed Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the partial-success response for a bulk delete request, containing a mix of successful and failed deletion results for the requested email notification IDs. Additional keys: not allowed |
email_notifications | array | Required within parent | Represents the per-ID deletion results for the bulk delete request. Maximum items: 10 |
email_notifications[] | JSON | Each item | |
email_notifications[] (anyOf 1) | Model | Alternative | Expand Delete Email Notifications — response body — email notifications email notifications item |
email_notifications[] (anyOf 2) | Model | Alternative | Expand Delete Email Notifications — response body — email_notifications / email_notifications / item / code: INVALID DATA, NOT ALLOWED, status: error |
Referenced models: Delete Email Notifications — response body — email_notifications / email_notifications / item / code: INVALID DATA, NOT ALLOWED, status: error, Delete Email Notifications — response body — email notifications email notifications item
Delete Email Notifications — response body — email notifications — Email Notifications Bulk Delete Success Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when all requested email notification definitions are successfully deleted. Additional keys: not allowed |
email_notifications | array | Required within parent | Represents the list of deletion result entries for each email notification ID included in the request. Maximum items: 3 |
email_notifications[] | Model | Each item | Expand Delete Email Notifications — response body — email notifications email notifications item |
Referenced models: Delete Email Notifications — response body — email notifications email notifications item
Delete Email Notifications — response body — email_notifications / email_notifications / item / code: INVALID DATA, NOT ALLOWED, status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of a failed deletion for a single record ID during a bulk delete operation, including the failure code, status, and error message. Additional keys: not allowed |
code | string | Required within parent | Represents the failure code indicating why the bulk delete operation failed for this record. Possible values: INVALID_DATA - The data provided for the record is invalid. NOT_ALLOWED - The delete operation is not permitted for this record. Known values: INVALID_DATA, NOT_ALLOWED |
details | Model | Required within parent | Expand Delete an Email Notification by ID — response body — email notifications item details |
message | string | Required within parent | Represents the error message describing why the bulk delete operation failed for this record. Maximum length: 255 |
status | string | Required within parent | Represents the status of the bulk delete operation for this record. Possible values: error - Indicates that the delete operation failed for this record. Known values: error |
Referenced models: Delete an Email Notification by ID — response body — email notifications item details
Delete an Email Notification by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned after successfully deleting a single email notification definition. Additional keys: not allowed |
email_notifications | array | Required within parent | Represents the result of the delete operation for the specified email notification. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Delete an Email Notification by ID — response body — email notifications item |
Referenced models: Delete an Email Notification by ID — response body — email notifications item
Delete an Email Notification by ID — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the result of a successful single-record delete operation, including the status, result code, and success message. Additional keys: not allowed |
code | string | Required within parent | Represents the result code for the delete operation. Possible values: SUCCESS - The delete operation completed successfully. Known values: SUCCESS |
details | Model | Required within parent | Expand Delete an Email Notification by ID — response body — email notifications item details |
message | string | Required within parent | Represents the success message returned after the delete operation completes. Maximum length: 255 |
status | string | Required within parent | Represents the status of the delete operation. Possible values: success - The delete operation was completed successfully. Known values: success |
Referenced models: Delete an Email Notification by ID — response body — email notifications item details
Delete an Email Notification by ID — response body — email notifications item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the identifier details for a bulk-delete result item, including the unique ID of the email notification for which the result applies. Additional keys: not allowed |
id | string | Required within parent | Represents the unique ID of the email notification for which this bulk-delete result applies. Maximum length: 20 |
Get an Email Notification by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response object returned when a specific email notification definition is retrieved by its ID, containing the full configuration details of the matched notification. Additional keys: not allowed |
email_notifications | array | Optional | Represents the list of email notification definitions returned for the specified ID. Contains at most one email notification object with the full configuration details, including template, recipient, and sender settings. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Get an Email Notification by ID — response body — email notifications item |
Referenced models: Get an Email Notification by ID — response body — email notifications item
Get an Email Notification by ID — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a complete email notification action definition in Zoho CRM, including its configuration fields, email template, recipient details, sender and reply-to address settings, and server-managed metadata such as creation and modification timestamps. Additional keys: not allowed |
associated | boolean | Optional | Indicates whether this email notification action is currently associated with any automation rule or process. Possible values: true - The action is linked to one or more automation rules or processes. false - The action is not linked to any automation rule or process. |
bulk_email | boolean | Optional | Indicates whether the notification is sent as a single mass email with all recipient addresses visible to each other. Possible values: true - The notification is sent as a bulk email, displaying all recipients together. false - The notification is not sent as a bulk email. |
created_by | Model | Optional | Expand List Email Notifications — response body — email notifications item created by User who created this email notification action. |
created_time | string | Optional | Represents the date and time when this email notification action was created, as generated by the server. Format: date-time Maximum length: 255 |
deletable | boolean | Optional | Indicates whether the current user has permission to delete this email notification action. Possible values: true - The current user can delete this action. false - The current user cannot delete this action. |
editable | boolean | Optional | Indicates whether the current user has permission to edit this email notification action. Possible values: true - The current user can edit this action. false - The current user cannot edit this action. |
feature_type | Model | Optional | Expand List Email Notifications — response body — email notifications item feature type Automation feature where this action is used. |
from_address | Model | Optional | Expand List Email Notifications — response body — email notifications item from address Sender address configuration used to send the notification email. |
id | string | Required within parent | Represents the unique identifier of the email notification action. Unique identifier of the email notification action. Maximum length: 20 |
lock_status | Model | Optional | Expand List Email Notifications — response body — email notifications item lock status Lock state of this action. Locked actions may not be editable or deletable. |
modified_by | Model | Optional | Expand List Email Notifications — response body — email notifications item modified by User who last modified this email notification action. |
modified_time | string | Optional | Represents the date and time when this email notification action was last modified, as generated by the server. Format: date-time Maximum length: 255 |
module | Model | Required within parent | Expand List Email Notifications — response body — email notifications item module Primary CRM module where this notification action is configured. |
name | string | Required within parent | Represents the display name of the email notification action. Maximum length: 255 |
recipient_count | string | Optional | Represents the total number of configured recipients for this email notification action. Maximum length: 255 |
recipients | Model | Optional | Expand List Email Notifications — response body — email notifications item recipients Recipient configuration containing to, cc, and bcc collections. |
related_module | Model | Optional | Expand List Email Notifications — response body — email notifications item related module Related module context for this notification configuration; null when not applicable. |
reply_to_address | Model | Optional | Expand List Email Notifications — response body — email notifications item reply to address Reply-to address configuration for recipient replies. |
source | string | Optional | Represents the source application that created or manages this email notification action, for example, crm. Maximum length: 255 |
template | Model | Required within parent | Expand List Email Notifications — response body — email notifications item template Email template used by this notification action. |
Referenced models: List Email Notifications — response body — email notifications item created by, List Email Notifications — response body — email notifications item lock status, List Email Notifications — response body — email notifications item modified by, List Email Notifications — response body — email notifications item module, List Email Notifications — response body — email notifications item template, List Email Notifications — response body — email notifications item feature type, List Email Notifications — response body — email notifications item related module, List Email Notifications — response body — email notifications item recipients, List Email Notifications — response body — email notifications item from address, List Email Notifications — response body — email notifications item reply to address
List Email Notifications — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the successful retrieval response for a page of email notification definitions, including pagination information. Additional keys: not allowed |
email_notifications | array | Optional | Represents the list of email notification definitions returned for the current page. Maximum items: 200 |
email_notifications[] | Model | Each item | Expand List Email Notifications — response body — email notifications item |
info | Model | Optional | Expand List Email Notifications — response body — info |
Referenced models: List Email Notifications — response body — email notifications item, List Email Notifications — response body — info
List Email Notifications — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a summary of an email notification action, including its template, sender and reply-to configuration, recipient collections, primary module context, audit metadata, and association status. Additional keys: not allowed |
associated | boolean | Optional | Indicates whether this notification action is currently associated with an automation rule or process. Possible values: true - The notification action is linked to one or more active automation rules or processes. false - The notification action is not linked to any automation rule or process. |
bulk_email | boolean | Optional | Indicates whether the notification is sent as a single mass email. Possible values: true - The notification is sent as a mass email, and CC and BCC recipients are allowed. false - The notification is sent as individual emails, and CC and BCC recipients are not included. |
created_by | Model | Optional | Expand List Email Notifications — response body — email notifications item created by User who created this notification action. |
created_time | string | Optional | Represents the date and time when this notification action was created. Format: date-time Maximum length: 255 |
deletable | boolean | Optional | Indicates whether the current user can delete this notification action. Possible values: true - The current user has permission to delete this notification action. false - The current user does not have permission to delete this notification action. |
editable | boolean | Optional | Indicates whether the current user can edit this notification action. Possible values: true - The current user has permission to edit this notification action. false - The current user does not have permission to edit this notification action. |
feature_type | Model | Optional | Expand List Email Notifications — response body — email notifications item feature type Automation feature where this action is used. |
from_address | Model | Optional | Expand List Email Notifications — response body — email notifications item from address Sender configuration used to send the notification email. |
id | string | Optional | Represents the unique identifier of the email notification action. Maximum length: 20 |
lock_status | Model | Optional | Expand List Email Notifications — response body — email notifications item lock status Indicates whether this notification action is locked for edit/delete. |
modified_by | Model | Optional | Expand List Email Notifications — response body — email notifications item modified by User who last modified this notification action. |
modified_time | string | Optional | Represents the date and time when this notification action was last modified. Format: date-time Maximum length: 255 |
module | Model | Required within parent | Expand List Email Notifications — response body — email notifications item module Primary module on which this notification action is configured. |
name | string | Required within parent | Represents the display name of the email notification action. The special characters ~`#%^&*()+={}[]|;"<>\ are not allowed. Maximum length: 255 Pattern: ^[^~`#%^&*()+={}\[\]|;"<>\\]+$ |
recipient_count | string | Optional | Represents the total number of recipients configured for this email notification action. Maximum length: 255 |
recipients | Model | Optional | Expand List Email Notifications — response body — email notifications item recipients Recipient configuration containing to/cc/bcc collections for this notification action. |
related_module | Model | Optional | Expand List Email Notifications — response body — email notifications item related module Related module context when the automation is configured on related records; null when not applicable. |
reply_to_address | Model | Optional | Expand List Email Notifications — response body — email notifications item reply to address Reply-to configuration used when recipients reply to the notification email. |
source | string | Optional | Represents the source application from which this notification action is configured, for example, crm. Maximum length: 255 |
template | Model | Required within parent | Expand List Email Notifications — response body — email notifications item template Email template used by this notification (template id and name). |
Referenced models: List Email Notifications — response body — email notifications item created by, List Email Notifications — response body — email notifications item lock status, List Email Notifications — response body — email notifications item modified by, List Email Notifications — response body — email notifications item module, List Email Notifications — response body — email notifications item template, List Email Notifications — response body — email notifications item feature type, List Email Notifications — response body — email notifications item related module, List Email Notifications — response body — email notifications item recipients, List Email Notifications — response body — email notifications item from address, List Email Notifications — response body — email notifications item reply to address
List Email Notifications — response body — email notifications item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the creator of a resource, including their name and unique identifier. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the user who created the resource. Maximum length: 255 |
name | string | Optional | Represents the name of the user who created the resource. Maximum length: 255 |
List Email Notifications — response body — email notifications item feature type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Represents the automation feature this email notification is associated with. Possible values: workflow - Standard workflow rules. approval_process - Approval workflows. blueprint - Blueprint automation stages. blueprint_transition - Blueprint automation stages (transition level). blueprint_state - Blueprint automation stages (state level). review_process - Review process actions. orchestration - Orchestration flows. assignment_rules - Lead and record assignment rules. kiosk - Kiosk mode actions. pathfinder - Pathfinder actions. connected_workflows - Connected workflow chains. commandcenter_service - CommandCenter service. cadences - Cadence and sequence actions. Known values: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosk, pathfinder, connected_workflows, commandcenter_service, cadences Maximum length: 255 |
List Email Notifications — response body — email notifications item from address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the sender (From) address configuration for an email notification. Supports three types: merge_field, user, and organization_email. from_address is auto-assigned by the API (defaults to notifications@example.com) when all recipients are internal (resolve to CRM users). Providing from_address when all recipients are internal returns DEPENDENT_MISMATCH error. When bulk_email is true, the configured From address is used instead of notifications@example.com, and the From address is required for mass emails. from_address is also required when any recipient resolves to an external email address, such as a merge field that resolves to an email-type field (for example, ${!Module.Email} where ui_type=25). discriminator: {"mapping": {"email": "#/components/schemas/EmailNotificationAddressEmails", "merge_field": "#/components/schemas/EmailNotificationAddressMergeField", "organization_email": "#/components/schemas/EmailNotificationAddressOrganizationEmail", "user": "#/components/schemas/EmailNotificationAddressUser"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / from_address / type: merge field |
$ (anyOf 2) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / from_address / type: user |
$ (anyOf 3) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / from_address / type: organization email |
$ (anyOf 4) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / from_address / type: email |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: email, List Email Notifications — response body — email_notifications / item / from_address / type: merge field, List Email Notifications — response body — email_notifications / item / from_address / type: organization email, List Email Notifications — response body — email_notifications / item / from_address / type: user
List Email Notifications — response body — email notifications item lock status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Indicates whether a particular component is locked, affecting its editability and usability. Additional keys: not allowed |
locked | boolean | Optional | Indicates whether the component is locked. Possible values: true - The component is locked and cannot be edited or used. false - The component is not locked and remains editable and usable. |
List Email Notifications — response body — email notifications item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the last person who modified a resource, including their name and unique identifier. Additional keys: not allowed |
id | string | Optional | Represents the unique identifier of the user who last modified the resource. Maximum length: 255 |
name | string | Optional | Represents the full name of the user who last modified the resource. Maximum length: 255 |
List Email Notifications — response body — email notifications item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the CRM module associated with an email notification definition. Both api_name and id are required and must refer to the same module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the CRM module whose records trigger the email notification. For example, Leads, Contacts, or Deals. Both api_name and id must refer to the same module. Maximum length: 255 |
id | string | Required within parent | Represents the unique numeric identifier of the CRM module. Both id and api_name must refer to the same module. Maximum length: 255 |
List Email Notifications — response body — email notifications item recipients
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the recipient configuration for an email notification action, including primary, CC, and BCC recipient lists. The to field is mandatory and requires at least one entry. The cc and bcc fields are optional and are supported only when bulk_email is set to true. The to array can contain a maximum of 100 recipients, while the cc and bcc arrays can contain a maximum of 50 recipients each. A module can have one Multi-Select User Lookup field with up to 10 users; users selected through this lookup count toward the applicable recipient limit. For example, if 10 users are selected through the lookup, up to 90 additional recipients can be specified in the to array. Additional keys: not allowed |
bcc | array | Optional | Represents the BCC recipients of the email notification. Supported only when bulk_email is set to true. Maximum items: 50 |
bcc[] | Model | Each item | Expand List Email Notifications — response body — email notifications item recipients cc item |
cc | array | Optional | Represents the CC recipients of the email notification. Supported only when bulk_email is set to true. Maximum items: 50 |
cc[] | Model | Each item | Expand List Email Notifications — response body — email notifications item recipients cc item |
to | array | Required within parent | Represents the primary recipients of the email notification. At least one recipient entry is required. Maximum items: 100 Minimum items: 1 |
to[] | Model | Each item | Expand List Email Notifications — response body — email notifications item recipients cc item |
Referenced models: List Email Notifications — response body — email notifications item recipients cc item
List Email Notifications — response body — email notifications item recipients cc item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents a recipient object used in the to, cc, and bcc arrays of an email notification's recipients configuration. Choose the variant based on the intended recipient type: merge_field resolves dynamically from the record (owner, created_by, or lookup email); emails specifies explicit email addresses; user targets a specific CRM user by ID; profile targets all users assigned to a profile; group targets all users in a group; role targets all users with a role; role_and_subordinate targets a role and its reporting hierarchy; territory targets a sales territory; territory_and_subterritory targets a territory and its sub-territory hierarchy. When bulk_email is true, only merge_field, emails, and user types are permitted in the to array — role, group, territory, role_and_subordinate, and territory_and_subterritory types are not allowed. discriminator: {"mapping": {"emails": "#/components/schemas/DirectRecipientEmails", "group": "#/components/schemas/DirectRecipientGroup", "merge_field": "#/components/schemas/DirectRecipientMergeField", "profile": "#/components/schemas/DirectRecipientProfile", "role": "#/components/schemas/DirectRecipientRole", "role_and_subordinate": "#/components/schemas/DirectRecipientRoleAndSubordinate", "territory": "#/components/schemas/DirectRecipientTerritory", "territory_and_subterritory": "#/components/schemas/DirectRecipientTerritoryAndSubterritory", "user": "#/components/schemas/DirectRecipientUser"}, "propertyName": "type"} |
$ (anyOf 1) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field |
$ (anyOf 2) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails |
$ (anyOf 3) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: user |
$ (anyOf 4) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile |
$ (anyOf 5) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group |
$ (anyOf 6) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role |
$ (anyOf 7) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role and subordinate |
$ (anyOf 8) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory |
$ (anyOf 9) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory and subterritory |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role and subordinate, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory and subterritory, List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: user
List Email Notifications — response body — email notifications item related module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed |
$ (anyOf 1).api_name | string | Optional | Represents the API name of the related CRM module used in the automation configuration, for example, Notes. Maximum length: 255 |
$ (anyOf 1).id | string | Optional | Represents the unique identifier of the related CRM module that corresponds to the api_name value. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | Represents the related module metadata for automation contexts that operate on related records. Null when no related module context applies. Additional keys: not allowed |
$ (anyOf 2).api_name | string | Optional | Represents the API name of the related CRM module used in the automation configuration, for example, Notes. Maximum length: 255 |
$ (anyOf 2).id | string | Optional | Represents the unique identifier of the related CRM module that corresponds to the api_name value. Maximum length: 255 |
List Email Notifications — response body — email notifications item reply to address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the reply-to address configuration for an email notification. Supports three address types: merge_field, user, and organization_email. When all recipients are internal and resolve to CRM users, the reply-to address is auto-assigned and must not be provided; supplying a reply_to_address in this case returns a DEPENDENT_MISMATCH error. When any recipient resolves to an external email address — such as a merge field that resolves to an email-type field where ui_type is 25 — the reply_to_address is required. |
$ (anyOf 1) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / from_address / type: merge field |
$ (anyOf 2) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / from_address / type: user |
$ (anyOf 3) | Model | Alternative | Expand List Email Notifications — response body — email_notifications / item / from_address / type: organization email |
$ (anyOf 4) | null | Alternative | Represents a null address value, indicating that no sender or reply-to address has been configured for the email notification. |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: merge field, List Email Notifications — response body — email_notifications / item / from_address / type: organization email, List Email Notifications — response body — email_notifications / item / from_address / type: user
List Email Notifications — response body — email notifications item template
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an email template reference used in an email notification definition. The template must belong to the same module as the notification, and both the id and name fields are required. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the email template. Maximum length: 255 |
name | string | Required within parent | Represents the name of the email template associated with the email notification. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / from_address / type: email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the sender address configuration for an email notification, used when the server assigns the address automatically or when the address resolves to a plain email address. Additional keys: not allowed |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: email details |
resource | null | Optional | Represents the resource reference for the sender address. This field is not applicable when the address type is email. |
type | string | Required within parent | Represents the type of sender address for the notification. Possible values: email - The sender address resolves to a plain email address. Known values: email Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: email details
List Email Notifications — response body — email_notifications / item / from_address / type: email details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the email details for the sender address associated with the notification. Additional keys: not allowed |
email | JSON | Required within parent | Represents the sender email address in the local@domain format. |
email (allOf 1) | string | All variants apply | Represents an email address in local@domain format, used for direct recipient and sender configurations. Format: email Maximum length: 255 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
List Email Notifications — response body — email_notifications / item / from_address / type: merge field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the address configuration for a merge_field type from or reply-to address in an email notification. Two hardcoded values are always available: ${!Current.User.Email} (the logged-in user's email) and ${!Record.Owner.Email} (the record owner's email). Any user lookup field available in the module can also be used as a from or reply-to address, for example, ${!Deals.Contact_Name.Email}. Use module and field metadata APIs to discover available user lookup fields. Additional keys: not allowed |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: merge field details |
resource | null | Optional | Represents the resource field, which is not applicable for merge_field address types and must be set to null. |
type | string | Required within parent | Represents the address type for this configuration. Possible values: merge_field - Indicates the address is resolved dynamically from a CRM module field or user lookup field. Known values: merge_field Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: merge field details
List Email Notifications — response body — email_notifications / item / from_address / type: merge field details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the merge field details used to resolve the sender or reply-to address. The api_name property is required for merge_field address types. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the merge field used to resolve the sender or reply-to address. Supported reference formats include ${!{module_API_name}.{field_API_name}} for direct fields and ${!{module_API_name}.{lookup_APIname}.{field_API_name}} for lookup fields. Maximum length: 100 |
id | string | Optional | Represents the optional identifier for the merge field. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / from_address / type: organization email
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the address configuration for an organization email sender in an email notification. The resource.id must be an organization email ID retrieved from Zoho CRM Organization APIs. Additional keys: not allowed |
details | null | Optional | Represents additional details for the address configuration. This field is not applicable when the type is organization_email. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: organization email resource Organization email resource. Use resource.id from Zoho CRM Organization APIs. |
type | string | Required within parent | Represents the address type for the email notification sender configuration. Possible values: organization_email - Indicates that the sender address is an organization email registered in the Zoho CRM organization. Known values: organization_email Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: organization email resource
List Email Notifications — response body — email_notifications / item / from_address / type: organization email resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an organization email reference identified by its numeric ID. The name field is informational only and is not used to resolve the record. Additional keys: not allowed |
id | string | Required within parent | Represents the unique numeric identifier of the organization email. Refer to the [Organization Email](organization_emails.yaml#$.paths./settings/emails/org_emails.post) endpoint for details. Maximum length: 255 |
name | string | Optional | Represents the display name of the organization email. This field is informational only and is not used by the API to resolve the record. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / from_address / type: user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the address configuration for a Zoho CRM user recipient in an email notification. The resource.id must be a valid CRM user ID from the Zoho CRM Users APIs. Additional keys: not allowed |
details | null | Optional | Represents additional address details. This field is not applicable when the type is set to `user` and should be omitted or set to null. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: user resource User resource. Use resource.id from Zoho CRM Users APIs. |
type | string | Required within parent | Represents the address type for the email notification recipient configuration. Possible values: user - Indicates that the recipient address is resolved from a Zoho CRM user. Known values: user Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: user resource
List Email Notifications — response body — email_notifications / item / from_address / type: user resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a user identifier object used to resolve a CRM user by their numeric identifier. The name field is informational only and is not used to resolve the user record. Additional keys: not allowed |
id | string | Required within parent | Represents the unique numeric identifier of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details. Maximum length: 255 |
name | string | Optional | Represents the display name of the user. This value is informational only; the API uses the id field to resolve the user record. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient configuration that uses explicit email addresses to specify notification targets. Provide one or more addresses in the details.emails array. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated resource for this recipient type. Not applicable for direct email address recipients. |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails details |
resource | null | Optional | Represents the resource reference for this recipient type. Not applicable for direct email address recipients. |
type | string | Required within parent | Represents the recipient type for this configuration. Possible values: emails - Indicates that recipients are specified using explicit email addresses. Known values: emails Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails details
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: emails details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the details object containing the email addresses for this recipient. Additional keys: not allowed |
emails | array | Required within parent | Represents the list of explicit email addresses to notify for this recipient. Maximum items: 10 Minimum items: 1 |
emails[] | string | Each item | Represents an email address in local@domain format, used for direct recipient and sender configurations. Format: email Maximum length: 255 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$ |
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a CRM user group, used when all members of a group should receive an email notification. Group IDs can be retrieved from the GET /settings/groups endpoint. Not supported in the recipients.to field when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record for this recipient. Not applicable for group recipients. |
details | null | Optional | Represents additional recipient details. Not applicable for group recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group resource Group resource (name/id) from Zoho CRM Groups API. |
type | string | Required within parent | Represents the recipient type for this group recipient. Possible values: group - Indicates that the recipient is resolved from a CRM user group. Known values: group Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group resource
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: group resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a user group reference identified by its numeric ID. The name field is informational only and is not used to resolve the group. Additional keys: not allowed |
id | string | Required within parent | Represents the unique numeric identifier of the group. Refer to the [Get user groups](user_groups.yaml#$.paths./settings/user_groups.get) endpoint for details. Maximum length: 255 |
name | string | Optional | Represents the display name of the group. This field is informational only and is not used to resolve the record. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved dynamically from a merge field, where the recipient address depends on the triggering record and is resolved at runtime. Merge field recipients fall into two categories: INTERNAL — fields resolving to CRM users, such as ${!Module.Owner} or ${!Module.Created_By}, for which from_address must not be provided and defaults to the first registered email address; and EXTERNAL — fields resolving to email-type fields (ui_type=25), such as ${!Module.Email} or ${!Module.Lookup.Email}, for which from_address is required. Use module and field metadata APIs to retrieve valid field API names. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated entity for the recipient. Not applicable for merge_field recipients; this field is always null. |
details | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field details |
resource | null | Optional | Represents the resource associated with the recipient. Not applicable for merge_field recipients; this field is always null. |
type | string | Required within parent | Represents the recipient type for this entry. Possible values: merge_field - Indicates that the recipient address is resolved dynamically from a record field at runtime. Known values: merge_field Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field details
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: merge field details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the merge-field details used to resolve the recipient address at runtime, including the field API name and an optional identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the merge field used to resolve the recipient address. Sample references: ${!{module_API_name}.{field_API_name}} for direct fields, or ${!{module_API_name}.{lookup_APIname}.{field_API_name}} for lookup fields. Maximum length: 100 |
id | string | Optional | Represents the identifier of the merge field used to resolve the recipient. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a notification recipient resolved by a CRM profile, used to notify all users sharing a specific profile or permission level. Refer to the GET /settings/profiles endpoint to retrieve valid profile IDs. For private (team) modules, set the `associated_to` field to `team_module`. Additional keys: not allowed |
associated_to | JSON | Optional | |
associated_to (anyOf 1) | string | Alternative | Indicates whether the notification module is a private (team) module. Set to `team_module` when the notification targets a private module. Leave null for standard modules. Possible values: team_module - The notification module is a private (team) module. Known values: team_module Maximum length: 255 |
associated_to (anyOf 2) | null | Alternative | Indicates whether the notification module is a private (team) module. Set to `team_module` when the notification targets a private module. Leave null for standard modules. Possible values: team_module - The notification module is a private (team) module. Known values: team_module Maximum length: 255 |
details | null | Optional | Represents additional recipient details. This field is not applicable for profile recipients and is always null. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile resource Profile resource (name/id) from Zoho CRM Profiles API. |
type | string | Required within parent | Represents the recipient type for this notification recipient definition. Possible values: profile - The recipient is resolved by a CRM profile, notifying all users who share that profile. Known values: profile Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile resource
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: profile resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a profile reference resolved by its unique numeric identifier. The name field is included for display purposes only and is not used by the API to resolve the record. Additional keys: not allowed |
id | string | Required within parent | Represents the unique numeric identifier of the profile. Refer to the [Profiles](profiles.yaml#$.paths./settings/profiles.get) endpoint for details. Format: int64 Maximum length: 255 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |
name | string | Optional | Represents the display name of the profile. This value is informational only and is not used by the API to resolve the record. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved by a CRM role, used to notify all users assigned to a specific role. The role identifier must be retrieved from the GET /settings/roles endpoint. This recipient type is not supported in the recipients.to field when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record context for the recipient. Not applicable for role recipients. |
details | null | Optional | Represents additional details about the recipient. Not applicable for role recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource Role resource (name/id) from Zoho CRM Roles API. |
type | string | Required within parent | Represents the recipient type for this role-based recipient entry. Possible values: role - Identifies the recipient as resolved by a CRM role, sending notifications to all users assigned to that role. Known values: role Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role and subordinate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a role and all subordinate roles below it in the hierarchy, used when a notification must reach a manager and everyone reporting under that role. The role ID must be retrieved from the GET /settings/roles endpoint. This recipient type is not supported in recipients.to when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record for this recipient. Not applicable for role_and_subordinate recipients. |
details | null | Optional | Represents additional details for the recipient. Not applicable for role_and_subordinate recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource Role resource (name/id) from Zoho CRM Roles API. |
type | string | Required within parent | Represents the recipient type for this notification target. Possible values: role_and_subordinate - Resolves the recipient from a role and all subordinate roles below it in the hierarchy. Known values: role_and_subordinate Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: role resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a role reference used to identify the role by its numeric identifier. The name field is included for display purposes only and is not used to resolve the record. Additional keys: not allowed |
id | string | Required within parent | Represents the unique numeric identifier of the role. Refer to the [Get all roles](roles.yaml#$.paths./settings/roles.get) endpoint for details. Maximum length: 255 |
name | string | Optional | Represents the display name of the role. This field is informational only and is not used to resolve the record. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a sales territory in Zoho CRM, used to notify all users assigned to a specific territory. The territory resource ID must be retrieved from the GET /settings/territories endpoint. This recipient type is not supported in the recipients.to field when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Indicates the associated record for this recipient. Not applicable for territory recipients. |
details | null | Optional | Represents additional details for this recipient. Not applicable for territory recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource Territory resource (name/id) from Zoho CRM Territories API. |
type | string | Required within parent | Represents the recipient type for this territory-based recipient entry. Possible values: territory - Indicates that the recipient is resolved from a sales territory, notifying all users assigned to that territory. Known values: territory Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory and subterritory
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a Territory and all its child sub-territories, used when notifying an entire territory hierarchy. The territory identifier can be retrieved from the Territories API. This recipient type is not supported in recipients.to when bulk_email is true. Additional keys: not allowed |
associated_to | null | Optional | Represents the associated record for this recipient. Not applicable for territory_and_subterritory recipients. |
details | null | Optional | Represents additional details for this recipient. Not applicable for territory_and_subterritory recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource Territory resource (name/id) from Zoho CRM Territories API. |
type | string | Required within parent | Represents the recipient type for this entry. Possible values: territory_and_subterritory - Indicates that the recipient is resolved from a Territory and all its child sub-territories. Known values: territory_and_subterritory Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: territory resource
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a Territory reference used to identify a territory by its numeric ID. The name field is informational only and is not used to resolve the Territory record. Additional keys: not allowed |
id | string | Required within parent | Represents the unique numeric identifier of the Territory. Refer to the [Get all territories](territories.yaml#$.paths./settings/territories.get) endpoint for details. Format: int64 Maximum length: 255 |
name | string | Optional | Represents the display name of the Territory. This value is informational only; the API uses the id field to resolve the Territory record. Maximum length: 255 |
List Email Notifications — response body — email_notifications / item / recipients / cc / item / type: user
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a recipient resolved from a specific CRM user, used when the notification must be sent to a named individual. Retrieve the user ID from the Get Users endpoint. For private modules, set the `associated_to` field to `team_module` to include team-scoped users. Additional keys: not allowed |
associated_to | JSON | Optional | |
associated_to (anyOf 1) | string | Alternative | Indicates the scope context for recipient resolution. Set to `team_module` when the notification module is a private module where record visibility is restricted to team members. When set, only team-scoped users and profiles are included. Leave null for standard modules. Possible values: team_module - The notification module is a private (team) module; only team-scoped users and profiles are included as recipients. null - The notification module is a standard module; all applicable users and profiles are included. Known values: team_module Maximum length: 255 |
associated_to (anyOf 2) | null | Alternative | Indicates the scope context for recipient resolution. Set to `team_module` when the notification module is a private module where record visibility is restricted to team members. When set, only team-scoped users and profiles are included. Leave null for standard modules. Possible values: team_module - The notification module is a private (team) module; only team-scoped users and profiles are included as recipients. null - The notification module is a standard module; all applicable users and profiles are included. Known values: team_module Maximum length: 255 |
details | null | Optional | Represents additional details for the recipient. Not applicable for user recipients. |
resource | Model | Required within parent | Expand List Email Notifications — response body — email_notifications / item / from_address / type: user resource User resource (name/id) from Zoho CRM Users API. |
type | string | Required within parent | Represents the recipient type for the notification target. For direct user recipients, this value is always `user`. Possible values: user - The recipient is a specific CRM user identified by their user ID. Known values: user Maximum length: 255 |
Referenced models: List Email Notifications — response body — email_notifications / item / from_address / type: user resource
List Email Notifications — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the pagination state for a collection response, including the current page number, the number of records per page, the total records returned, and whether additional records are available. Additional keys: not allowed |
count | JSON | Optional | |
count (anyOf 1) | integer | Alternative | Represents the number of records returned in the current response page. Format: int32 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_limit | JSON | Optional | |
max_limit (anyOf 1) | integer | Alternative | Represents the maximum number of records that can be returned per page for this collection. Format: int32 |
max_limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Optional | Indicates whether additional records are available beyond the current page. Possible values: true - More records exist beyond the current page. false - No additional records exist beyond the current page. |
page | JSON | Optional | |
page (anyOf 1) | integer | Alternative | Represents the current page number in the paginated result set, reflecting the requested page value. Format: int32 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
per_page | JSON | Optional | |
per_page (anyOf 1) | integer | Alternative | Represents the number of records requested per page. Format: int32 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update an Email Notification by ID — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request body wrapper for updating an email notification action. The body must contain an email_notifications array with exactly one object. Additional keys: not allowed |
email_notifications | array | Required within parent | Specify the email notification object to update. The array must contain exactly one object with the fields to modify. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Update an Email Notification by ID — request body — body email notifications item |
Referenced models: Update an Email Notification by ID — request body — body email notifications item
Update an Email Notification by ID — request body — body email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the writable fields for updating an email notification action in Zoho CRM. This is a partial-update schema — any key omitted from the payload retains its current stored value. Only the name, template, recipients, from_address, and reply_to_address fields can be modified. The module, related_module, bulk_email, and feature_type fields are immutable after creation. Additional keys: not allowed |
from_address | Model | Optional | Expand Create Email Notifications — request body — body email notifications item from address Sender (From) address. Supported types: merge_field, user, organization_email. When bulk_email is false, the From address defaults to notifications@example.com for notifications sent to internal CRM users; from_address must not be specified in this case and doing so returns DEPENDENT_MISMATCH. When bulk_email is true, the configured From address is used instead of notifications@example.com, and the From address is required for mass emails. |
name | string | Required within parent | Specify the display name of the email notification action. Special characters ~`#%^&*()+={}[]|;"<>\ are not allowed. Maximum length: 255 |
recipients | Model | Required within parent | Expand Create Email Notifications — request body — body email notifications item recipients Recipients of the email notification. Provide a JSON object with three arrays: to (required, at least one entry), cc (optional), and bcc (optional). CC and BCC are only allowed when bulk_email is true (set during creation). |
reply_to_address | Model | Optional | Expand Create Email Notifications — request body — body email notifications item reply to address Reply-to address. Supported types: merge_field, user, organization_email. When all recipients are internal CRM users, reply_to_address must not be specified and doing so returns DEPENDENT_MISMATCH. Required when any recipient resolves to an external email. |
template | Model | Required within parent | Expand List Email Notifications — response body — email notifications item template Email template to be used for this notification action. Both name and id are required. Fetch available templates from the Email Templates API. If no template exists yet for that module, create one first via the createEmailTemplate tool and then associate it here. |
Referenced models: Create Email Notifications — request body — body email notifications item recipients, List Email Notifications — response body — email notifications item template, Create Email Notifications — request body — body email notifications item from address, Create Email Notifications — request body — body email notifications item reply to address
Update an Email Notification by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the successful response returned after updating an email notification definition in Zoho CRM. Contains the updated email notification details in the email_notifications array. Additional keys: not allowed |
email_notifications | array | Optional | Represents the list of updated email notification definitions. Contains one object with the details of the email notification that was updated. Maximum items: 1 |
email_notifications[] | Model | Each item | Expand Update an Email Notification by ID — response body — email notifications item |
Referenced models: Update an Email Notification by ID — response body — email notifications item
Update an Email Notification by ID — response body — email notifications item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response returned when a new email notification is created successfully, including the status code, status, and outcome message. Additional keys: not allowed |
code | string | Optional | Represents the status code returned after the email notification is created successfully. Maximum length: 255 |
details | Model | Optional | Expand Update an Email Notification by ID — response body — email notifications item details |
message | string | Optional | Represents the message describing the outcome of the email notification creation request. Maximum length: 255 |
status | string | Optional | Represents the status of the email notification creation operation, indicating whether the request was successful. Maximum length: 255 |
Referenced models: Update an Email Notification by ID — response body — email notifications item details
Update an Email Notification by ID — response body — email notifications item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the details of a recipient or sender entry in an email notification definition, including the email address, merge field API name, and merge field identifier. Additional keys: not allowed |
$ (anyOf 1).api_name | string | Optional | Represents the API name of the merge field used to resolve the email address dynamically. For example: ${!Deals.Contact_Name.Email}. Applicable only when the type is merge_field. Maximum length: 100 |
$ (anyOf 1).email | string | Optional | Represents the email address associated with the recipient or sender in the notification definition. Maximum length: 255 |
$ (anyOf 1).id | string | Optional | Represents the unique identifier of the merge field. Applicable only when the type is merge_field. Maximum length: 255 |