Zoho: Pick list values schemas
14 Zoho schemas with complete fields and constraints.
← Pick list values operations · All schemas
Delete a picklist field option — response body — pick list values pick list values item — Direct Picklist Option Deletion Result
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a direct (non-scheduled) deletion result for a picklist option, including status, code, message, and deleted option ID. Additional keys: not allowed |
code | string | Required within parent | Picklist option deletion result code Known values: SUCCESS |
details | object | Required within parent | Details of the deleted picklist option Additional keys: not allowed |
details.id | string | Required within parent | The unique ID of the deleted picklist option Format: int64 Maximum length: 100 Minimum length: 13 |
message | string | Required within parent | Picklist option deletion message Known values: PickList Option deleted successfully |
status | string | Required within parent | Picklist option deletion status Known values: success Maximum length: 7 Minimum length: 5 |
Delete a picklist field option — response body — pick list values pick list values item — Picklist Option Deletion Result
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the scheduled deletion outcome for a picklist option, including status, code, message, and async job details. Additional keys: not allowed |
code | string | Required within parent | picklist option deletion code Known values: SCHEDULED |
details | Model | Required within parent | Expand Replace Pick list values — response body — replace pick list values item details |
message | string | Required within parent | Picklist option deletion message Known values: Picklist Option deletion scheduled successfully |
status | string | Required within parent | Picklist option deletion status Known values: success Maximum length: 7 Minimum length: 5 |
Referenced models: Replace Pick list values — response body — replace pick list values item details
Delete a picklist field option — response body — pick list values — Direct Picklist Option Deletion Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Success response indicating picklist option has been deleted directly. Returns an array of deletion results. Additional keys: not allowed |
pick_list_values | array | Required within parent | pick list values Maximum items: 1 Minimum items: 0 |
pick_list_values[] | Model | Each item | Expand Delete a picklist field option — response body — pick list values pick list values item — Direct Picklist Option Deletion Result |
Referenced models: Delete a picklist field option — response body — pick list values pick list values item — Direct Picklist Option Deletion Result
Delete a picklist field option — response body — pick list values — Picklist Option Deletion Response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Accepted response indicating picklist option deletion has been scheduled. Returns an array of deletion results. Additional keys: not allowed |
pick_list_values | array | Required within parent | pick list values Maximum items: 1 Minimum items: 0 |
pick_list_values[] | Model | Each item | Expand Delete a picklist field option — response body — pick list values pick list values item — Picklist Option Deletion Result |
Referenced models: Delete a picklist field option — response body — pick list values pick list values item — Picklist Option Deletion Result
Replace Pick list values — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container for the replace_pick_list_values array, listing one or more instructions to perform picklist value replacements. Additional keys: not allowed |
replace_pick_list_values | array | Required within parent | Replace picklist value with from and to options (Required) Maximum items: 1 Minimum items: 1 |
replace_pick_list_values[] | Model | Each item | Expand Replace Pick list values — request body — body replace pick list values item |
Referenced models: Replace Pick list values — request body — body replace pick list values item
Replace Pick list values — request body — body replace pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A structured instruction that pairs a source and target picklist option, with an option to delete the source after replacement. Additional keys: not allowed |
delete_old_value | boolean or null | Optional | Boolean value to delete the old_value along with replace |
new_value | Model | Required within parent | Expand Replace Pick list values — request body — body replace pick list values item new value The option to be replaced with the option (Required) |
old_value | Model | Required within parent | Expand Replace Pick list values — request body — body replace pick list values item old value The option which is to be replaced (Required) |
Referenced models: Replace Pick list values — request body — body replace pick list values item old value, Replace Pick list values — request body — body replace pick list values item new value
Replace Pick list values — request body — body replace pick list values item new value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the picklist option that will act as the replacement, providing the display value and unique identifier. At least one of id or display_value must be provided. Additional keys: not allowed |
display_value | string or null | Optional | Display value of the option Maximum length: 120 |
id | string or null | Optional | The option id (Unique) Format: int64 Maximum length: 20 Minimum length: 13 |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 2) | JSON | Alternative |
Replace Pick list values — request body — body replace pick list values item old value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the picklist option to be replaced, providing the display value and unique identifier. At least one of id or display_value must be provided. Additional keys: not allowed |
display_value | string or null | Optional | Specify the display value of the option to be replaced Maximum length: 120 |
id | string or null | Optional | Specify the option id which is to be replaced (Unique) Format: int64 Maximum length: 20 Minimum length: 13 |
$ (anyOf 1) | JSON | Alternative | |
$ (anyOf 2) | JSON | Alternative |
Replace Pick list values — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Accepted response indicating picklist replace operations have been scheduled. Returns an array of scheduling results. Additional keys: not allowed |
replace_pick_list_values | array | Required within parent | Description of the replace option on schedule Maximum items: 1 Minimum items: 1 |
replace_pick_list_values[] | Model | Each item | Expand Replace Pick list values — response body — replace pick list values item |
Referenced models: Replace Pick list values — response body — replace pick list values item
Replace Pick list values — response body — replace pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result entry for a scheduled replace operation, including status, code, message, and asynchronous job details. Additional keys: not allowed |
code | string | Required within parent | Code of the scheduler response Known values: SCHEDULED |
details | Model | Required within parent | Expand Replace Pick list values — response body — replace pick list values item details |
message | string | Required within parent | Message of the scheduled details Known values: Picklist option replace operation scheduled successfully |
status | string | Required within parent | status on replace operation of the scheduler Known values: success Maximum length: 7 Minimum length: 5 |
Referenced models: Replace Pick list values — response body — replace pick list values item details
Replace Pick list values — response body — replace pick list values item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the scheduler job identifier for an asynchronous operation that was accepted for processing. Additional keys: not allowed |
job_id | string | Required within parent | scheduler jobid Format: int64 Maximum length: 20 Minimum length: 13 |
get a picklist field option — response body — pick list values
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Successful response containing the list of picklist options that match the specified pick list value ID for the given field. Additional keys: not allowed |
pick_list_values | array | Required within parent | PickList option of the mention picklist unique Id Maximum items: 1 Minimum items: 1 |
pick_list_values[] | Model | Each item | Expand get a picklist field option — response body — pick list values pick list values item |
Referenced models: get a picklist field option — response body — pick list values pick list values item
get a picklist field option — response body — pick list values pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Full metadata for a picklist option, including unique ID, actual/reference/display values, sequence order, usage type (used/unused), optional color code, and associated layouts. Additional keys: not allowed |
actual_value | string | Required within parent | Actual value of the picklist option. Maximum length: 120 |
colour_code | JSON | Required within parent | |
colour_code (anyOf 1) | string | Alternative | Color code of the picklist option when the picklist field in color code enabled Maximum length: 9 |
colour_code (anyOf 2) | null | Alternative | Color code of the picklist option when the picklist field in color code enabled Maximum length: 9 |
display_value | string | Required within parent | Display value of the picklist option which are localised or translated Maximum length: 120 |
id | string | Required within parent | Unique Id of the picklist option Format: int64 |
layout_associations | JSON | Required within parent | |
layout_associations (anyOf 1) | array | Alternative | Layout Association of the picklist option Maximum items: 6 Minimum items: 0 |
layout_associations (anyOf 1)[] | Model | Each item | Expand get a picklist field option — response body — pick list values pick list values item layout associations Layout Association of the picklist option item |
layout_associations (anyOf 2) | null | Alternative | Layout Association of the picklist option Maximum items: 6 Minimum items: 0 |
layout_associations (anyOf 2)[] | Model | Each item | Expand get a picklist field option — response body — pick list values pick list values item layout associations Layout Association of the picklist option item |
reference_value | string | Required within parent | Reference value of the picklist option which are localised or updated Maximum length: 120 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | sort order of the option respective to field Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | Presence of the option in layouts and in the module Known values: used, unused |
Referenced models: get a picklist field option — response body — pick list values pick list values item layout associations Layout Association of the picklist option item
get a picklist field option — response body — pick list values pick list values item layout associations Layout Association of the picklist option item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifies a layout where the picklist option is available, including the layout API name, display name, and unique association ID. Additional keys: not allowed |
api_name | string | Required within parent | Api Name of the layout Maximum length: 255 |
id | string | Required within parent | Unique Id of the picklist option Format: int64 |
name | string | Required within parent | Name of the layout Maximum length: 255 |