Table Fields

Add Table Field

Add a new field to a table.

POST/databases/{databaseId}/tables/{tableId}/fields

Request

curl --request POST \
  --url 'https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields' \
  --header 'Softr-Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "type": "<string>"
}'

import json
import requests

url = "https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields"
headers = {
  "Softr-Api-Key": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\",\"type\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields", {
  method: "POST",
  headers: {
    "Softr-Api-Key": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "type": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Softr-Api-Key: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"name\":\"<string>\",\"type\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"type\":\"<string>\"}")))
  req.Header.Set("Softr-Api-Key", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields"))
    .header("Softr-Api-Key", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"type\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields")
request = Net::HTTP::Post.new(uri)
request["Softr-Api-Key"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"type\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "SINGLE_LINE_TEXT",
    "options": {},
    "allowMultipleEntries": true,
    "readonly": true,
    "required": true,
    "locked": true,
    "defaultValue": "<string>",
    "aiOptions": {
      "aiFillable": true,
      "aiOnly": true,
      "allowWebSearch": true,
      "aiModel": "<string>",
      "prompt": "<string>",
      "canBeTriggeredManually": true,
      "runWhenRecordIsCreated": true,
      "runWhenRecordIsUpdated": true
    },
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}

Field Types Reference

Editable Fields

Type	Value Format	Description
`SINGLE_LINE_TEXT`	`string`	Short text
`LONG_TEXT`	`string`	Multi-line text
`EMAIL`	`string`	Email address
`PHONE`	`string`	Phone number
`URL`	`string`	Web URL
`NUMBER`	`number`	Numeric value
`CURRENCY`	`number`	Monetary amount
`PERCENT`	`number`	Percentage (0–100)
`RATING`	`number`	Star rating
`DURATION`	`number`	Duration
`CHECKBOX`	`boolean`	True/false
`SELECT`	`string` or `array`	Single or multi-select from predefined choices
`USER`	`object` or `array`	User reference
`LINKED_RECORD`	`string` or `array`	Link to record(s) in another table
`ATTACHMENT`	`object` or `array`	File attachment
`DATE`	`string`	Date (ISO 8601)
`DATETIME`	`string`	Date and time (ISO 8601)

Read-Only Fields

These are computed or system-managed and cannot be set when creating or updating records.

Type	Description
`LOOKUP`	Value from a linked record’s field
`ROLLUP`	Aggregation over linked records
`FORMULA`	Calculated from a formula expression
`CREATED_AT`	Record creation timestamp
`UPDATED_AT`	Record last modified timestamp
`CREATED_BY`	User who created the record
`UPDATED_BY`	User who last modified the record
`AUTONUMBER`	Auto-incrementing number
`RECORD_ID`	System record identifier

Field Options

Type-specific configuration passed in the options object when creating or updating fields.

SELECT

JSON{
  "choices": [
    { "id": "choice-1", "label": "Option A", "color": "#FF0000" },
    { "id": "choice-2", "label": "Option B", "color": "#00FF00" }
  ],
  "allowToAddNewChoice": true,
  "sorting": "CUSTOM",
  "enforceOrder": false
}

sorting can be CUSTOM, ALPHA_ASC, or ALPHA_DESC.

NUMBER

JSON{
  "precision": 2,
  "min": 0,
  "max": 1000000,
  "showThousandSeparator": true,
  "thousandSeparatorLocale": "en-US",
  "largeNumberAbbreviation": "NONE",
  "prefix": null,
  "suffix": null
}

largeNumberAbbreviation can be NONE, K, M, B, or T.

CURRENCY

JSON{
  "precision": 2,
  "min": null,
  "max": null,
  "isoCode": "USD",
  "customSymbol": null,
  "showAs": "SYMBOL",
  "showThousandSeparator": true,
  "thousandSeparatorLocale": "en-US",
  "largeNumberAbbreviation": "NONE",
  "symbolOrCodePosition": "BEFORE"
}

showAs: SYMBOL or CODE
symbolOrCodePosition: BEFORE or AFTER

LINKED_RECORD

JSON{
  "linkedTableId": "table-uuid",
  "inverseLinkFieldId": "field-uuid",
  "viewId": null,
  "sorting": [],
  "filter": null,
  "enforceOrder": false
}

LOOKUP

JSON{
  "linkedRecordFieldId": "field-uuid",
  "lookupFieldId": "field-uuid",
  "isValid": true
}

ROLLUP

JSON{
  "linkedRecordFieldId": "field-uuid",
  "rollupFieldId": "field-uuid",
  "function": "SUM",
  "filter": null
}

Available functions: SUM, MIN, MAX, COUNT, AVERAGE, ARRAYCOMPACT, ARRAYJOIN, ARRAYUNIQUE, ARRAYFLATTEN, CONCATENATE, COUNTALL, COUNTA, OR, AND.

ATTACHMENT

JSON{
  "showAs": "PREVIEW",
  "inferredFileType": "OTHER",
  "enableFileLinkExpiration": true,
  "fileLinkExpirationValue": 2,
  "fileLinkExpirationUnit": "HOURS"
}

showAs: PREVIEW, LIST, or BADGE
inferredFileType: IMAGE, VIDEO, PDF, AUDIO, or OTHER
fileLinkExpirationUnit: HOURS or MINUTES

FORMULA

JSON{
  "formula": "IF({Status} = 'Active', {Amount} * 1.1, {Amount})",
  "isValid": true,
  "referencedFieldIds": ["field-uuid-1", "field-uuid-2"]
}

AI Options

Fields can include an aiOptions object that configures AI-powered auto-fill behavior. This is returned in field definitions and can be set when creating or updating fields.

JSON{
  "aiFillable": true,
  "aiOnly": false,
  "allowWebSearch": true,
  "aiModel": "GPT_4_1",
  "prompt": "Summarize the customer's request based on {Description}",
  "canBeTriggeredManually": true,
  "runWhenRecordIsCreated": true,
  "runWhenRecordIsUpdated": false
}

Property	Type	Default	Description
`aiFillable`	boolean	`false`	Whether AI can fill this field
`aiOnly`	boolean	`true`	If `true`, only AI can write to this field
`allowWebSearch`	boolean	`false`	Allow AI to use web search when filling
`aiModel`	string	`"GPT_4_1"`	AI model to use
`prompt`	string	`""`	Prompt template (reference other fields with `{FieldName}`)
`canBeTriggeredManually`	boolean	`true`	Whether users can trigger AI fill manually
`runWhenRecordIsCreated`	boolean	`true`	Auto-run when record is created
`runWhenRecordIsUpdated`	boolean	`true`	Auto-run when record is updated

Fields without AI configuration return "aiOptions": null.

Authorizations

Softr-Api-KeyAPI keyin headerrequired

Path parameters

databaseIdstringrequired

tableIdstringrequired

Body

application/jsonrequired

namestringrequired

typestringrequired

optionsRecord<string, unknown>

Response

application/json

The newly created field.

dataobject

Show child attributes

data.idstring

data.namestring

data.descriptionstring | null

Optional description of the field.

data.typeenum<string>one of: SINGLE_LINE_TEXT, CHECKBOX, CURRENCY, DATE, DATETIME, DURATION, EMAIL, SELECT, NUMBER, ATTACHMENT, RATING, LINKED_RECORD, LONG_TEXT, URL, PERCENT, PHONE, LOOKUP, ROLLUP, FORMULA, CREATED_AT, UPDATED_AT, CREATED_BY, UPDATED_BY, AUTONUMBER, RECORD_ID, USER

The type of the field.

data.optionsRecord<string, unknown>

Configuration options for the field, specific to its type. See the official documentation for the structure of each type.

data.allowMultipleEntriesboolean

data.readonlyboolean

data.requiredboolean

data.lockedboolean

data.defaultValuestring | null

data.aiOptionsobject | null

AI-powered auto-fill configuration. Null if not configured.

Show child attributes

data.aiOptions.aiFillableboolean

data.aiOptions.aiOnlyboolean

data.aiOptions.allowWebSearchboolean

data.aiOptions.aiModelstring

data.aiOptions.promptstring

data.aiOptions.canBeTriggeredManuallyboolean

data.aiOptions.runWhenRecordIsCreatedboolean

data.aiOptions.runWhenRecordIsUpdatedboolean

data.createdAtstring<date-time>

data.updatedAtstring<date-time>

curl --request POST \ --url 'https://tables-api.softr.io/api/v1/databases/<databaseId>/tables/<tableId>/fields' \ --header 'Softr-Api-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "type": "<string>" }'

{ "data": { "id": "<string>", "name": "<string>", "description": "<string>", "type": "SINGLE_LINE_TEXT", "options": {}, "allowMultipleEntries": true, "readonly": true, "required": true, "locked": true, "defaultValue": "<string>", "aiOptions": { "aiFillable": true, "aiOnly": true, "allowWebSearch": true, "aiModel": "<string>", "prompt": "<string>", "canBeTriggeredManually": true, "runWhenRecordIsCreated": true, "runWhenRecordIsUpdated": true }, "createdAt": "2024-01-01T00:00:00Z", "updatedAt": "2024-01-01T00:00:00Z" } }