Interface UpdateFieldRequest

interface UpdateFieldRequest {
    addToForms?: boolean;
    appearsByDefault?: boolean;
    audited?: boolean;
    bold?: boolean;
    fieldHelp?: string;
    findEnabled?: boolean;
    label?: string;
    noWrap?: boolean;
    permissions?: { permissionType?: string; role?: string; roleId?: number }[];
    properties?: {
        abbreviate?: boolean;
        allowMentions?: boolean;
        allowNewChoices?: boolean;
        appearsAs?: string;
        appendOnly?: boolean;
        autoSave?: boolean;
        blankIsZero?: boolean;
        carryChoices?: boolean;
        choices?: string[];
        commaStart?: number;
        comments?: string;
        compositeFields?: (number | Record<string, unknown>)[];
        coverText?: string;
        currencyFormat?: "left" | "right" | "middle";
        currencySymbol?: string;
        decimalPlaces?: number;
        defaultCountryCode?: string;
        defaultDomain?: string;
        defaultKind?: string;
        defaultToday?: boolean;
        defaultValue?: string;
        defaultValueLuid?: number;
        displayAsLink?: boolean;
        displayCheckboxAsText?: boolean;
        displayDayOfWeek?: boolean;
        displayEmail?: string;
        displayMonth?: string;
        displayRelative?: boolean;
        displayTime?: boolean;
        displayTimezone?: boolean;
        displayUser?: string;
        doesAverage?: boolean;
        doesTotal?: boolean;
        exact?: boolean;
        format?: number;
        formula?: string;
        hasExtension?: boolean;
        hours24?: boolean;
        linkText?: string;
        lookupReferenceFieldId?: number;
        lookupTargetFieldId?: number;
        maxLength?: number;
        maxVersions?: number;
        numberFormat?: number;
        numLines?: number;
        openTargetIn?: "sameWindow" | "newWindow" | "popup";
        parentFieldId?: number;
        seeVersions?: boolean;
        snapFieldId?: number;
        sortAlpha?: boolean;
        sortAsGiven?: boolean;
        sourceFieldId?: number;
        summaryFunction?:
            | "AVG"
            | "SUM"
            | "MAX"
            | "MIN"
            | "STD-DEV"
            | "COUNT"
            | "COMBINED-TEXT"
            | "COMBINED-USER"
            | "DISTINCT-COUNT";
        summaryQuery?: string;
        summaryReferenceFieldId?: number;
        summaryTableId?: string;
        summaryTargetFieldId?: number;
        targetFieldId?: number;
        targetTableId?: string;
        targetTableName?: string;
        units?: string;
        useI18NFormat?: boolean;
        useNewWindow?: boolean;
        versionMode?: "keepallversions"
        | "keeplastversions";
        width?: number;
    };
    required?: boolean;
    unique?: boolean;
}

Index

Properties

addToForms? appearsByDefault? audited? bold? fieldHelp? findEnabled? label? noWrap? permissions? properties? required? unique?

Properties

`Optional`addToForms

addToForms?: boolean

Whether the field you are adding should appear on forms.

`Optional`appearsByDefault

appearsByDefault?: boolean

Indicates if the field is marked as a default in reports.

`Optional`audited

audited?: boolean

Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under Quickbase Audit Logs.

`Optional`bold

bold?: boolean

Indicates if the field is configured to display in bold in the product.

`Optional`fieldHelp

fieldHelp?: string

The configured help text shown to users within the product.

`Optional`findEnabled

findEnabled?: boolean

Indicates if the field is marked as searchable.

`Optional`label

label?: string

The label (name) of the field.

`Optional`noWrap

noWrap?: boolean

Indicates if the field is configured to not wrap when displayed in the product.

`Optional`permissions

permissions?: { permissionType?: string; role?: string; roleId?: number }[]

Field Permissions for different roles.

Type Declaration

OptionalpermissionType?: string
The permission given to the role for this field
Optionalrole?: string
The role associated with a given permission for the field
OptionalroleId?: number
The Id of the given role

`Optional`properties

