Zoho: Get wizard details
Zoho wizards.getWizardDetails: arguments, response, policy and SDK examples.
← Wizards operations · Get started
Operation zoho.getwizarddetails
Provider route: GET /crm/v8/settings/wizards/{id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { ZohoIntegration } from "@alter-ai/zoho";
async function execute(input: Parameters<ZohoIntegration["wizards"]["getWizardDetails"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.wizards.getWizardDetails(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_zoho import ZohoIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.wizards.get_wizard_details(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.id | string | Required within parent | Numeric unique identifier of the wizard. Format: int64 |
query | object | Required within parent | Additional keys: not allowed |
query.layout_id | string | Required within parent | Numeric unique identifier of the layout. Format: int64 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents the response body containing the wizard configuration for the requested identifier. Additional keys: not allowed |
$ (anyOf 1).wizards | array | Required within parent | Represents the list of wizards in the response. For this operation, the array contains exactly one wizard object corresponding to the requested identifier. Maximum items: 1 |
$ (anyOf 1).wizards[] | object | Each item | Represents a wizard object containing its complete configuration, including its associated module, active status, and the containers that define the multi-step screen flow. Additional keys: not allowed |
$ (anyOf 1).wizards[].active | boolean | Required within parent | Indicates whether the wizard is currently active. Possible values: true - The wizard is active and available for use in the CRM module. false - The wizard is inactive and not available for use. |
$ (anyOf 1).wizards[].containers | array | Required within parent | Represents the list of containers associated with the wizard. Each container links a specific layout to the screens and segments that define the wizard flow for that layout. Maximum items: 7 |
$ (anyOf 1).wizards[].containers[] | object | Each item | Represents a container that associates a CRM layout with its corresponding screens and chart definition, establishing the navigation structure for one segment of the wizard flow. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].chart_data | object | Required within parent | Represents the metadata that describes the visual flow between screens in the wizard canvas, including the color palette applied to the canvas and the connections between screens. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].chart_data.color_palette | object | Optional | Represents the color palette applied to the wizard canvas, defining the colors used for visual elements such as button backgrounds. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].chart_data.color_palette.button_background | array | Optional | Represents the list of hex color values applied to button backgrounds in the wizard canvas. Maximum items: 10 |
$ (anyOf 1).wizards[].containers[].chart_data.color_palette.button_background[] | string | Each item | Represents a hex color code that defines a button background color in the wizard canvas (for example, ‘#FFFFFF’). Maximum length: 7 |
$ (anyOf 1).wizards[].containers[].chart_data.connections | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].chart_data.connections (anyOf 1) | array | Alternative | Represents the list of connections between source and target screens that define the navigation flow within the wizard. Maximum items: 75 |
$ (anyOf 1).wizards[].containers[].chart_data.connections (anyOf 1)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item containers item chart data connections null item |
$ (anyOf 1).wizards[].containers[].chart_data.connections (anyOf 2) | null | Alternative | Represents the list of connections between source and target screens that define the navigation flow within the wizard. Maximum items: 75 |
$ (anyOf 1).wizards[].containers[].chart_data.connections (anyOf 2)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item containers item chart data connections null item |
$ (anyOf 1).wizards[].containers[].chart_data.nodes | array | Required within parent | Represents the list of visual nodes on the wizard canvas, where each node corresponds to a screen in the wizard flow. Maximum items: 75 |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[] | object | Each item | Represents a single visual node on the wizard canvas, corresponding to a screen in the wizard flow and capturing its position and identity within the chart layout. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].pos_x | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].pos_x (anyOf 1) | integer | Alternative | Represents the X-coordinate position, in pixels, of the node on the wizard canvas. Format: int32 |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].pos_x (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].pos_y | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].pos_y (anyOf 1) | integer | Alternative | Represents the Y-coordinate position, in pixels, of the node on the wizard canvas. Format: int32 |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].pos_y (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].screen | object | Required within parent | Represents the wizard screen associated with this node in the flow chart. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].screen.display_label | string | Required within parent | Represents the display label of the screen associated with the node. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].screen.id | string | Required within parent | Represents the unique identifier of the screen associated with the node. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].chart_data.nodes[].start_node | boolean | Required within parent | Indicates whether this node is the starting screen in the wizard flow. Possible values: true - The node is the starting screen of the wizard flow. false - The node is not the starting screen of the wizard flow. |
$ (anyOf 1).wizards[].containers[].id | string | Required within parent | Represents the unique identifier of the container layout. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].layout | object | Required within parent | Represents the layout from which wizard fields are sourced for this container. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].layout.display_label | string | Required within parent | Represents the display label of the layout, translated into the user’s locale where available. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].layout.id | string | Required within parent | Represents the unique identifier of the layout. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) endpoint for details. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].layout.name | string | Required within parent | Represents the name of the layout associated with the wizard container. Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens | array | Required within parent | Represents the list of screens included in the wizard container. Each screen groups one or more segments presented to the user during the wizard flow. Maximum items: 75 |
$ (anyOf 1).wizards[].containers[].screens[] | object | Each item | Represents a screen definition within the wizard container that organizes segments and governs the data-entry step presented to the user. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].api_name | string | Required within parent | Represents the API name of the screen within the wizard container. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].conditional_rules | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].conditional_rules (anyOf 1) | array | Alternative | Represents the list of conditional rules evaluated on the screen. Returns null when no conditional rules are configured for the screen. Maximum items: 50 |
$ (anyOf 1).wizards[].containers[].screens[].conditional_rules (anyOf 1)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item |
$ (anyOf 1).wizards[].containers[].screens[].conditional_rules (anyOf 2) | null | Alternative | Represents the list of conditional rules evaluated on the screen. Returns null when no conditional rules are configured for the screen. Maximum items: 50 |
$ (anyOf 1).wizards[].containers[].screens[].conditional_rules (anyOf 2)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item |
$ (anyOf 1).wizards[].containers[].screens[].display_label | string | Required within parent | Display label of the screen. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].id | string | Required within parent | Numeric unique identifier of the screen. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments | array | Required within parent | Represents the segments that group fields, buttons, and other elements displayed on the screen. Maximum items: 75 |
$ (anyOf 1).wizards[].containers[].screens[].segments[] | object | Each item | Represents a segment contained within a screen, grouping related fields, buttons, and other interface elements. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons | array | Optional | Represents the buttons displayed inside this segment. Present for segments of the buttons type. Maximum items: 50 Minimum items: 1 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[] | object | Each item | Represents a button configuration entry within the segment, defining the button behavior and presentation. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].background_color | string | Required within parent | Represents the background color of the button, typically expressed as a hexadecimal color value. Maximum length: 7 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].category | string | Required within parent | Represents the category of the button, used to classify or group the button by its functional purpose. Known values: wizard_button, custom_button |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].color | string | Required within parent | Represents the text color of the button, typically expressed as a hexadecimal color value. Maximum length: 7 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 1) | object | Alternative | Represents the criteria controlling the visibility or behavior of the button, defining the conditions under which the button is active or displayed. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 1).comparator | string | Optional | Represents the comparator used in the criteria to evaluate the relationship between the field and the value. Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 1).field | object | Optional | Represents the field against which the criteria is evaluated when determining the visibility or behavior of the button. Additional keys: allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 1).type | string | Optional | Represents the type of criteria applied to the button, indicating the nature of the condition being evaluated. Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 1).value | string | Optional | Represents the value used in the comparison when evaluating the criteria associated with the button. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 2) | null | Alternative | Represents the criteria controlling the visibility or behavior of the button, defining the conditions under which the button is active or displayed. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 2).comparator | string | Optional | Represents the comparator used in the criteria to evaluate the relationship between the field and the value. Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 2).field | object | Optional | Represents the field against which the criteria is evaluated when determining the visibility or behavior of the button. Additional keys: allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 2).type | string | Optional | Represents the type of criteria applied to the button, indicating the nature of the condition being evaluated. Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].criteria (anyOf 2).value | string | Optional | Represents the value used in the comparison when evaluating the criteria associated with the button. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].display_label | string | Required within parent | Represents the display label of the button, shown to the user as the visible text or title of the button. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].id | string | Required within parent | Represents the unique identifier of the button. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].message | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].message (anyOf 1) | object | Alternative | Represents the message configuration used when this button performs a save or summary action. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].message (anyOf 1).content | string | Optional | Body content of the acknowledgement message. Maximum length: 2000 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].message (anyOf 1).title | string | Optional | Title of the acknowledgement message. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].message (anyOf 2) | null | Alternative | Represents the message configuration used when this button performs a save or summary action. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].message (anyOf 2).content | string | Optional | Body content of the acknowledgement message. Maximum length: 2000 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].message (anyOf 2).title | string | Optional | Title of the acknowledgement message. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].name | string | Required within parent | Represents the name of the button. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 1) | array | Alternative | Represents the profiles for which this button is available. Maximum items: 40 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 1)[] | object | Each item | Profile associated with this button Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 1)[].display_label | string | Optional | Display label of the profile. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 1)[].id | string | Optional | Represents the unique identifier of the profile. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 1)[].name | string | Optional | Internal name of the profile. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 2) | null | Alternative | Represents the profiles for which this button is available. Maximum items: 40 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 2)[] | object | Each item | Profile associated with this button Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 2)[].display_label | string | Optional | Display label of the profile. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 2)[].id | string | Optional | Represents the unique identifier of the profile. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].profiles (anyOf 2)[].name | string | Optional | Internal name of the profile. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].resource | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].resource (anyOf 1) | object | Alternative | Resource associated with the button, if any. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].resource (anyOf 1).id | string | Optional | Represents the unique numeric identifier of the resource associated with the button. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].resource (anyOf 1).name | string | Optional | Represents the name of the resource associated with the button. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].resource (anyOf 2) | null | Alternative | Resource associated with the button, if any. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].resource (anyOf 2).id | string | Optional | Represents the unique numeric identifier of the resource associated with the button. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].resource (anyOf 2).name | string | Optional | Represents the name of the resource associated with the button. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].sequence_number | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].sequence_number (anyOf 1) | integer | Alternative | Represents the sequential position of the button within its parent segment, determining the display order. Format: int32 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].shape | string | Required within parent | Represents the visual shape of the button as rendered in the wizard interface. Known values: square, capsule, round |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].show_summary_on | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].show_summary_on (anyOf 1) | string | Alternative | Indicates the condition or event upon which a summary screen is displayed, when a summary screen is configured for the button. Known values: create, edit, create_and_edit Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].show_summary_on (anyOf 2) | null | Alternative | Indicates the condition or event upon which a summary screen is displayed, when a summary screen is configured for the button. Known values: create, edit, create_and_edit Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].target_screen | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].target_screen (anyOf 1) | object | Alternative | Represents the screen to which the wizard navigates when this button is activated. Returns null for buttons that perform a save operation without navigation. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].target_screen (anyOf 1).id | string | Required within parent | Represents the unique numeric identifier of the target screen to which the button navigates. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].target_screen (anyOf 1).name | string | Required within parent | Represents the name of the target screen to which the button navigates. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].target_screen (anyOf 2) | null | Alternative | Represents the screen to which the wizard navigates when this button is activated. Returns null for buttons that perform a save operation without navigation. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].target_screen (anyOf 2).id | string | Required within parent | Represents the unique numeric identifier of the target screen to which the button navigates. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].target_screen (anyOf 2).name | string | Required within parent | Represents the name of the target screen to which the button navigates. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].transition | JSON | Optional | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].transition (anyOf 1) | object | Alternative | Represents the automation transition configuration applied when this button is activated. Returns null when no transition is configured. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].transition (anyOf 1).id | string | Optional | Represents the unique numeric identifier of the automation transition associated with the button. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].transition (anyOf 2) | null | Alternative | Represents the automation transition configuration applied when this button is activated. Returns null when no transition is configured. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].transition (anyOf 2).id | string | Optional | Represents the unique numeric identifier of the automation transition associated with the button. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].type | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].type (anyOf 1) | string | Alternative | Represents the type of action performed by the button within the wizard segment. Known values: save, transition |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].type (anyOf 2) | null | Alternative | Represents the type of action performed by the button within the wizard segment. Known values: save, transition |
$ (anyOf 1).wizards[].containers[].screens[].segments[].buttons[].visibility | string | Required within parent | Indicates the visibility behavior of the button, controlling whether the button is displayed or hidden within the wizard segment. Known values: hide, disable, show |
$ (anyOf 1).wizards[].containers[].screens[].segments[].column_count | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].column_count (anyOf 1) | integer | Alternative | Represents the number of columns used to arrange elements within the segment layout. Format: int32 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].column_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).wizards[].containers[].screens[].segments[].content | string | Optional | Represents the static content of the segment, applicable to segments of the text_label type. Maximum length: 2000 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].display_label | string | Required within parent | Display label of the segment. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements | array | Optional | Represents the collection of field elements contained within the segment, present when the segment is of a composite type. Maximum items: 200 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[] | object | Each item | Represents an individual field element contained within a segment. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[].resource | object | Required within parent | Represents the field resource referenced by this element, linking the element to its associated data field definition. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[].resource.id | string | Required within parent | Represents the unique identifier of the field resource associated with this element. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[].resource.name | string | Required within parent | Represents the API name of the field resource associated with this element. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[].sequence_number | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[].sequence_number (anyOf 1) | integer | Alternative | Represents the position of the element within the segment, determining the display order. Format: int32 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[].sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).wizards[].containers[].screens[].segments[].elements[].type | string | Required within parent | Represents the type of element within the segment, for example ‘field’. Known values: field, query_component Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].id | string | Required within parent | Represents the unique identifier of the segment. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].name | string | Optional | Represents the name of the segment. Present for text_label and buttons segments. Maximum length: 255 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].sequence_number | JSON | Required within parent | |
$ (anyOf 1).wizards[].containers[].screens[].segments[].sequence_number (anyOf 1) | integer | Alternative | Represents the sequential position of the segment within the screen, determining its display order. Format: int32 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 1).wizards[].containers[].screens[].segments[].tab_traversal | string | Optional | Represents the traversal order for elements within the segment, used for keyboard navigation. Known values: left_to_right, top_to_bottom |
$ (anyOf 1).wizards[].containers[].screens[].segments[].type | string | Required within parent | Represents the type of the segment, for example ‘composite’, ‘text_label’, or ‘buttons’. Known values: composite, fields, subforms, text_label, widget, buttons Maximum length: 50 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].widget | object | Optional | Represents the widget resource linked to this segment. Required when the segment type is ‘widget’. Additional keys: not allowed |
$ (anyOf 1).wizards[].containers[].screens[].segments[].widget.id | string | Required within parent | Represents the unique identifier of the widget linked to the segment. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].containers[].screens[].segments[].widget.name | string | Optional | Represents the name of the widget linked to the segment. Maximum length: 255 |
$ (anyOf 1).wizards[].created_by | JSON | Required within parent | |
$ (anyOf 1).wizards[].created_by (anyOf 1) | object | Alternative | Represents the user who created the wizard. Additional keys: not allowed |
$ (anyOf 1).wizards[].created_by (anyOf 1).id | string | Required within parent | Represents the unique identifier of the user who created the wizard. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].created_by (anyOf 1).name | string | Required within parent | Name of the user who created the wizard. Maximum length: 255 |
$ (anyOf 1).wizards[].created_by (anyOf 2) | null | Alternative | Represents the user who created the wizard. Additional keys: not allowed |
$ (anyOf 1).wizards[].created_by (anyOf 2).id | string | Required within parent | Represents the unique identifier of the user who created the wizard. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].created_by (anyOf 2).name | string | Required within parent | Name of the user who created the wizard. Maximum length: 255 |
$ (anyOf 1).wizards[].created_time | string | Required within parent | Represents the timestamp when Zoho CRM created the wizard. Format: date-time |
$ (anyOf 1).wizards[].display_label | string | Required within parent | Represents the display label of the wizard, translated into the available locale where applicable. Maximum length: 255 |
$ (anyOf 1).wizards[].id | string | Required within parent | Represents the unique identifier of the wizard. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].modified_by | JSON | Required within parent | |
$ (anyOf 1).wizards[].modified_by (anyOf 1) | object | Alternative | Represents the user who last modified the wizard. Additional keys: not allowed |
$ (anyOf 1).wizards[].modified_by (anyOf 1).id | string | Required within parent | Represents the unique identifier of the user who last modified the wizard. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].modified_by (anyOf 1).name | string | Required within parent | Name of the user who last modified the wizard. Maximum length: 255 |
$ (anyOf 1).wizards[].modified_by (anyOf 2) | null | Alternative | Represents the user who last modified the wizard. Additional keys: not allowed |
$ (anyOf 1).wizards[].modified_by (anyOf 2).id | string | Required within parent | Represents the unique identifier of the user who last modified the wizard. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].modified_by (anyOf 2).name | string | Required within parent | Name of the user who last modified the wizard. Maximum length: 255 |
$ (anyOf 1).wizards[].modified_time | string | Required within parent | Represents the timestamp when Zoho CRM last modified the wizard. Format: date-time |
$ (anyOf 1).wizards[].module | object | Required within parent | Represents the Zoho CRM module associated with the wizard. Additional keys: not allowed |
$ (anyOf 1).wizards[].module.api_name | string | Required within parent | Represents the API name of the Zoho CRM module associated with the wizard. Maximum length: 50 |
$ (anyOf 1).wizards[].module.id | string | Required within parent | Represents the unique identifier of the Zoho CRM module associated with the wizard. Format: int64 Maximum length: 19 |
$ (anyOf 1).wizards[].name | string | Required within parent | Represents the API name of the wizard. Maximum length: 30 |
$ (anyOf 1).wizards[].portal_user_types | JSON | Required within parent | |
$ (anyOf 1).wizards[].portal_user_types (anyOf 1) | array | Alternative | Represents the client portal user types for which the wizard is available. Maximum items: 50 |
$ (anyOf 1).wizards[].portal_user_types (anyOf 1)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item portal user types null item |
$ (anyOf 1).wizards[].portal_user_types (anyOf 2) | null | Alternative | Represents the client portal user types for which the wizard is available. Maximum items: 50 |
$ (anyOf 1).wizards[].portal_user_types (anyOf 2)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item portal user types null item |
$ (anyOf 1).wizards[].profiles | JSON | Required within parent | |
$ (anyOf 1).wizards[].profiles (anyOf 1) | array | Alternative | Represents the Zoho CRM profiles for which the wizard is available. Maximum items: 50 |
$ (anyOf 1).wizards[].profiles (anyOf 1)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item profiles null item |
$ (anyOf 1).wizards[].profiles (anyOf 2) | null | Alternative | Represents the Zoho CRM profiles for which the wizard is available. Maximum items: 50 |
$ (anyOf 1).wizards[].profiles (anyOf 2)[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item profiles null item |
$ (anyOf 1).wizards[].source | string | Optional | Indicates the source that originated the wizard. Known values: crm, platform_plugin, marketplace_plugin Maximum length: 50 |
$ (anyOf 2) | null | Alternative |
Referenced models: Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item, Get wizard details — response body — wizards wizards item containers item chart data connections null item, Get wizard details — response body — wizards wizards item portal user types null item, Get wizard details — response body — wizards wizards item profiles null item
Schemas
Section titled “Schemas”6 more schemas are linked from the tables above, on the schema pages.
Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a conditional rule configured for the screen, defining the criteria and the corresponding actions to execute when the criteria are satisfied. Additional keys: not allowed |
actions | array | Required within parent | Represents the list of actions executed when the conditional rule criteria are satisfied on the screen. Maximum items: 50 |
actions[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item |
criteria | JSON | Optional | |
criteria (anyOf 1) | Model | Alternative | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item criteria comparator, field, type, value — shared_criteria_011cb20e54f0 |
criteria (anyOf 2) | Model | Alternative | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item criteria comparator, field, type, value — shared_criteria_9c4b33ef7c31 |
execute_on | string | Required within parent | Represents the event on which the conditional rule executes, for example 'create_edit'. Known values: create_edit, create, edit Maximum length: 50 |
query_id | string | Required within parent | Represents the unique numeric identifier of the conditional rule. Format: int64 Maximum length: 19 |
Referenced models: Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item, Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item criteria comparator, field, type, value — shared_criteria_011cb20e54f0, Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item criteria comparator, field, type, value — shared_criteria_9c4b33ef7c31
Get wizard details — response body — wizards wizards item containers item chart data connections null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single directed connection in the wizard flow, linking a source screen to a target screen to define the transition path between them. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the connection between the source screen and the target screen in the wizard flow. Format: int64 Maximum length: 19 |
source_screen | Model | Required within parent | Expand Get wizard details — response body — wizards wizards item containers item chart data connections null item source screen |
target_screen | Model | Required within parent | Expand Get wizard details — response body — wizards wizards item containers item chart data connections null item target screen |
Referenced models: Get wizard details — response body — wizards wizards item containers item chart data connections null item source screen, Get wizard details — response body — wizards wizards item containers item chart data connections null item target screen
Get wizard details — response body — wizards wizards item portal user types null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Portal user type associated with this wizard. Additional keys: not allowed |
display_label | string | Required within parent | Represents the display label of the portal user type. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the portal user type. Format: int64 Maximum length: 19 |
name | string | Required within parent | Represents the name of the portal user type. Maximum length: 255 |
Get wizard details — response body — wizards wizards item profiles null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a CRM profile associated with the wizard. Additional keys: not allowed |
display_label | string | Required within parent | Represents the display label of the profile, translated into the available locale where applicable. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the profile. Format: int64 Maximum length: 19 |
name | string | Required within parent | Name of the profile. Maximum length: 255 |
Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents an action configuration that is executed when the associated conditional rule criteria are met on the screen. Additional keys: not allowed |
exempted_portal_user_types | array | Optional | Represents the list of client portal user types that are exempted from the conditional rule action on the screen. Maximum items: 500 |
exempted_portal_user_types[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item exempted portal user types item |
exempted_profiles | array | Optional | Represents the list of CRM profiles that are exempted from the conditional rule action and will not have the action applied to them. Maximum items: 500 |
exempted_profiles[] | Model | Each item | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item exempted profiles item |
field | Model | Optional | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item field |
id | string | Required within parent | Represents the unique numeric identifier of the conditional rule action. Format: int64 Maximum length: 19 |
segment | Model | Optional | Expand Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item segment |
type | string | Required within parent | Indicates the type of action to perform on the targeted field or segment. Possible values include set_mandatory, make_read_only, hide, and show. Maximum length: 50 |
value | string | Optional | Represents the value applied to the field by the action. Present only for field-value actions. Maximum length: 2000 |
Referenced models: Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item exempted portal user types item, Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item exempted profiles item, Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item field, Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item segment
Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item criteria comparator, field, type, value — shared_criteria_011cb20e54f0
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the criteria expression evaluated to determine whether the conditional rule actions are triggered. Additional keys: not allowed |
comparator | string | Required within parent | Indicates the comparator used to evaluate the criteria expression. Possible values include not_equal, equal, is_empty, and is_not_empty. Maximum length: 50 |
field | object | Required within parent | Represents the field against which the criteria expression is evaluated. Additional keys: not allowed |
field.api_name | string | Required within parent | Represents the API name of the field used in the criteria expression. Maximum length: 255 |
field.id | string | Required within parent | Represents the unique identifier of the field used in the criteria expression. Format: int64 Maximum length: 19 |
type | string | Required within parent | Represents the type of the criteria applied in the conditional rule evaluation, for example 'value'. Maximum length: 50 |
value | string | Required within parent | Represents the value used in the criteria comparison during conditional rule evaluation, for example ''. Maximum length: 255 |
Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item criteria comparator, field, type, value — shared_criteria_9c4b33ef7c31
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | null | Root | Represents the criteria expression evaluated to determine whether the conditional rule actions are triggered. Additional keys: not allowed |
comparator | string | Required within parent | Indicates the comparator used to evaluate the criteria expression. Possible values include not_equal, equal, is_empty, and is_not_empty. Maximum length: 50 |
field | object | Required within parent | Represents the field against which the criteria expression is evaluated. Additional keys: not allowed |
field.api_name | string | Required within parent | Represents the API name of the field used in the criteria expression. Maximum length: 255 |
field.id | string | Required within parent | Represents the unique identifier of the field used in the criteria expression. Format: int64 Maximum length: 19 |
type | string | Required within parent | Represents the type of the criteria applied in the conditional rule evaluation, for example 'value'. Maximum length: 50 |
value | string | Required within parent | Represents the value used in the criteria comparison during conditional rule evaluation, for example ''. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getwizarddetails. Catalog operation: getWizardDetails. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
No-content response statuses: [204]