Zoho: Layouts activate deactivate schemas
1 Zoho schema with complete fields and constraints.
← Layouts activate deactivate operations · All schemas
Activate Layout — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the request payload for activating a layout, including the layout identifier and optional profile associations. Additional keys: not allowed |
layouts | array | Required within parent | Specify the array containing exactly one layout object to activate. The layout includes its unique identifier and optionally the profiles to associate or disassociate. Profile associations can be added (default) or removed (using _delete flag). The array must contain exactly one item. Maximum items: 1 Minimum items: 1 |
layouts[] | object | Each item | Specify the layout configuration, including its unique identifier and the profile associations to add or remove during activation. Additional keys: not allowed |
layouts[].id | string | Required within parent | Specify the unique identifier of the deactivated layout to activate. Must reference an existing deactivated layout within the specified module. The ID is represented as a string containing a 64-bit integer value. Layout IDs are data center-specific. The status key in the response from the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) indicates whether the layout is **active** or **inactive**. Format: int64 Maximum length: 20 Minimum length: 1 Pattern: ^[0-9]+$ |
layouts[].profiles | array | Optional | Specify the profile associations to add to or remove from the layout during activation. Omitting this field or providing an empty array preserves existing profile associations. Refer to the [Get Profiles](profiles.yaml#$.paths./settings/profiles.get) resource for valid values. Use the _delete flag to remove existing associations. Empty array or omitting this field entirely preserves existing profile associations. At least one profile must remain associated with the layout after all operations are applied. While duplicate profile IDs are technically allowed, they cause unnecessary processing and should be avoided. Maximum items: 100 |
layouts[].profiles[] | object | Each item | Specify a profile to associate with or disassociate from the layout. Additional keys: not allowed |
layouts[].profiles[]._delete | boolean | Optional | Specify whether to remove this profile's association from the layout. Possible values: **true** - Removes the profile association from the layout. **false** - Adds or retains the profile association on the layout. Default: false |
layouts[].profiles[].id | string | Required within parent | Specify the unique identifier of the profile to associate with or disassociate from the layout. Must be a profile that exists in the CRM organization and is associated with the specified module. The ID is represented as a string containing a 64-bit integer value. Refer to the [Get Profiles](profiles.yaml#$.paths./settings/profiles.get) resource for valid values. Format: int64 Maximum length: 20 Minimum length: 1 Pattern: ^[0-9]+$ |