Zoho: Wizards schemas

← Wizards operations · All schemas

Get all wizard configurations — response body — wizards wizards item portal user types null item

Field	Type	Presence	Description and constraints
$	object	Root	Client portal associated with the wizard. Additional keys: not allowed
display_label	string	Required within parent	Represents the display label of the client portal, translated into the user's language where a translation is available. Maximum length: 255
id	string	Required within parent	Represents the unique numeric identifier of the client portal user type. Format: int64 Maximum length: 19
name	string	Required within parent	Internal name of the client portal. Maximum length: 255

Get all wizard configurations — 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	Optional	Represents the display label of the profile, translated into the user's language where a translation is available. Maximum length: 255
id	string	Required within parent	Numeric 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 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 containers item chart data connections null item source screen

Field	Type	Presence	Description and constraints
$	object	Root	Represents the screen from which the connection originates in the wizard flow, identifying the starting point of the transition. Additional keys: not allowed
display_label	string	Required within parent	Represents the display label of the source screen as it appears in the wizard canvas. Maximum length: 255
id	string	Required within parent	Represents the unique identifier of the source screen from which the connection originates. Format: int64 Maximum length: 19

Get wizard details — response body — wizards wizards item containers item chart data connections null item target screen

Field	Type	Presence	Description and constraints
$	object	Root	Represents the screen to which the connection points in the wizard flow, identifying the destination of the transition. Additional keys: not allowed
display_label	string	Required within parent	Represents the display label of the target screen as it appears in the wizard canvas. Maximum length: 255
id	string	Required within parent	Represents the unique identifier of the target screen to which the connection points. Format: int64 Maximum length: 19

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 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 actions item exempted portal user types item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a client portal user type that is exempted from the conditional rule action on the screen. Additional keys: not allowed
id	string	Optional	Represents the unique numeric identifier of the portal user type that is exempted from the conditional rule action. Format: int64 Maximum length: 19
name	string	Optional	Represents the display name of the portal user type that is exempted from the conditional rule action. Maximum length: 255

Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item exempted profiles item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM profile that is exempted from the conditional rule action and will not have the action applied to it. Additional keys: not allowed
id	string	Optional	Represents the unique numeric identifier of the CRM profile that is exempted from the conditional rule action. Format: int64 Maximum length: 19
name	string	Optional	Represents the display name of the CRM profile that is exempted from the conditional rule action. Maximum length: 255

Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the wizard screen field to which the conditional rule action is applied. This object is present only for field-targeting action types. Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the wizard screen field on which the conditional rule action is executed. Maximum length: 255
id	string	Required within parent	Represents the unique numeric identifier of the wizard screen field on which the conditional rule action is executed. Format: int64 Maximum length: 19

Get wizard details — response body — wizards wizards item containers item screens item conditional rules null item actions item segment

Field	Type	Presence	Description and constraints
$	object	Root	Represents the segment on which the action is applied. Present only for segment-targeting actions. Additional keys: not allowed
display_label	string	Optional	Represents the display label of the segment on which the action is executed. Maximum length: 255
id	string	Required within parent	Represents the unique identifier of the segment on which the action is executed. Format: int64 Maximum length: 19

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

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