Fields
display_name
String!Required
User-friendly version of the geographical data, which may be more descriptive or formatted differently.
edit
BooleanSpecifies if the field can be edited by the user.
error_text
StringThe message shown to the user if the input does not meet the validation criteria.
input
StringDefines the type of input control used for the field (e.g., textbox).
required
BooleanIndicates whether the field is mandatory for the user to fill out.
slug
String!Required
Unique field identifier for address field. e.g., 'landmark' for landmark field; stays the same even if display_name changes.
validation
FieldValidationDetails any validation rules applied to the field, such as regex patterns.
Provides predefined values or options for the field, if applicable.
next
StringIndicates the next field to fetch in the address entry sequence. This is for dependent fields eg if city is selected then next field will be state.
Was this section helpful?