Zoho: Layouts schemas (part 2)

← Layouts operations · All schemas

Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list linking details connected lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field on the linking module that points toward the connected (target) module, completing the many-to-many association in the multi-select lookup. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Contains the display label of the lookup field on the linking module that references the connected target module, as presented in the CRM interface. Maximum length: 100
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list linking details lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field on the linking module that points back toward the source module, establishing the origin side of the multi-select lookup relationship. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Contains the display label of the lookup field on the linking module that references the source module, as presented in the CRM interface. Maximum length: 100
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list related list

Field	Type	Presence	Description and constraints
$	object	Root	Represents the related list configuration associated with the multi-select lookup field, defining how linked records from the target module are displayed within the source record's detail view. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
display_label	string	Required within parent	Contains the label for the related list panel as rendered on the source record's detail page, identifying the collection of linked target-module records. Maximum length: 50
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration of a multi-user lookup field, which enables associating a record with multiple CRM users through a linking module rather than a single user reference. Additional keys: not allowed
linking_details	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details
record_access	boolean	Required within parent	Indicates whether the multi-user lookup grants the associated users access to the record being linked, in addition to recording the relationship. Possible values: `true` — linked users gain record-level access; `false` — the relationship is recorded without affecting the users' access to the record.

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details

Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details

Field	Type	Presence	Description and constraints
$	object	Root	Contains the configuration of the linking module and its lookup fields that connect the source module to multiple CRM users in a multi-user lookup relationship. Additional keys: not allowed
connected_lookup_field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details connected lookup field
lookup_field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details lookup field
module	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details module

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details connected lookup field, Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details lookup field, Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details module

Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details connected lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field on the linking module that references the Users module, forming the user-side join in the multi-user lookup relationship. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Contains the display label of the lookup field on the linking module that points to the Users module, as presented in the CRM interface. Maximum length: 100
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field on the linking module that references the source module, establishing the origin side of the multi-user lookup relationship. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Contains the display label of the lookup field on the linking module that references the source module, as presented in the CRM interface. Maximum length: 100
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup linking details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the linking module that intermediates the connection between the source module and the Users module in a multi-user lookup relationship. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
plural_label	string	Required within parent	Contains the plural display name of the linking module used in the multi-user lookup, as shown in navigation and relational panels within the CRM. Maximum length: 100

Get layouts metadata — response body — layouts layouts item sections item fields item operation type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the set of operations permitted on this field, specifying independently whether values can be supplied or modified through API-based create/update calls and through the CRM web interface create/update forms. Additional keys: not allowed
api_create	boolean	Required within parent	Indicates whether this field accepts a value when a record is saved through the API during creation. Possible values: `true` — the field value can be set via API during record creation; `false` — the field value cannot be set via API at record creation time.
api_update	boolean	Required within parent	Indicates whether this field accepts a new value when a record is saved through the API during an update. Possible values: `true` — the field can be modified via API during a record update; `false` — the field is read-only for API-based update operations.
web_create	boolean	Required within parent	Indicates whether this field appears and accepts a value when a record is saved through the CRM web interface during creation. Possible values: `true` — the field is editable in the web create form; `false` — the field does not appear or is locked in the web create form.
web_update	boolean	Required within parent	Indicates whether this field accepts a new value when a record is saved through the CRM web interface during an update. Possible values: `true` — the field is editable in the web edit form; `false` — the field is read-only or hidden in the web update form.

Get layouts metadata — response body — layouts layouts item sections item fields item parent field api name, id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the parent field reference for nested composite fields such as address child components, identifying the parent field by its API name. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the parent field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the parent field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the API name of the parent field under which this nested field is organized within the module layout. Maximum length: 50

Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item forecast category

