Zoho: Attachments schemas
8 Zoho schemas with complete fields and constraints.
← Attachments operations · All schemas
Retrieve All Attachments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing list of attachments for a record Additional keys: not allowed |
data | array | Required within parent | Array of attachment objects Maximum items: 1000 |
data[] | Model | Each item | Expand Retrieve All Attachments — response body — data item |
info | Model | Required within parent | Expand Retrieve All Attachments — response body — info |
Referenced models: Retrieve All Attachments — response body — data item, Retrieve All Attachments — response body — info
Retrieve All Attachments — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Individual attachment metadata Additional keys: not allowed |
$editable | boolean | Optional | Indicates if the attachment is editable |
$field_states | JSON | Optional | |
$field_states (anyOf 1) | object | Alternative | Represents the field states metadata |
$field_states (anyOf 2) | null | Alternative | Represents the field states metadata |
$file_id | JSON | Optional | |
$file_id (anyOf 1) | string | Alternative | Represents the file identifier for the attachment Maximum length: 255 |
$file_id (anyOf 2) | null | Alternative | Represents the file identifier for the attachment Maximum length: 255 |
$link_url | JSON | Optional | |
$link_url (anyOf 1) | string | Alternative | Represents the URL for link-type attachments. Null for file attachments. Format: uri Maximum length: 2000 |
$link_url (anyOf 2) | null | Alternative | Represents the URL for link-type attachments. Null for file attachments. Format: uri Maximum length: 2000 |
$se_module | string | Optional | Represents the source module name Maximum length: 100 |
$sharing_permission | string | Optional | Represents the sharing permission level for the attachment Maximum length: 50 |
$state | string | Optional | Represents the current state of the attachment Maximum length: 50 |
$type | string | Optional | Represents the type of the attachment. Possible values: `File` for uploaded files, or `Link URL` for URL-based attachments. Maximum length: 50 |
Created_By | Model | Required within parent | Expand Retrieve All Attachments — response body — data item Created By |
Created_Time | string | Required within parent | Represents the timestamp when the attachment was created (ISO 8601 with timezone) Format: date-time |
File_Name | string | Optional | Represents the name of the attached file Maximum length: 250 |
Modified_By | Model | Required within parent | Expand Retrieve All Attachments — response body — data item Modified By |
Modified_Time | string | Required within parent | Represents the timestamp when the attachment was last modified (ISO 8601 with timezone) Format: date-time |
Owner | Model | Optional | Expand Retrieve All Attachments — response body — data item Owner |
Parent_Id | object | Optional | Parent record information Additional keys: not allowed |
Parent_Id.id | string | Required within parent | Parent record ID. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs. Maximum length: 50 Pattern: ^[0-9]+$ |
Parent_Id.name | string | Required within parent | Represents the parent record name Maximum length: 250 |
Size | string | Optional | Represents the size of the attachment in bytes Maximum length: 50000 Pattern: ^[0-9]+$ |
id | string | Required within parent | Represents the unique numeric identifier of the attachment Maximum length: 50 Pattern: ^[0-9]+$ |
Referenced models: Retrieve All Attachments — response body — data item Created By, Retrieve All Attachments — response body — data item Modified By, Retrieve All Attachments — response body — data item Owner
Retrieve All Attachments — response body — data item Created By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User who created the attachment. Additional keys: not allowed |
email | string | Optional | Represents the user email address Format: email Maximum length: 100 |
id | string | Required within parent | User ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs. Maximum length: 50 Pattern: ^[0-9]+$ |
name | string | Required within parent | Represents the user display name Maximum length: 250 |
Retrieve All Attachments — response body — data item Modified By
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User who last modified the attachment. Additional keys: not allowed |
email | string | Optional | Represents the user email address Format: email Maximum length: 100 |
id | string | Required within parent | User ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs. Maximum length: 50 Pattern: ^[0-9]+$ |
name | string | Required within parent | Represents the user display name Maximum length: 250 |
Retrieve All Attachments — response body — data item Owner
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Owner of the attachment Additional keys: not allowed |
email | string | Optional | Represents the owner email address Format: email Maximum length: 100 |
id | string | Required within parent | Owner user ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs. Maximum length: 50 Pattern: ^[0-9]+$ |
name | string | Required within parent | Represents the owner display name Maximum length: 250 |
Retrieve All Attachments — response body — info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination information for list responses Additional keys: not allowed |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | Represents the number of records returned in the current response Format: int32 Minimum: 0 |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
more_records | boolean | Required within parent | Indicates whether more records are available |
next_page_token | JSON | Required within parent | |
next_page_token (anyOf 1) | string | Alternative | Represents the token to retrieve the next page of results Maximum length: 1024 |
next_page_token (anyOf 2) | null | Alternative | Represents the token to retrieve the next page of results Maximum length: 1024 |
page | JSON | Required within parent | |
page (anyOf 1) | integer | Alternative | Represents the current page number Format: int32 Minimum: 1 |
page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
page_token_expiry | JSON | Required within parent | |
page_token_expiry (anyOf 1) | string | Alternative | Represents the expiry timestamp for the page tokens Format: date-time |
page_token_expiry (anyOf 2) | null | Alternative | Represents the expiry timestamp for the page tokens Format: date-time |
per_page | JSON | Required within parent | |
per_page (anyOf 1) | integer | Alternative | Represents the number of records per page Format: int32 Maximum: 200 Minimum: 1 |
per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
previous_page_token | JSON | Required within parent | |
previous_page_token (anyOf 1) | string | Alternative | Represents the token to retrieve the previous page of results Maximum length: 1024 |
previous_page_token (anyOf 2) | null | Alternative | Represents the token to retrieve the previous page of results Maximum length: 1024 |
Upload an Attachment — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Successful attachment operation response Additional keys: not allowed |
data | array | Required within parent | Array of upload results Maximum items: 100 |
data[] | object | Each item | Upload status details Additional keys: not allowed |
data[].code | string | Required within parent | Represents the response code Known values: SUCCESS |
data[].details | Model | Required within parent | Expand Upload an Attachment — response body — data item details |
data[].message | string | Required within parent | Represents the success message Known values: attachment uploaded successfully |
data[].status | string | Required within parent | Represents the operation status Known values: success |
Referenced models: Upload an Attachment — response body — data item details
Upload an Attachment — response body — data item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the uploaded attachment Additional keys: not allowed |
Created_By | object | Required within parent | Represents the user who created the attachment Additional keys: not allowed |
Created_By.id | string | Required within parent | User ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs. Maximum length: 50 Pattern: ^[0-9]+$ |
Created_By.name | string | Required within parent | Represents the user display name Maximum length: 250 |
Created_Time | string | Required within parent | Represents the creation timestamp Format: date-time |
Modified_By | object | Required within parent | Represents the user who last modified the attachment Additional keys: not allowed |
Modified_By.id | string | Required within parent | Represents the user ID Maximum length: 50 Pattern: ^[0-9]+$ |
Modified_By.name | string | Required within parent | Represents the user display name Maximum length: 250 |
Modified_Time | string | Required within parent | Represents the last modification timestamp Format: date-time |
id | string | Required within parent | Represents the attachment identifier Maximum length: 50 Pattern: ^[0-9]+$ |