Field Object

Example

{
  "slug": "random_10_digit_alphanumeric_value",
  "label": "Field Name",
  "field_type": "field_type",
  "params": {
    ...field_specific_params
  },
  "is_new": true
}

Add Field wraps this object in a field key.

Object Literals

Param	Type	Optional	Description
slug	string	No	A random 10 digit alphanumeric value.
label	string	No	The field name.
field_type	string	No	The field type (see below).
params	object	No	field-specific parameters.
is_new	boolean	No	Set to true for new fields.

Common params

These params appear on many field types. Several of them can be null, so don't assume a value is always present.

Param	Type	Nullable	Description
required	boolean	No	Whether a value is required.
unique	boolean	No	Whether values must be unique.
hidden	boolean	No	Whether the field is hidden.
help_text	string	Yes	Plain-text help for the field.
help_doc	object	Yes	Field help as a SmartDoc object. Null on most fields.
width	number	Yes	Record layout width: 1 = half width, 2 = full width. Null on system fields and fields that have not been placed in the layout.
linked_application	string	Yes	The target Table of a Linked Record, Lookup, Rollup or Count field. Usually a Table Id, but system tables are referenced by slug, e.g. members, so don't assume a 24-character Id.
linked_field_slug	string	Yes	The mirrored field on the linked Table. Null when there is no mirror.
target_field_structure	object	Yes	The shape of the value a Formula, Lookup or Rollup field produces. Null when there is no resolved target.

Field Types

The following is a list of the field type values for each supported SmartSuite field.

Field Name	Field Type	Notes
Single Select	singleselectfield
Multiple Select	multipleselectfield
Status	statusfield
Tag	tagsfield
Text	textfield
Address	addressfield
Date	datefield
Date Range	daterangefield
Due Date	duedatefield
Duration	durationfield
Time	timefield
Time Tracking Log	timetrackingfield	Bulk add unsupported.
Checklist	checklistfield	Bulk add unsupported.
Color Picker	colorpickerfield
Email	emailfield
Full Name	fullnamefield
IP Address	ipaddressfield
Link	linkfield
Phone	phonefield
Title (Primary)	recordtitlefield	System Field, cannot be added via API
SmartDoc	richtextareafield
Social Network	socialnetworkfield	Bulk add unsupported.
Text Area	textareafield
Currency	currencyfield
Number	numberfield
Number Slider	numbersliderfield
Percent Complete	percentcompletefield
Percent	percentfield
Rating	ratingfield
Yes / No	yesnofield
Vote	votefield	Bulk add unsupported.
Count	countfield	Bulk add unsupported.
Files and Images	filefield	Bulk add unsupported.
Signature	signaturefield	Bulk add unsupported.
Formula	formulafield	Bulk add unsupported.
Lookup	lookupfield
Rollup	rollupfield	Bulk add unsupported.
Record Id	recordidfield	Bulk add unsupported.
First Created	firstcreatedfield	System Field, cannot be added via API
Last Updated	lastupdatedfield	System Field, cannot be added via API
Sub-Items	subitemsfield	Bulk add unsupported.
Open Comments	commentscountfield	System Field, cannot be added via API
Button	buttonfield	Bulk add unsupported.
Linked Record	linkedrecordfield
Assigned To	userfield
Auto Number	autonumberfield	System Field, cannot be added via API
Availability Status	availabilitystatusfield