Field	Type	Presence	Description and constraints
$	object	Root	Represents the sales forecast classification associated with this picklist option, grouping deals in a given stage into a defined forecast bucket such as Pipeline, Best Case, or Closed Won. Additional keys: not allowed
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the forecast category Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Optional	Represents the name of the forecast category assigned to this picklist option, identifying the forecast bucket to which deals at this stage are attributed. Maximum length: 100

Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item maps item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single dependent field mapping entry, associating this parent picklist option with a specific set of allowed values in a dependent picklist field. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the dependent picklist field. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the dependent picklist field. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
pick_list_values	array	Required within parent	Contains the subset of picklist values available in the dependent field when this parent option is selected, restricting user choices to contextually appropriate options. Maximum items: 500
pick_list_values[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item maps item pick list values item

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item maps item pick list values item

Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item maps item pick list values item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single allowed value entry in the dependent picklist, defining one option that becomes selectable in the dependent field when the parent picklist option is chosen. Additional keys: not allowed
actual_value	string	Required within parent	Represents the internal value stored when this dependent picklist option is selected, used as the system identifier for the choice in data storage and API responses. Maximum length: 120
colour_code	JSON	Required within parent	Represents the hexadecimal color code associated with this dependent picklist option, used to color-code records by their selected value when color coding is enabled for the field.
colour_code (anyOf 1)	string	Alternative	Represents the hexadecimal color code in #RRGGBB format for this dependent picklist option when color coding is active. Maximum length: 7 Minimum length: 7 Pattern: ^#[0-9A-Fa-f]{6}$
colour_code (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
display_value	string	Required within parent	Represents the label displayed in the CRM interface for this dependent picklist option, which may differ from its stored actual value. Maximum length: 120
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the picklist value. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item query details criteria, query id criteria field

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the field whose value is evaluated against the comparator and filter value in the query criteria. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the field used in the criteria. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the field used in the criteria. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item record category tracking field api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Field reference for tracking record category changes. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the tracking field. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the tracking field. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item refer from field api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active reference field configuration for a mirror field, identifying the source lookup field from which this field's value is derived. Additional keys: not allowed
api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the reference field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the reference field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active rollup summary configuration for this field, detailing the aggregation function, child module, filter criteria, and related list used to compute the summarized value. Additional keys: not allowed
based_on_module	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on based on module
expression	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression
related_list	JSON	Optional	Represents the related list configuration that defines the child module relationship from which records are drawn for the rollup summary calculation.
related_list (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on related list api name, id
related_list (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
return_type	string	Optional	Indicates the data type of the value produced by the rollup summary calculation, such as integer, decimal, or date, which determines how the computed result is stored and displayed. Maximum length: 50
rollup_based_on	string	Optional	Indicates the basis of the rollup calculation, specifying whether the aggregation operates on all related records or only on a filtered subset defined by the expression criteria. Maximum length: 50

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on based on module, Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression, Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on related list api name, id

Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on based on module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the child module from which related records are aggregated when computing the rollup summary value for this field. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the base module Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the base module Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression

Field	Type	Presence	Description and constraints
$	object	Root	Contains the expression configuration for the rollup summary calculation, including the aggregation function, the field being summarized, and any filter criteria applied to restrict which related records are included. Additional keys: not allowed
criteria	JSON	Optional	Represents the filter conditions applied to limit which related records in the child module are included in the rollup summary calculation.
criteria (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value
criteria (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
function	string	Required within parent	Represents the aggregation function applied to the child module records when computing the rollup summary, such as SUM, COUNT, MIN, MAX, or AVERAGE. Maximum length: 25
function_parameters	array	Required within parent	Contains the list of parameters passed to the rollup aggregation function, specifying which fields or values are used as inputs to the calculation. Maximum items: 100
function_parameters[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression function parameters item

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value, Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression function parameters item

Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active filter criteria configuration for the rollup summary, specifying the conditions that child module records must satisfy to be included in the aggregation. Additional keys: not allowed
comparator	string	Required within parent	Represents the comparison operator used in the rollup filter criterion, applied when evaluating whether a related record's field value satisfies the filter condition. Maximum length: 25
field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value field
type	string	Required within parent	Indicates whether the filter value in the rollup criterion is a static literal or a dynamic reference resolved at runtime. Maximum length: 25
value	string	Required within parent	Represents the value compared against the child module field when evaluating the rollup filter criterion. Maximum length: 100

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value field

Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value field

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the field in the child module whose value is tested against the comparator and filter value when determining which related records are included in the rollup. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the child module field used in the rollup filter criterion. Maximum length: 100
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the criteria field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on expression function parameters item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single parameter supplied to the rollup aggregation function, identifying a field or constant value used as an input to the summary calculation. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the parameter field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$

Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on related list api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active related list configuration for the rollup summary, identifying the child module relationship from which records are drawn for aggregation. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the related list Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the related list Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item sharing properties

Field	Type	Presence	Description and constraints
$	object	Root	Contains the sharing configuration for this field, defining how its value participates in record-level sharing rules and whether specific sharing preferences are active. Additional keys: not allowed
scheduler_status	JSON	Required within parent
scheduler_status (anyOf 1)	string	Alternative	Represents the active status of the sharing scheduler for this field, indicating the current state of sharing rule propagation. Maximum length: 50
scheduler_status (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
share_permission	string	Required within parent	Represents the sharing access level assigned to this field, controlling whether users who receive shared record access can read, edit, or are restricted from this field's value. Maximum length: 50
share_preference_enabled	boolean	Required within parent	Indicates whether the sharing preference configuration is active for this field. Possible values: `true` — sharing preference settings are applied to this field; `false` — sharing preference is not enabled.
share_with_superiors	boolean	Optional	Indicates whether this field's value is shared with users in superior roles in the CRM role hierarchy when record sharing propagates upward. Possible values: `true` — the field is shared with superior role users; `false` — the field is not shared with superiors.

Get layouts metadata — response body — layouts layouts item sections item fields item subform id, module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active subform reference configuration for this field, including the API name of the associated subform module and any layout reference for embedded record rendering. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the subform tab. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
module	string	Required within parent	Represents the API name of the module whose records are embedded as a subform in the parent module's layout. Maximum length: 50

Get layouts metadata — response body — layouts layouts item sections item fields item tooltip name, value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active tooltip configuration for this field, specifying the help text and delivery mechanism shown to users when they interact with the field. Additional keys: not allowed
name	string	Required within parent	Indicates the delivery mechanism for the tooltip, such as whether it is rendered as a static label or as a modal help popup. Maximum length: 25
value	string	Required within parent	Contains the help text displayed in the tooltip when users interact with this field, providing contextual guidance on the field's purpose or expected input. Maximum length: 255

Get layouts metadata — response body — layouts layouts item sections item fields item unique

Field	Type	Presence	Description and constraints
$	object	Root	Represents the uniqueness constraint configuration for this field, controlling whether duplicate values are permitted across records in the module and whether the check is case-sensitive. Additional keys: not allowed
case_sensitive	boolean	Optional	Indicates whether the field's uniqueness constraint treats values differing only in letter case as distinct. Possible values: `true` — case-sensitive comparison is applied and values with different casing are treated as unique; `false` — the uniqueness check is case-insensitive.

Get layouts metadata — response body — layouts layouts item sections item fields item validation rule id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active Validation Rule reference applied to this field, identifying the rule used to enforce input constraints when a record is saved. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the validation rule applied to this field. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item view type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the view-mode availability settings for this field, specifying in which CRM interaction contexts — such as record creation, editing, viewing, or quick-create — the field is shown or editable. Additional keys: not allowed
create	boolean	Required within parent	Indicates whether this field is presented in the record creation form. Possible values: `true` — the field is shown when creating a new record; `false` — the field does not appear in the create form.
edit	boolean	Required within parent	Indicates whether this field is presented and editable in the record edit form. Possible values: `true` — the field is shown in edit mode; `false` — the field is hidden or read-only during editing.
quick_create	boolean	Required within parent	Indicates whether this field is included in the abbreviated quick-create form. Possible values: `true` — the field appears in the quick-create panel; `false` — the field is excluded from quick-create.
view	boolean	Required within parent	Indicates whether this field is visible when a record is viewed in detail mode. Possible values: `true` — the field is displayed on the record detail page; `false` — the field is hidden from the detail view.

Get layouts metadata — response body — layouts layouts item sections item parent section id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the parent section reference for a nested section, identifying the containing parent section by name when a hierarchical section relationship exists. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the parent section. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the name of the parent section under which this nested section is organized within the layout. Maximum length: 100

Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip

Field	Type	Presence	Description and constraints
$	object	Root	Represents the additional configuration properties for subform sections, including row-level interaction settings, tooltip configuration, and conditional display preferences. Additional keys: not allowed
bulk_addition	JSON	Optional
bulk_addition (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields
bulk_addition (anyOf 2)	object	Alternative	Empty object when bulk addition is not configured Maximum fields: 0 Additional keys: not allowed
bulk_addition (anyOf 3)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
maximum_rows	JSON	Optional
maximum_rows (anyOf 1)	number	Alternative	Indicates the maximum number of rows that can be added to the subform section, controlling how many related records can be embedded in a single parent record's layout. Format: int32 Minimum: 1
maximum_rows (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preference	array	Optional	Contains the conditional display criteria for the section, defining the field conditions that must be satisfied for the section to be shown or for certain section behaviors to be applied. Maximum items: 50
preference[]	object	Each item	Represents a single conditional display criterion for the section, specifying the field, comparison operator, value type, and comparison value used to evaluate whether the condition is met. Additional keys: not allowed
preference[].comparator	string	Required within parent	Represents the comparison operator applied when evaluating the section preference criterion, such as equals, contains, or is not null. Maximum length: 50
preference[].field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip preference item field
preference[].type	string	Required within parent	Indicates whether the comparison value in the preference criterion is a static literal or a dynamic contextual reference resolved at runtime. Maximum length: 50
preference[].value	JSON	Required within parent	Represents the value compared against the selected field when evaluating the section preference criterion, which may be a string, number, or Boolean depending on the field type.
preference[].value (anyOf 1)	string	Alternative	Represents a string value used as the comparison operand in the section preference criterion. Maximum length: 255
preference[].value (anyOf 2)	JSON	Alternative
preference[].value (anyOf 2) (anyOf 1)	number	Alternative	Represents a numeric value used as the comparison operand in the section preference criterion.
preference[].value (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
preference[].value (anyOf 3)	boolean	Alternative	Represents a Boolean value used as the comparison operand in the section preference criterion.
preference[].value (anyOf 4)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
reorder_rows	boolean	Optional	Indicates whether users are permitted to reorder existing rows within the subform section by dragging them to a new position. Possible values: `true` — row reordering is allowed; `false` — rows cannot be reordered.
tooltip	JSON	Optional
tooltip (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip tooltip name, value
tooltip (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.

Referenced models: Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields, Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip preference item field, Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip tooltip name, value

Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active bulk addition configuration for a subform section, enabling users to add multiple rows simultaneously to the subform. Additional keys: not allowed
lookup_field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields lookup field
subform_fields	JSON	Required within parent
subform_fields (anyOf 1)	array	Alternative	List of subform fields available for bulk addition Maximum items: 50
subform_fields (anyOf 1)[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields subform fields List of subform fields available for bulk addition item
subform_fields (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.

Referenced models: Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields lookup field, Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields subform fields List of subform fields available for bulk addition item

Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields lookup field

Field	Type	Presence	Description and constraints
$	object	Root	The lookup field used for bulk addition Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Display name of the lookup field Maximum length: 100

Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip bulk addition lookup field, subform fields subform fields List of subform fields available for bulk addition item

Field	Type	Presence	Description and constraints
$	object	Root	A subform field available for bulk addition Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Display name of the subform field Maximum length: 100

Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip preference item field

Field	Type	Presence	Description and constraints
$	object	Root	Identifies the field whose value is evaluated against the comparator and preference value to determine whether the section's conditional display condition is met. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the field used in the criteria. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the field used in the criteria. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip tooltip name, value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active tooltip configuration for this section, specifying the help text and display mechanism shown to users when they hover over the section header. Additional keys: not allowed
name	string	Required within parent	Indicates the delivery mechanism for the section tooltip, such as whether it is rendered as a static label or as a modal help popup. Maximum length: 255
value	string	Required within parent	Contains the help text displayed in the section tooltip, providing contextual guidance about the purpose or use of the section. Maximum length: 255

Get layouts metadata — response body — layouts — Layout Fields Response Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response returned when the `fields` query parameter trims each layout to the requested keys. Only `id` is guaranteed - it is returned even when it is not requested - every other key appears only when it was asked for, and keys with no value for a layout are returned as null. Additional keys: not allowed
layouts	array	Required within parent	Represents the array of layout objects trimmed to the keys requested through the `fields` parameter, ordered by layout name. Maximum items: 15
layouts[]	object	Each item	Represents an individual layout carrying only the keys requested through the `fields` parameter, plus the always-present `id`. Additional keys: not allowed
layouts[].api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the layout. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
layouts[].created_by	JSON	Optional
layouts[].created_by (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item created by id, name User who created the layout.
layouts[].created_by (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].created_time	JSON	Optional
layouts[].created_time (anyOf 1)	string	Alternative	ISO 8601 datetime with timezone offset indicating when the layout was created. Format: date-time
layouts[].created_time (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].display_label	string	Optional	Represents the display label of the layout shown in the CRM interface. Maximum length: 100 Minimum length: 1
layouts[].generated_type	string	Optional	Indicates whether the layout was generated by the system or created by a user. Known values: system, custom
layouts[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the layout. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
layouts[].modified_by	JSON	Optional
layouts[].modified_by (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item created by id, name User who last modified the layout.
layouts[].modified_by (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].modified_time	JSON	Optional
layouts[].modified_time (anyOf 1)	string	Alternative	ISO 8601 datetime with timezone offset indicating when the layout was last modified. Format: date-time
layouts[].modified_time (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].name	string	Optional	Represents the internal API name of the layout. Maximum length: 40 Minimum length: 1
layouts[].show_business_card	boolean	Optional	Indicates whether the business card view is enabled for this layout.
layouts[].source	string	Optional	Represents the source from which this layout was created. Known values: crm, platform_plugin, marketplace_plugin, campaign_integration
layouts[].status	string	Optional	Represents the current status of the layout. Known values: active, inactive
layouts[].visible	boolean	Optional	Indicates whether the layout is visible to users in the CRM interface.

Referenced models: Get layouts metadata — response body — layouts layouts item created by id, name

Get layouts metadata — response body — layouts — Layout Response Schema

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response schema for layout retrieval operations, containing an array of layout objects each with complete configuration details including sections, profiles, and portal user type associations. Additional keys: not allowed
layouts	array	Required within parent	Contains the array of layout objects returned for the specified module, each representing a complete layout configuration including sections, fields, profiles, and portal user type associations. Maximum items: 15
layouts[]	object	Each item	Represents the complete configuration of a single layout in the module, including its sections, field assignments, profile associations, and display metadata. Additional keys: not allowed
layouts[].actions_allowed	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item actions allowed Permissions indicating which operations are allowed on this layout
layouts[].api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the layout Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
layouts[].convert_mapping	JSON	Optional
layouts[].convert_mapping (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item convert mapping value
layouts[].convert_mapping (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].created_by	JSON	Optional
layouts[].created_by (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item created by id, name User who created the layout
layouts[].created_by (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].created_for	JSON	Required within parent
layouts[].created_for (anyOf 1)	string	Alternative	Represents the integration or system context that prompted the creation of this layout, identifying the source platform or feature responsible for provisioning it. Maximum length: 100
layouts[].created_for (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].created_time	JSON	Required within parent
layouts[].created_time (anyOf 1)	string	Alternative	Represents the ISO 8601 datetime with timezone offset recording when this layout was first created in the CRM. Format: date-time
layouts[].created_time (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].display_label	string	Required within parent	Represents the label of the layout as displayed in the CRM interface, shown in layout selection dropdowns and record settings. Maximum length: 100 Minimum length: 1
layouts[].generated_type	string	Required within parent	Indicates whether this layout originates from automatic system generation or from an administrator's manual configuration. Possible values: `system` — automatically generated by Zoho CRM. `custom` — created manually by an administrator. Known values: system, custom
layouts[].has_more_profiles	boolean	Required within parent	Indicates whether additional profile associations exist for this layout beyond those included in the current response. Possible values: `true` — more profile associations are available; `false` — all profile associations are represented.
layouts[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
layouts[].modified_by	JSON	Required within parent
layouts[].modified_by (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item created by id, name User who last modified the layout
layouts[].modified_by (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].modified_time	JSON	Required within parent
layouts[].modified_time (anyOf 1)	string	Alternative	Represents the ISO 8601 datetime with timezone offset recording when this layout's configuration was most recently changed. Format: date-time
layouts[].modified_time (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].name	string	Required within parent	Represents the internal API name of the layout, used as a programmatic identifier in API operations and automation configurations. Maximum length: 40 Minimum length: 1
layouts[].portal_user_types	array	Optional	Contains the list of portal user type associations for this layout, each specifying which portal user category the layout is associated with and the default view configuration for that user type. Maximum items: 50
layouts[].portal_user_types[]	object	Each item	Represents the portal user type configuration entry for this layout, specifying the user type, default view settings, and whether this is the default layout for that user type. Additional keys: not allowed
layouts[].portal_user_types[]._default_view	object	Required within parent	Represents the default view assigned to this portal user type for the layout, defining which view is presented to portal users of this type by default. Additional keys: not allowed
layouts[].portal_user_types[]._default_view.id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the default view Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
layouts[].portal_user_types[]._default_view.name	string	Required within parent	Represents the API name of the default view assigned to this portal user type. Maximum length: 255
layouts[].portal_user_types[]._default_view.type	string	Required within parent	Indicates the category of the default view assigned to this portal user type, such as a layout view or a wizard-based view. Known values: layout, wizard
layouts[].portal_user_types[].default	boolean	Required within parent	Indicates whether this layout is the default for the associated portal user type. Possible values: `true` — this is the default layout for this portal user type; `false` — it is not the default.
layouts[].portal_user_types[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the portal user type Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
layouts[].portal_user_types[].name	string	Required within parent	Represents the name of the portal user type associated with this layout entry. Maximum length: 255
layouts[].profiles	JSON	Required within parent
layouts[].profiles (anyOf 1)	array	Alternative	Represents the list of CRM profiles associated with this layout. Contains an empty array when no profiles are assigned. Maximum items: 50 Minimum items: 1
layouts[].profiles (anyOf 1)[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item profiles array item
layouts[].profiles (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].sections	array	Required within parent	Contains the ordered list of sections within this layout, each grouping a set of fields and defining display properties such as column count and tab traversal order. Maximum items: 100 Minimum items: 0
layouts[].sections[]	object	Each item	Represents a single section within the layout, encapsulating the section's field collection, display label, column configuration, and any subform or parent-section relationships. Additional keys: not allowed
layouts[].sections[].actions_allowed	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item actions allowed Permissions for section operations. System sections (Score, Visit Summary) will have restricted permissions.
layouts[].sections[].api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API identifier for the section Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
layouts[].sections[].column_count	JSON	Required within parent
layouts[].sections[].column_count (anyOf 1)	number	Alternative	Indicates the number of columns in which fields are arranged within this section, controlling the side-by-side or single-column display of fields on record forms. Known values: 1, 2 Format: int32
layouts[].sections[].column_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
layouts[].sections[].display_label	string	Required within parent	Represents the name of the section as displayed in the CRM interface, used as the section heading on record create and detail pages. Maximum length: 100 Minimum length: 1
layouts[].sections[].fields	array	Required within parent	Contains the ordered list of fields assigned to this section. Fields are presented in ascending sequence_number order. Maximum items: 500
layouts[].sections[].fields[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item
layouts[].sections[].generated_type	string	Required within parent	Indicates whether this section originates from automatic system generation or from an administrator's manual configuration. Possible values: `default` — automatically generated by the CRM platform. `custom` — defined manually by an administrator. Known values: default, custom
layouts[].sections[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
layouts[].sections[].isSubformSection	boolean	Required within parent	Indicates whether this section renders as an embedded subform that displays related module records inline within the parent record's layout. Possible values: `true` — the section is a subform; `false` — the section is a standard field group.
layouts[].sections[].is_parent_section	boolean	Optional	Indicates whether this section acts as the parent container for a dependent subform section, establishing a hierarchical section relationship within the layout. Possible values: `true` — this is a parent section; `false` — this section is not a parent container.
layouts[].sections[].mode	string	Required within parent	Represents the layout mode for which this section applies, controlling in which view contexts the section and its fields render. Possible values: `all` — applies across all layout modes. `business_card` — applies to the business card view. `quick_create` — applies to the quick-create form. `default_create` — applies to the default record creation form. `create_edit` — applies to both create and edit forms. `view` — applies to the record detail view. `quick_view` — applies to the quick view panel. `subform_default_create` — applies to the default create form within a subform context. Known values: all, business_card, quick_create, default_create, create_edit, view, quick_view, subform_default_create
layouts[].sections[].name	string	Required within parent	Represents the internal name of the section used to reference it in layout configurations and API operations. Maximum length: 50 Minimum length: 1
layouts[].sections[].parent_section	JSON	Optional	Represents a reference to the parent section when this section is nested as a subform or dependent section within the layout hierarchy.
layouts[].sections[].parent_section (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item parent section id, name
layouts[].sections[].parent_section (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].sections[].properties	JSON	Optional
layouts[].sections[].properties (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip
layouts[].sections[].properties (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
layouts[].sections[].sequence_number	JSON	Required within parent
layouts[].sections[].sequence_number (anyOf 1)	number	Alternative	Represents the ordinal position of this section within the layout, controlling the order in which sections are rendered on record forms. Format: int32 Minimum: 1
layouts[].sections[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
layouts[].sections[].tab_traversal	string	Required within parent	Indicates the direction of keyboard tab navigation within this section, determining the order in which focus moves between fields when users press Tab. Possible values: `left_to_right` — focus moves horizontally across columns first. `top_to_bottom` — focus moves vertically down each column first. Known values: left_to_right, top_to_bottom
layouts[].sections[].type	string	Optional	Represents the usage status type of this section within the layout. Possible values: `used` — the section contains fields assigned to it. `unused` — the section exists in the layout but contains no assigned fields. Known values: used, unused
layouts[].show_business_card	boolean	Required within parent	Indicates whether the business card view is enabled for this layout, allowing a compact summary of key fields to be shown in preview and lookup contexts. Possible values: `true` — business card view is active; `false` — business card view is not enabled.
layouts[].source	string	Required within parent	Represents the origin channel of this layout. Possible values: `crm` — the layout is built into the standard module definition. `platform_plugin` — the layout comes from a Zoho platform plugin. `marketplace_plugin` — the layout comes from a Marketplace extension. `campaign_integration` — the layout comes from a Campaigns integration. Known values: crm, platform_plugin, marketplace_plugin, campaign_integration
layouts[].status	string	Required within parent	Indicates the current operational status of the layout. Possible values: `active` — the layout is in use and can be assigned to profiles; `inactive` — the layout has been deactivated and is not available for new assignments. Known values: active, inactive, downgraded, hidden
layouts[].total_profiles	JSON	Optional
layouts[].total_profiles (anyOf 1)	number	Alternative	Indicates the total number of CRM profiles associated with this layout, which may exceed the number of profiles included in the current response when has_more_profiles is true. Format: int32
layouts[].total_profiles (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
layouts[].visible	boolean	Required within parent	Indicates whether this layout is currently visible and accessible to users in the CRM interface. Possible values: `true` — the layout is visible and selectable; `false` — the layout is hidden.

Referenced models: Get layouts metadata — response body — layouts layouts item sections item actions allowed, Get layouts metadata — response body — layouts layouts item convert mapping value, Get layouts metadata — response body — layouts layouts item actions allowed, Get layouts metadata — response body — layouts layouts item created by id, name, Get layouts metadata — response body — layouts layouts item sections item fields item, Get layouts metadata — response body — layouts layouts item profiles array item, Get layouts metadata — response body — layouts layouts item sections item properties bulk addition, maximum rows, preference, reorder rows, tooltip, Get layouts metadata — response body — layouts layouts item sections item parent section id, name

Update a custom layout — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the request body for updating a layout, containing exactly one layout object with the configuration changes to apply. Additional keys: not allowed
layouts	array	Required within parent	Contains exactly one layout object defining the update operations to be applied, including sections, profiles, and display settings. Maximum items: 1 Minimum items: 1
layouts[]	Model	Each item	Expand Update a custom layout — request body — body layouts item

Referenced models: Update a custom layout — request body — body layouts item

Update a custom layout — request body — body layouts item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the layout configuration object supplied in an update request, containing at least one of the updatable attributes: name, sections, profiles, or business card display setting. Minimum fields: 1 Additional keys: not allowed
name	string	Optional	Represents the new display name for the layout. Must be unique within the module's layout configurations. Maximum length: 255 Minimum length: 1
profiles	array	Optional	Contains the array of profile objects to be added to or removed from the layout's profile associations in this update operation. Maximum items: 50 Minimum items: 1
profiles[]	Model	Each item	Expand Update a custom layout — request body — body layouts item profiles item
sections	array	Optional	Contains the array of section objects to be created, modified, or deleted as part of this layout update, defining the field and configuration changes within each section. Maximum items: 5 Minimum items: 1
sections[]	Model	Each item	Expand Update a custom layout — request body — body layouts item sections item
show_business_card	boolean	Optional	Specifies whether the business card view is enabled or disabled for this layout as part of the update.

Referenced models: Update a custom layout — request body — body layouts item profiles item, Update a custom layout — request body — body layouts item sections item

Update a custom layout — request body — body layouts item profiles item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a profile operation object used in layout update requests to add a profile to or remove a profile from the layout's permission associations. Additional keys: not allowed
_delete	boolean	Optional	Indicates whether this profile's association with the layout should be removed. Possible values: `true` — the profile is disassociated from the layout; `false` — the profile association is retained or added.
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the profile. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Update a custom layout — request body — body layouts item sections item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a section operation object used in layout update requests to create, modify, or delete a section within the layout, including its label, field assignments, column count, and sequence. Minimum fields: 1 Additional keys: allowed
_delete	Model	Optional	Expand Update a custom layout — request body — body layouts item sections item delete Delete configuration for removing the section. When provided, the section identified by id will be deleted.
column_count	integer	Optional	Indicates the number of columns in which fields are arranged within this section when the layout is rendered on record forms. Format: int32 Maximum: 2 Minimum: 1
display_label	string	Optional	Represents the heading label of the section as displayed in the CRM interface. Required when creating a new section. Maximum length: 255 Minimum length: 1
fields	array	Optional	Contains the array of field operations to perform within this section, including adding, updating, creating, or removing field entries. Maximum items: 25 Minimum items: 1
fields[]	Model	Each item	Expand Update a custom layout — request body — body layouts item sections item fields item
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the section. Required for updating or deleting existing sections. Omit when creating a new section. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Optional	Represents the internal API name of the section. Required when creating a new section through a layout update. Maximum length: 255 Minimum length: 1
sequence_number	integer	Optional	Indicates the one-based ordinal position of the section within the layout, controlling the order in which sections are rendered. Format: int32 Maximum: 100 Minimum: 1
tab_traversal	string	Optional	Specifies the tab key navigation direction within the section. Defines how focus moves between fields when users press Tab. Possible values: `left_to_right` — focus moves horizontally across columns first. `top_to_bottom` — focus moves vertically down each column first. One of: left_to_right, top_to_bottom

Referenced models: Update a custom layout — request body — body layouts item sections item delete, Update a custom layout — request body — body layouts item sections item fields item

Update a custom layout — request body — body layouts item sections item delete

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration object used to specify the deletion mode when removing a layout or resource, indicating whether the deletion is permanent or a soft delete to the recycle bin. Additional keys: not allowed
permanent	boolean	Required within parent	Indicates whether the resource is removed irrecoverably or placed in the recycle bin for potential recovery. Possible values: `true` — the resource is permanently destroyed and cannot be restored; `false` — the resource is moved to trash and may be recovered before final purge.

Update a custom layout — request body — body layouts item sections item fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a field operation object used in layout update requests to add, modify, create, or remove a field within a section. Minimum fields: 1 Additional keys: not allowed
_delete	Model	Optional	Expand Update a custom layout — request body — body layouts item sections item delete Delete configuration for removing the field. Set permanent to false to move to unused section (can be re-added later), true to permanently delete the field and its data.
association_details	Model	Optional	Expand Update a custom layout — request body — body layouts item sections item fields item association details Association details for Field-Of-Lookup (FOL) mapping. Links this field to a related field in another module through a lookup field.
data_type	string	Optional	Represents the data type of the field. Required when adding a new custom field to the layout. Possible values: `text`, `textarea`, `email`, `phone`, `website`, `integer`, `bigint`, `currency`, `double`, `percent`, `date`, `datetime`, `boolean`, `picklist`, `multiselectpicklist`, `lookup`, `multiselectlookup`, `autonumber`, `fileupload`, `imageupload`, `formula`, `rollup_summary`, `consent_lookup`, `profileimage`, `richtextarea`, `userlookup`, `multiuserlookup`, `event_reminder`. One of: text, textarea, email, phone, website, integer, bigint, currency, double, percent, date, datetime, boolean, picklist, multiselectpicklist, lookup, multiselectlookup, autonumber, fileupload, imageupload, formula, rollup_summary, consent_lookup, profileimage, richtextarea, userlookup, multiuserlookup, event_reminder
element_type	string	Optional	Represents the element type for special field components in the layout, distinguishing standard data fields from mirror fields. Possible values: `field` — a standard data field. `mirror_field` — a field that mirrors a value from a lookup source. One of: field, mirror_field
field_label	string	Optional	Represents the display label shown for the field in the CRM interface. Required when creating a new custom field through a layout update. Maximum length: 255 Minimum length: 1
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of an existing field. Required when adding, updating position, or removing an existing field. Omit when creating a new custom field. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
length	integer	Optional	Represents the maximum number of characters permitted for this field's value. Applicable to text and textarea field types. Format: int32 Maximum: 32000 Minimum: 1
lookup_field	object	Optional	Represents the source lookup field from which a mirror field derives its value, establishing the cross-module field reference for mirror field creation. Additional keys: not allowed
lookup_field.api_name	string	Optional	Represents the API name of the source lookup field on which this mirror field is based. Maximum length: 100
lookup_field.id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the source lookup field. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
sequence_number	integer	Optional	Represents the one-based ordinal position of the field within its containing section, controlling the rendering order of fields on record forms. Format: int32 Minimum: 1

Referenced models: Update a custom layout — request body — body layouts item sections item delete, Update a custom layout — request body — body layouts item sections item fields item association details

Update a custom layout — request body — body layouts item sections item fields item association details

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Represents the association details for a Field-Of-Lookup relationship, providing the lookup field and the related field that together define the association being updated. Additional keys: not allowed
$ (anyOf 1).lookup_field	object	Required within parent	Represents the lookup field used to establish the association, identifiable by its ID, API name, or a combination of both. Additional keys: not allowed
$ (anyOf 1).lookup_field.api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
$ (anyOf 1).lookup_field.id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
$ (anyOf 1).lookup_field.reference_id	string	Optional	Represents a temporary identifier used to reference a section or element within a layout update request payload, enabling cross-referencing between newly created elements before their permanent IDs are assigned. Maximum length: 255 Pattern: \{\{[a-zA-Z0-9]+\}\}
$ (anyOf 1).related_field	object	Required within parent	Represents the related field on the associated module used to complete the lookup association, identifiable by its ID or API name. Additional keys: not allowed
$ (anyOf 1).related_field.api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
$ (anyOf 1).related_field.id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
$ (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.

Update a custom layout — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the successful response returned when a layout update operation completes, containing the per-layout update results. Additional keys: not allowed
layouts	array	Required within parent	Contains the array of result entries for the layout update operation, each reporting the outcome for an individual layout. Maximum items: 1 Minimum items: 1
layouts[]	Model	Each item	Expand Update a custom layout — response body — layouts item

Referenced models: Update a custom layout — response body — layouts item

Update a custom layout — response body — layouts item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the success result returned when a layout update operation completes without error, containing a confirmation code, message, and the identifying details of the updated layout. Additional keys: not allowed
code	string	Required within parent	Represents the success code returned when the layout update operation completes without error. Known values: SUCCESS
details	object	Required within parent	Contains the identifying details of the layout that was successfully updated, such as its ID. Additional keys: not allowed
details.id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the updated layout. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
message	string	Required within parent	Contains a confirmation message indicating that the layout update operation completed successfully. Maximum length: 255
status	string	Required within parent	Indicates the outcome of the layout update operation. Possible values: `success` — the layout update completes successfully. Known values: success