properties?: {
    abbreviate?: boolean;
    allowMentions?: boolean;
    allowNewChoices?: boolean;
    appearsAs?: string;
    appendOnly?: boolean;
    autoSave?: boolean;
    blankIsZero?: boolean;
    carryChoices?: boolean;
    choices?: string[];
    commaStart?: number;
    comments?: string;
    compositeFields?: (number | Record<string, unknown>)[];
    coverText?: string;
    currencyFormat?: "left" | "right" | "middle";
    currencySymbol?: string;
    decimalPlaces?: number;
    defaultCountryCode?: string;
    defaultDomain?: string;
    defaultKind?: string;
    defaultToday?: boolean;
    defaultValue?: string;
    defaultValueLuid?: number;
    displayAsLink?: boolean;
    displayCheckboxAsText?: boolean;
    displayDayOfWeek?: boolean;
    displayEmail?: string;
    displayMonth?: string;
    displayRelative?: boolean;
    displayTime?: boolean;
    displayTimezone?: boolean;
    displayUser?: string;
    doesAverage?: boolean;
    doesTotal?: boolean;
    exact?: boolean;
    format?: number;
    formula?: string;
    hasExtension?: boolean;
    hours24?: boolean;
    linkText?: string;
    lookupReferenceFieldId?: number;
    lookupTargetFieldId?: number;
    maxLength?: number;
    maxVersions?: number;
    numberFormat?: number;
    numLines?: number;
    openTargetIn?: "sameWindow" | "newWindow" | "popup";
    parentFieldId?: number;
    seeVersions?: boolean;
    snapFieldId?: number;
    sortAlpha?: boolean;
    sortAsGiven?: boolean;
    sourceFieldId?: number;
    summaryFunction?:
        | "AVG"
        | "SUM"
        | "MAX"
        | "MIN"
        | "STD-DEV"
        | "COUNT"
        | "COMBINED-TEXT"
        | "COMBINED-USER"
        | "DISTINCT-COUNT";
    summaryQuery?: string;
    summaryReferenceFieldId?: number;
    summaryTableId?: string;
    summaryTargetFieldId?: number;
    targetFieldId?: number;
    targetTableId?: string;
    targetTableName?: string;
    units?: string;
    useI18NFormat?: boolean;
    useNewWindow?: boolean;
    versionMode?: "keepallversions"
    | "keeplastversions";
    width?: number;
}

Specific field properties.

Type Declaration

Optionalabbreviate?: boolean
Don't show the URL protocol when showing the URL.
OptionalallowMentions?: boolean
If someone can

Mention
users in the rich text field to generate an email notification.
OptionalallowNewChoices?: boolean
Indicates if users can add new choices to a selection list.
OptionalappearsAs?: string
The link text, if empty, the url will be used as link text.
OptionalappendOnly?: boolean
Whether this field is append only.
OptionalautoSave?: boolean
Whether the link field will auto save.
OptionalblankIsZero?: boolean
Whether a blank value is treated the same as 0 in calculations within the product.
OptionalcarryChoices?: boolean
Whether the field should carry its multiple choice fields when copied.
Optionalchoices?: string[]
An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.
OptionalcommaStart?: number
The number of digits before commas display in the product, when applicable.
Optionalcomments?: string
The comments entered on the field properties by an administrator.
OptionalcompositeFields?: (number | Record<string, unknown>)[]
An array of the fields that make up a composite field (e.g., address).
OptionalcoverText?: string
An alternate user friendly text that can be used to display a link in the browser.
OptionalcurrencyFormat?: "left" | "right" | "middle"
The currency format used when displaying field values within the product.
OptionalcurrencySymbol?: string
The current symbol used when displaying field values within the product.
OptionaldecimalPlaces?: number
The number of decimal places displayed in the product for this field.
OptionaldefaultCountryCode?: string
Controls the default country shown on international phone widgets on forms. Country code should be entered in the ISO 3166-1 alpha-2 format.
OptionaldefaultDomain?: string
Default email domain.
OptionaldefaultKind?: string
The user default type.
OptionaldefaultToday?: boolean
Indicates if the field value is defaulted today for new records.
OptionaldefaultValue?: string
The default value configured for a field when a new record is added.
OptionaldefaultValueLuid?: number
Default user id value.
OptionaldisplayAsLink?: boolean
Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
OptionaldisplayCheckboxAsText?: boolean
Indicates whether the checkbox values will be shown as text in reports.
OptionaldisplayDayOfWeek?: boolean
Indicates whether to display the day of the week within the product.
OptionaldisplayEmail?: string
How the email is displayed.
OptionaldisplayMonth?: string
How to display months.
OptionaldisplayRelative?: boolean
Whether to display time as relative.
OptionaldisplayTime?: boolean
Indicates whether to display the time, in addition to the date.
OptionaldisplayTimezone?: boolean
Indicates whether to display the timezone within the product.
OptionaldisplayUser?: string
The configured option for how users display within the product.
OptionaldoesAverage?: boolean
Whether this field averages in reports within the product.
OptionaldoesTotal?: boolean
Whether this field totals in reports within the product.
Optionalexact?: boolean
Whether an exact match is required for a report link.
Optionalformat?: number
The format to display time.
Optionalformula?: string
The formula of the field as configured in Quickbase.
OptionalhasExtension?: boolean
Whether this field has a phone extension.
Optionalhours24?: boolean
Indicates whether or not to display time in the 24-hour format within the product.
OptionallinkText?: string
The configured text value that replaces the URL that users see within the product.
OptionallookupReferenceFieldId?: number
The id of the field that is the reference in the relationship for this lookup.
OptionallookupTargetFieldId?: number
The id of the field that is the target on the parent table for this lookup.
OptionalmaxLength?: number
The maximum number of characters allowed for entry in Quickbase for this field.
OptionalmaxVersions?: number
The maximum number of versions configured for a file attachment.
OptionalnumberFormat?: number
The format used for displaying numeric values in the product (decimal, separators, digit group).
OptionalnumLines?: number
The number of lines shown in Quickbase for this text field.
OptionalopenTargetIn?: "sameWindow" | "newWindow" | "popup"
Indicates which target the URL should open in when a user clicks it within the product.
OptionalparentFieldId?: number
The id of the parent composite field, when applicable.
OptionalseeVersions?: boolean
Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
OptionalsnapFieldId?: number
The id of the field that is used to snapshot values from, when applicable.
OptionalsortAlpha?: boolean
Whether to sort alphabetically, default sort is by record ID.
OptionalsortAsGiven?: boolean
Indicates if the listed entries sort as entered vs alphabetically.
OptionalsourceFieldId?: number
The id of the source field.
OptionalsummaryFunction?:
    | "AVG"
    | "SUM"
    | "MAX"
    | "MIN"
    | "STD-DEV"
    | "COUNT"
    | "COMBINED-TEXT"
    | "COMBINED-USER"
    | "DISTINCT-COUNT"
