Zoho: Profiles schemas
10 Zoho schemas with complete fields and constraints.
← Profiles operations · All schemas
Clone a CRM profile — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response body returned after a profile is successfully cloned. Additional keys: not allowed |
profiles | array | Required within parent | Array containing the clone action result (contains at most one entry). Maximum items: 1 |
profiles[] | Model | Each item | Expand Clone a CRM profile — response body — profiles item |
Referenced models: Clone a CRM profile — response body — profiles item
Clone a CRM profile — response body — profiles item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response of a successful profile clone action. Additional keys: not allowed |
code | string | Required within parent | Operation result code. Possible values: `SUCCESS`. Known values: SUCCESS |
details | object | Required within parent | Represents the additional details returned with the clone operation result. Additional keys: not allowed |
details.id | string | Required within parent | Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. ID of the newly created (cloned) profile. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |
message | string | Required within parent | Description of the clone operation result. Maximum length: 1000 |
status | string | Required within parent | Status of the operation result. Possible values: `success`. Known values: success |
Profiles — response body — profiles item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Creator of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when creator information is not available. |
$ (anyOf 1) | JSON | Alternative | User who created the profile. |
$ (anyOf 1) (allOf 1) | Model | All variants apply | Expand Profiles — response body — profiles item created by id, name id, name |
$ (anyOf 2) | JSON | Alternative | Null when creator information is not available. |
$ (anyOf 2) (allOf 1) | null | All variants apply | Represents a null value for optional fields. |
Referenced models: Profiles — response body — profiles item created by id, name id, name
Profiles — response body — profiles item created by id, name id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to the CRM user who performed an action on a profile. Additional keys: not allowed |
id | string | Required within parent | Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |
name | string | Required within parent | Display name of the user as shown in Zoho CRM. Maximum length: 100 Minimum length: 1 |
Profiles — response body — profiles item created time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Creation timestamp of the profile - an ISO 8601 datetime string, or null when creation time is not available. |
$ (anyOf 1) | JSON | Alternative | Profile creation timestamp. |
$ (anyOf 1) (allOf 1) | string | All variants apply | ISO 8601 datetime string with timezone offset representing when the profile action was performed (for example, `2024-05-17T09:15:56+05:30`). Format: date-time |
$ (anyOf 2) | JSON | Alternative | Null when creation time is not available. |
$ (anyOf 2) (allOf 1) | null | All variants apply | Represents a null value for optional fields. |
Profiles — response body — profiles item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Last modifier of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when modifier information is not available. |
$ (anyOf 1) | JSON | Alternative | User who last modified the profile. |
$ (anyOf 1) (allOf 1) | Model | All variants apply | Expand Profiles — response body — profiles item created by id, name id, name |
$ (anyOf 2) | JSON | Alternative | Null when modifier information is not available. |
$ (anyOf 2) (allOf 1) | null | All variants apply | Represents a null value for optional fields. |
Referenced models: Profiles — response body — profiles item created by id, name id, name
Profiles — response body — profiles item modified time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Last modification timestamp of the profile - an ISO 8601 datetime string, or null when the modification time is not available. |
$ (anyOf 1) | JSON | Alternative | Profile last-modified timestamp. |
$ (anyOf 1) (allOf 1) | string | All variants apply | ISO 8601 datetime string with timezone offset representing when the profile action was performed (for example, `2024-05-17T09:15:56+05:30`). Format: date-time |
$ (anyOf 2) | JSON | Alternative | Null when modification time is not available. |
$ (anyOf 2) (allOf 1) | null | All variants apply | Represents a null value for optional fields. |
Profiles — response body — profiles item sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A section grouping related permission categories. Additional keys: not allowed |
categories | array | Required within parent | List of permission categories within this section (up to 100 categories). Maximum items: 100 |
categories[] | Model | Each item | Expand Profiles — response body — profiles item sections item categories item |
name | string | Required within parent | Internal name of the permission section. Maximum length: 255 |
Referenced models: Profiles — response body — profiles item sections item categories item
Profiles — response body — profiles item sections item categories item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single permission category containing related permissions. Additional keys: not allowed |
display_label | string | Required within parent | Display label shown for this category in the CRM UI. Maximum length: 255 |
module | JSON | Optional | |
module (anyOf 1) | string | Alternative | Module associated with this category or null when the category is not module-specific. Maximum length: 100 |
module (anyOf 2) | null | Alternative | Module associated with this category or null when the category is not module-specific. Maximum length: 100 |
name | string | Required within parent | Internal name of the permission category. Maximum length: 255 |
permissions_details | array | Required within parent | Permission identifiers grouped under this category. Maximum items: 500 Minimum items: 0 |
permissions_details[] | string | Each item | A single permission identifier string associated with this category. Maximum length: 255 |
Specific Profile — request body — body profiles item permissions details item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single permission toggle entry specifying the permission ID and its desired enabled state. Additional keys: not allowed |
enabled | boolean | Required within parent | Desired enabled state for the permission. **Possible values:** `true` to enable, `false` to disable. |
id | string | Required within parent | The unique identifier of the permission. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$ |