Skip to content

katana_public_api_client.models.custom_field_options

katana_public_api_client.models.custom_field_options

Classes

CustomFieldOptions

Keys you omit keep their current value, so send only what you are changing. null clears the whole object (rejected on a singleSelect, which must always keep its choices).

choices is only meaningful when the field is a singleSelect, and is the exception to the merge rule: send the full array, every existing choice included and identified by its server-assigned id. Omit a choice and it is removed from history — use deleted: true instead to soft-delete it and keep historical values resolvable. New choices are sent without an id.

Example:
    {'choices': [{'id': 1, 'label': 'Online'}, {'id': 2, 'label': 'Retail'}, {'id': 3, 'label': 'Wholesale'}]}