The accumulation type for the summary field.
OptionalsummaryQuery?: string
The summary query.
OptionalsummaryReferenceFieldId?: number
The id of the field that is the reference in the relationship for this summary.
OptionalsummaryTableId?: string
The table the summary field references fields from.
OptionalsummaryTargetFieldId?: number
The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).
OptionaltargetFieldId?: number
The id of the target field.
OptionaltargetTableId?: string
The id of the target table.
OptionaltargetTableName?: string
The field's target table name.
Optionalunits?: string
The units label.
OptionaluseI18NFormat?: boolean
Whether phone numbers should be in E.164 standard international format
OptionaluseNewWindow?: boolean
Indicates if the file should open a new window when a user clicks it within the product.
OptionalversionMode?: "keepallversions" | "keeplastversions"
Version modes for files. Keep all versions vs keep last version.
Optionalwidth?: number
The field's html input width in the product.

`Optional`required

required?: boolean

Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required.

`Optional`unique

unique?: boolean

Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique.

Interface UpdateFieldRequest

Index

Properties

Properties

OptionaladdToForms

OptionalappearsByDefault

Optionalaudited

Optionalbold

OptionalfieldHelp

OptionalfindEnabled

Optionallabel

OptionalnoWrap

Optionalpermissions

Type Declaration

OptionalpermissionType?: string

Optionalrole?: string

OptionalroleId?: number

Optionalproperties

Type Declaration

Optionalabbreviate?: boolean

OptionalallowMentions?: boolean

Mention

OptionalallowNewChoices?: boolean

OptionalappearsAs?: string

OptionalappendOnly?: boolean

OptionalautoSave?: boolean

OptionalblankIsZero?: boolean

OptionalcarryChoices?: boolean

Optionalchoices?: string[]

OptionalcommaStart?: number

Optionalcomments?: string

OptionalcompositeFields?: (number | Record<string, unknown>)[]

OptionalcoverText?: string

OptionalcurrencyFormat?: "left" | "right" | "middle"

OptionalcurrencySymbol?: string

OptionaldecimalPlaces?: number

OptionaldefaultCountryCode?: string

OptionaldefaultDomain?: string

OptionaldefaultKind?: string

OptionaldefaultToday?: boolean

OptionaldefaultValue?: string

OptionaldefaultValueLuid?: number

OptionaldisplayAsLink?: boolean

OptionaldisplayCheckboxAsText?: boolean

OptionaldisplayDayOfWeek?: boolean

OptionaldisplayEmail?: string

OptionaldisplayMonth?: string

OptionaldisplayRelative?: boolean

OptionaldisplayTime?: boolean

OptionaldisplayTimezone?: boolean

