Zoho: Email drafts schemas
13 Zoho schemas with complete fields and constraints.
← Email drafts operations · All schemas
Create Email Drafts for a Record — response body — __email_drafts / __email_drafts / item / code: SUCCESS, status: success
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Per-item success result. Additional keys: not allowed |
code | string | Required within parent | Operation result code. Known values: SUCCESS |
details | object | Required within parent | Details for successful draft operation. Additional keys: not allowed |
details.id | string | Required within parent | Updated or created draft identifier. Maximum length: 64 |
message | string | Required within parent | Human-readable result message. Maximum length: 512 |
status | string | Required within parent | Per-item outcome status. Known values: success |
Create Email Drafts for a Record — response body — __email_drafts / __email_drafts / item / status: error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Per-item validation or processing error result. Additional keys: not allowed |
code | string | Required within parent | Operation error code. **Possible values:** - **MANDATORY_NOT_FOUND** - A required field is missing. - **INVALID_DATA** - The field contains invalid data. - **NOT_ALLOWED** - The field is not allowed in this operation. - **DUPLICATE_DATA** - A duplicate value was found (e.g. a duplicate attachment). - **EXPECTED_FIELD_MISSING** - At least one of a set of expected fields must be specified. - **AMBIGUITY_DURING_PROCESSING** - The given field values are ambiguous or conflicting. - **NOT_SUPPORTED** - The given field or value is not supported for this module. - **DEPENDENT_MISMATCH** - A field value does not match its dependent field. Known values: MANDATORY_NOT_FOUND, INVALID_DATA, NOT_ALLOWED, DUPLICATE_DATA, EXPECTED_FIELD_MISSING, AMBIGUITY_DURING_PROCESSING, NOT_SUPPORTED, DEPENDENT_MISMATCH Maximum length: 128 |
details | object | Required within parent | Details for failed draft operation. Additional keys: allowed |
details.api_name | string | Optional | Field or API name that caused the error. Maximum length: 128 |
details.json_path | string | Optional | JSON path for the invalid or missing field. Maximum length: 256 |
message | string | Required within parent | Human-readable error message. Maximum length: 512 |
status | string | Required within parent | Per-item outcome status. Known values: error |
Create Email Drafts for a Record — response body — email drafts
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing per-draft status for mixed batch processing results. Additional keys: not allowed |
__email_drafts | array | Required within parent | Per-draft status results for the submitted batch. Maximum items: 100 |
__email_drafts[] | JSON | Each item | |
__email_drafts[] (anyOf 1) | Model | Alternative | Expand Create Email Drafts for a Record — response body — __email_drafts / __email_drafts / item / code: SUCCESS, status: success |
__email_drafts[] (anyOf 2) | Model | Alternative | Expand Create Email Drafts for a Record — response body — __email_drafts / __email_drafts / item / status: error |
Referenced models: Create Email Drafts for a Record — response body — __email_drafts / __email_drafts / item / code: SUCCESS, status: success, Create Email Drafts for a Record — response body — __email_drafts / __email_drafts / item / status: error
List Email Drafts for a Record — response body — __email_drafts, info / __email_drafts / item / inventory_details / paper_type: A4, US Letter, view type: portrait, landscape — shared_inventory-details_496ad47505d2
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Inventory email details; null if not an inventory draft. Additional keys: not allowed |
inventory_template | object | Required within parent | Inventory template details. Additional keys: not allowed |
inventory_template.id | string | Required within parent | Inventory template identifier. Maximum length: 64 |
inventory_template.name | string | Required within parent | Inventory template name. Maximum length: 256 |
paper_type | string | Required within parent | Paper type for rendered inventory. Known values: A4, USLetter |
record | object | Optional | CRM record associated with this inventory draft. Additional keys: not allowed |
record.id | string | Required within parent | CRM record identifier. Maximum length: 64 |
record.name | string | Required within parent | CRM record display name. Maximum length: 256 |
view_type | string | Required within parent | Layout/view type for the inventory. Known values: portrait, landscape |
List Email Drafts for a Record — response body — __email_drafts, info / __email_drafts / item / inventory_details / paper_type: A4, US Letter, view type: portrait, landscape — shared_inventory-details_d1fe827e5270
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | Inventory email details; null if not an inventory draft. Additional keys: not allowed |
inventory_template | object | Required within parent | Inventory template details. Additional keys: not allowed |
inventory_template.id | string | Required within parent | Inventory template identifier. Maximum length: 64 |
inventory_template.name | string | Required within parent | Inventory template name. Maximum length: 256 |
paper_type | string | Required within parent | Paper type for rendered inventory. Known values: A4, USLetter |
record | object | Optional | CRM record associated with this inventory draft. Additional keys: not allowed |
record.id | string | Required within parent | CRM record identifier. Maximum length: 64 |
record.name | string | Required within parent | CRM record display name. Maximum length: 256 |
view_type | string | Required within parent | Layout/view type for the inventory. Known values: portrait, landscape |
List Email Drafts for a Record — response body — email drafts, info email drafts item attachments Attachments included with the draft; null if none item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Attachment metadata. Additional keys: not allowed |
file_name | string | Required within parent | Original file name. Maximum length: 512 |
file_size | string | Required within parent | File size in bytes as a numeric string. Maximum length: 20 |
id | string | Required within parent | Encrypted attachment/file identifier. Maximum length: 256 |
service_name | string | Required within parent | Storage service name. Maximum length: 100 |
List Email Drafts for a Record — response body — email drafts, info email drafts item linked record id, module — shared_linked-record_70e659738c7a
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | CRM record linked to this draft; null if not linked. Additional keys: not allowed |
id | string | Required within parent | Linked CRM record identifier. Maximum length: 64 |
module | object | Required within parent | Module of the linked record. Additional keys: not allowed |
module.api_name | string | Required within parent | Module API name. Maximum length: 100 |
module.id | string | Optional | Module tab identifier. Maximum length: 64 |
List Email Drafts for a Record — response body — email drafts, info email drafts item linked record id, module — shared_linked-record_dfa5af433a40
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | CRM record linked to this draft; null if not linked. Additional keys: not allowed |
id | string | Required within parent | Linked CRM record identifier. Maximum length: 64 |
module | object | Required within parent | Module of the linked record. Additional keys: not allowed |
module.api_name | string | Required within parent | Module API name. Maximum length: 100 |
module.id | string | Optional | Module tab identifier. Maximum length: 64 |
Update an Email Draft — request body — body email drafts item attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Attachment reference. Additional keys: not allowed |
_delete | boolean | Optional | true to remove this attachment. |
file_name | string | Optional | File name. Maximum length: 512 |
file_size | string | Optional | File size in bytes as a numeric string. Maximum length: 20 |
id | string | Required within parent | Attachment/file identifier. Use the [Files API](files.yaml#$.paths./files.get) to retrieve file IDs. Maximum length: 256 |
service_name | string | Required within parent | Storage service name. Maximum length: 100 |
Update an Email Draft — request body — body email drafts item inventory details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | Inventory email details; null to remove. Additional keys: not allowed |
inventory_template | object | Required within parent | Inventory template to use. Additional keys: not allowed |
inventory_template.id | string | Required within parent | Inventory template identifier. Maximum length: 64 |
paper_type | string | Required within parent | Paper type. One of: A4, USLetter |
view_type | string | Required within parent | View type. One of: portrait, landscape |
Update an Email Draft — request body — body email drafts item linked record
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | CRM record to link this draft to; null to clear. Additional keys: not allowed |
id | string | Required within parent | CRM record identifier to link. Maximum length: 64 |
module | object | Required within parent | Module to which the record belongs. Specify at least one of "api_name" or "id". If both are specified, they must refer to the same module. Minimum fields: 1 Additional keys: not allowed |
module.api_name | string | Optional | API name of the module. Maximum length: 100 |
module.id | string | Optional | Tab identifier of the module. Maximum length: 20 |
Update an Email Draft — request body — body email drafts item schedule details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object or null | Root | Scheduling details; null to remove schedule. Additional keys: not allowed |
source | string | Optional | Source of the schedule decision. One of: ecOneHourAhead, upTime, ecSchduleBestTime, ecUpComing, ecSchduleTime |
time | string | Required within parent | Scheduled send time (ISO 8601 format). Format: date-time |
timezone | string or null | Optional | Java TimeZone ID string; null uses organization default. Maximum length: 100 |
Update an Email Draft — response body — email drafts item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result of a single updated email draft. Additional keys: not allowed |
code | string | Required within parent | Status code for the operation. Known values: SUCCESS |
details | object | Required within parent | Details of the updated draft. Additional keys: not allowed |
details.id | string | Required within parent | Encrypted identifier of the updated draft. Maximum length: 256 |
message | string | Required within parent | Operation message. Maximum length: 512 |
status | string | Required within parent | Status of the operation. Known values: success |