OptionaldisplayUser?: string

OptionaldoesAverage?: boolean

OptionaldoesTotal?: boolean

Optionalexact?: boolean

Optionalformat?: number

Optionalformula?: string

OptionalhasExtension?: boolean

Optionalhours24?: boolean

OptionallinkText?: string

OptionallookupReferenceFieldId?: number

OptionallookupTargetFieldId?: number

OptionalmaxLength?: number

OptionalmaxVersions?: number

OptionalnumberFormat?: number

OptionalnumLines?: number

OptionalopenTargetIn?: "sameWindow" | "newWindow" | "popup"

OptionalparentFieldId?: number

OptionalseeVersions?: boolean

OptionalsnapFieldId?: number

OptionalsortAlpha?: boolean

OptionalsortAsGiven?: boolean

OptionalsourceFieldId?: number

OptionalsummaryFunction?: | "AVG" | "SUM" | "MAX" | "MIN" | "STD-DEV" | "COUNT" | "COMBINED-TEXT" | "COMBINED-USER" | "DISTINCT-COUNT"

OptionalsummaryQuery?: string

OptionalsummaryReferenceFieldId?: number

OptionalsummaryTableId?: string

OptionalsummaryTargetFieldId?: number

OptionaltargetFieldId?: number

OptionaltargetTableId?: string

OptionaltargetTableName?: string

`Optional`addToForms

`Optional`appearsByDefault

`Optional`audited

`Optional`bold

`Optional`fieldHelp

`Optional`findEnabled

`Optional`label

`Optional`noWrap

`Optional`permissions

`Optional`permissionType?: string

`Optional`role?: string

`Optional`roleId?: number

`Optional`properties

`Optional`abbreviate?: boolean

`Optional`allowMentions?: boolean

`Optional`allowNewChoices?: boolean

`Optional`appearsAs?: string

`Optional`appendOnly?: boolean

`Optional`autoSave?: boolean

`Optional`blankIsZero?: boolean

`Optional`carryChoices?: boolean

`Optional`choices?: string[]

`Optional`commaStart?: number

`Optional`comments?: string

`Optional`compositeFields?: (number | Record<string, unknown>)[]

`Optional`coverText?: string

`Optional`currencyFormat?: "left" | "right" | "middle"

`Optional`currencySymbol?: string

`Optional`decimalPlaces?: number

`Optional`defaultCountryCode?: string

`Optional`defaultDomain?: string

`Optional`defaultKind?: string

`Optional`defaultToday?: boolean

`Optional`defaultValue?: string

`Optional`defaultValueLuid?: number

`Optional`displayAsLink?: boolean

`Optional`displayCheckboxAsText?: boolean

`Optional`displayDayOfWeek?: boolean

`Optional`displayEmail?: string

`Optional`displayMonth?: string

`Optional`displayRelative?: boolean

`Optional`displayTime?: boolean

`Optional`displayTimezone?: boolean

`Optional`displayUser?: string

`Optional`doesAverage?: boolean

`Optional`doesTotal?: boolean

`Optional`exact?: boolean

`Optional`format?: number

`Optional`formula?: string

`Optional`hasExtension?: boolean

`Optional`hours24?: boolean

`Optional`linkText?: string

`Optional`lookupReferenceFieldId?: number

`Optional`lookupTargetFieldId?: number

`Optional`maxLength?: number

`Optional`maxVersions?: number

`Optional`numberFormat?: number

`Optional`numLines?: number

`Optional`openTargetIn?: "sameWindow" | "newWindow" | "popup"

`Optional`parentFieldId?: number

`Optional`seeVersions?: boolean

`Optional`snapFieldId?: number

`Optional`sortAlpha?: boolean

`Optional`sortAsGiven?: boolean

`Optional`sourceFieldId?: number

`Optional`summaryFunction?:
| "AVG"
| "SUM"
| "MAX"
| "MIN"
| "STD-DEV"
| "COUNT"
| "COMBINED-TEXT"
| "COMBINED-USER"
| "DISTINCT-COUNT"

`Optional`summaryQuery?: string

`Optional`summaryReferenceFieldId?: number

`Optional`summaryTableId?: string

`Optional`summaryTargetFieldId?: number

`Optional`targetFieldId?: number

`Optional`targetTableId?: string

`Optional`targetTableName?: string

`Optional`units?: string

`Optional`useI18NFormat?: boolean

`Optional`useNewWindow?: boolean

`Optional`versionMode?: "keepallversions" | "keeplastversions"

`Optional`width?: number

`Optional`required

`Optional`unique