Create a table field
Create a new field on a table. Pass before / after (a sibling field key) to slot it at a global position; omit both to append.
curl --request POST \
--url https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"schema": {
"type": "file",
"name": "<string>",
"description": "<string>",
"optional": true,
"array": true,
"placeholder": "<string>",
"display": {},
"order": 1,
"link": "<string>",
"metadata": {},
"allowed_modes": [],
"broadcast_field": true,
"integration_field": true,
"display_field": true,
"conditions": [
{
"field": "<string>",
"value": "<unknown>"
}
],
"hidden": true,
"picker": {
"type": "google_drive",
"views": [],
"selectable_mime_types": [
"<string>"
]
},
"requires": [
"<string>"
],
"disable_variables": true,
"allowed_types": [
"<string>"
],
"visibility": "PRIVATE"
},
"config": {},
"icon": "<string>",
"connection_id": "<string>",
"unique": true,
"readonly": true,
"before": "<string>",
"after": "<string>"
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields"
payload = {
"key": "<string>",
"schema": {
"type": "file",
"name": "<string>",
"description": "<string>",
"optional": True,
"array": True,
"placeholder": "<string>",
"display": {},
"order": 1,
"link": "<string>",
"metadata": {},
"allowed_modes": [],
"broadcast_field": True,
"integration_field": True,
"display_field": True,
"conditions": [
{
"field": "<string>",
"value": "<unknown>"
}
],
"hidden": True,
"picker": {
"type": "google_drive",
"views": [],
"selectable_mime_types": ["<string>"]
},
"requires": ["<string>"],
"disable_variables": True,
"allowed_types": ["<string>"],
"visibility": "PRIVATE"
},
"config": {},
"icon": "<string>",
"connection_id": "<string>",
"unique": True,
"readonly": True,
"before": "<string>",
"after": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
schema: {
type: 'file',
name: '<string>',
description: '<string>',
optional: true,
array: true,
placeholder: '<string>',
display: {},
order: 1,
link: '<string>',
metadata: {},
allowed_modes: [],
broadcast_field: true,
integration_field: true,
display_field: true,
conditions: [{field: '<string>', value: '<unknown>'}],
hidden: true,
picker: {type: 'google_drive', views: [], selectable_mime_types: ['<string>']},
requires: ['<string>'],
disable_variables: true,
allowed_types: ['<string>'],
visibility: 'PRIVATE'
},
config: {},
icon: '<string>',
connection_id: '<string>',
unique: true,
readonly: true,
before: '<string>',
after: '<string>'
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'schema' => [
'type' => 'file',
'name' => '<string>',
'description' => '<string>',
'optional' => true,
'array' => true,
'placeholder' => '<string>',
'display' => [
],
'order' => 1,
'link' => '<string>',
'metadata' => [
],
'allowed_modes' => [
],
'broadcast_field' => true,
'integration_field' => true,
'display_field' => true,
'conditions' => [
[
'field' => '<string>',
'value' => '<unknown>'
]
],
'hidden' => true,
'picker' => [
'type' => 'google_drive',
'views' => [
],
'selectable_mime_types' => [
'<string>'
]
],
'requires' => [
'<string>'
],
'disable_variables' => true,
'allowed_types' => [
'<string>'
],
'visibility' => 'PRIVATE'
],
'config' => [
],
'icon' => '<string>',
'connection_id' => '<string>',
'unique' => true,
'readonly' => true,
'before' => '<string>',
'after' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"schema\": {\n \"type\": \"file\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"optional\": true,\n \"array\": true,\n \"placeholder\": \"<string>\",\n \"display\": {},\n \"order\": 1,\n \"link\": \"<string>\",\n \"metadata\": {},\n \"allowed_modes\": [],\n \"broadcast_field\": true,\n \"integration_field\": true,\n \"display_field\": true,\n \"conditions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"hidden\": true,\n \"picker\": {\n \"type\": \"google_drive\",\n \"views\": [],\n \"selectable_mime_types\": [\n \"<string>\"\n ]\n },\n \"requires\": [\n \"<string>\"\n ],\n \"disable_variables\": true,\n \"allowed_types\": [\n \"<string>\"\n ],\n \"visibility\": \"PRIVATE\"\n },\n \"config\": {},\n \"icon\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"unique\": true,\n \"readonly\": true,\n \"before\": \"<string>\",\n \"after\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"schema\": {\n \"type\": \"file\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"optional\": true,\n \"array\": true,\n \"placeholder\": \"<string>\",\n \"display\": {},\n \"order\": 1,\n \"link\": \"<string>\",\n \"metadata\": {},\n \"allowed_modes\": [],\n \"broadcast_field\": true,\n \"integration_field\": true,\n \"display_field\": true,\n \"conditions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"hidden\": true,\n \"picker\": {\n \"type\": \"google_drive\",\n \"views\": [],\n \"selectable_mime_types\": [\n \"<string>\"\n ]\n },\n \"requires\": [\n \"<string>\"\n ],\n \"disable_variables\": true,\n \"allowed_types\": [\n \"<string>\"\n ],\n \"visibility\": \"PRIVATE\"\n },\n \"config\": {},\n \"icon\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"unique\": true,\n \"readonly\": true,\n \"before\": \"<string>\",\n \"after\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"schema\": {\n \"type\": \"file\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"optional\": true,\n \"array\": true,\n \"placeholder\": \"<string>\",\n \"display\": {},\n \"order\": 1,\n \"link\": \"<string>\",\n \"metadata\": {},\n \"allowed_modes\": [],\n \"broadcast_field\": true,\n \"integration_field\": true,\n \"display_field\": true,\n \"conditions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"hidden\": true,\n \"picker\": {\n \"type\": \"google_drive\",\n \"views\": [],\n \"selectable_mime_types\": [\n \"<string>\"\n ]\n },\n \"requires\": [\n \"<string>\"\n ],\n \"disable_variables\": true,\n \"allowed_types\": [\n \"<string>\"\n ],\n \"visibility\": \"PRIVATE\"\n },\n \"config\": {},\n \"icon\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"unique\": true,\n \"readonly\": true,\n \"before\": \"<string>\",\n \"after\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"table_id": "<string>",
"key": "<string>",
"schema": {
"type": "file",
"name": "<string>",
"description": "<string>",
"optional": true,
"array": true,
"placeholder": "<string>",
"display": {},
"order": 1,
"link": "<string>",
"metadata": {},
"allowed_modes": [],
"broadcast_field": true,
"integration_field": true,
"display_field": true,
"conditions": [
{
"field": "<string>",
"value": "<unknown>"
}
],
"hidden": true,
"picker": {
"type": "google_drive",
"views": [],
"selectable_mime_types": [
"<string>"
]
},
"requires": [
"<string>"
],
"disable_variables": true,
"allowed_types": [
"<string>"
],
"visibility": "PRIVATE"
},
"readonly": true,
"kind": "system"
}Authorizations
Bearer token authentication using your API key
Body
1 - 64^[a-z][a-z0-9_]{0,63}$A table field schema
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
Show child attributes
Show child attributes
Per-feature config map keyed by feature name (e.g. button, auto_fill, sync). Each value carries input + optional definitions.
Show child attributes
Show child attributes
The emoji of a curated icon a user can pick for a table, view, field, or other entity
128none, auto_fill What happens when the referenced target is deleted (ref-typed fields only). restrict forbids deleting the target while any cell still points to it. clear allows the delete and drops those field values on remaining rows. cascade also deletes table rows that reference the target via this field.
restrict, clear, cascade 10241024Response
- Option 1
- Option 2
string, number, boolean, date, datetime, enum, file, record, contact, user, chat, segment, assistant The file type allows users to upload files
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
Show child attributes
Show child attributes
system Was this page helpful?
curl --request POST \
--url https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"schema": {
"type": "file",
"name": "<string>",
"description": "<string>",
"optional": true,
"array": true,
"placeholder": "<string>",
"display": {},
"order": 1,
"link": "<string>",
"metadata": {},
"allowed_modes": [],
"broadcast_field": true,
"integration_field": true,
"display_field": true,
"conditions": [
{
"field": "<string>",
"value": "<unknown>"
}
],
"hidden": true,
"picker": {
"type": "google_drive",
"views": [],
"selectable_mime_types": [
"<string>"
]
},
"requires": [
"<string>"
],
"disable_variables": true,
"allowed_types": [
"<string>"
],
"visibility": "PRIVATE"
},
"config": {},
"icon": "<string>",
"connection_id": "<string>",
"unique": true,
"readonly": true,
"before": "<string>",
"after": "<string>"
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields"
payload = {
"key": "<string>",
"schema": {
"type": "file",
"name": "<string>",
"description": "<string>",
"optional": True,
"array": True,
"placeholder": "<string>",
"display": {},
"order": 1,
"link": "<string>",
"metadata": {},
"allowed_modes": [],
"broadcast_field": True,
"integration_field": True,
"display_field": True,
"conditions": [
{
"field": "<string>",
"value": "<unknown>"
}
],
"hidden": True,
"picker": {
"type": "google_drive",
"views": [],
"selectable_mime_types": ["<string>"]
},
"requires": ["<string>"],
"disable_variables": True,
"allowed_types": ["<string>"],
"visibility": "PRIVATE"
},
"config": {},
"icon": "<string>",
"connection_id": "<string>",
"unique": True,
"readonly": True,
"before": "<string>",
"after": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
key: '<string>',
schema: {
type: 'file',
name: '<string>',
description: '<string>',
optional: true,
array: true,
placeholder: '<string>',
display: {},
order: 1,
link: '<string>',
metadata: {},
allowed_modes: [],
broadcast_field: true,
integration_field: true,
display_field: true,
conditions: [{field: '<string>', value: '<unknown>'}],
hidden: true,
picker: {type: 'google_drive', views: [], selectable_mime_types: ['<string>']},
requires: ['<string>'],
disable_variables: true,
allowed_types: ['<string>'],
visibility: 'PRIVATE'
},
config: {},
icon: '<string>',
connection_id: '<string>',
unique: true,
readonly: true,
before: '<string>',
after: '<string>'
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'key' => '<string>',
'schema' => [
'type' => 'file',
'name' => '<string>',
'description' => '<string>',
'optional' => true,
'array' => true,
'placeholder' => '<string>',
'display' => [
],
'order' => 1,
'link' => '<string>',
'metadata' => [
],
'allowed_modes' => [
],
'broadcast_field' => true,
'integration_field' => true,
'display_field' => true,
'conditions' => [
[
'field' => '<string>',
'value' => '<unknown>'
]
],
'hidden' => true,
'picker' => [
'type' => 'google_drive',
'views' => [
],
'selectable_mime_types' => [
'<string>'
]
],
'requires' => [
'<string>'
],
'disable_variables' => true,
'allowed_types' => [
'<string>'
],
'visibility' => 'PRIVATE'
],
'config' => [
],
'icon' => '<string>',
'connection_id' => '<string>',
'unique' => true,
'readonly' => true,
'before' => '<string>',
'after' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields"
payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"schema\": {\n \"type\": \"file\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"optional\": true,\n \"array\": true,\n \"placeholder\": \"<string>\",\n \"display\": {},\n \"order\": 1,\n \"link\": \"<string>\",\n \"metadata\": {},\n \"allowed_modes\": [],\n \"broadcast_field\": true,\n \"integration_field\": true,\n \"display_field\": true,\n \"conditions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"hidden\": true,\n \"picker\": {\n \"type\": \"google_drive\",\n \"views\": [],\n \"selectable_mime_types\": [\n \"<string>\"\n ]\n },\n \"requires\": [\n \"<string>\"\n ],\n \"disable_variables\": true,\n \"allowed_types\": [\n \"<string>\"\n ],\n \"visibility\": \"PRIVATE\"\n },\n \"config\": {},\n \"icon\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"unique\": true,\n \"readonly\": true,\n \"before\": \"<string>\",\n \"after\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"schema\": {\n \"type\": \"file\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"optional\": true,\n \"array\": true,\n \"placeholder\": \"<string>\",\n \"display\": {},\n \"order\": 1,\n \"link\": \"<string>\",\n \"metadata\": {},\n \"allowed_modes\": [],\n \"broadcast_field\": true,\n \"integration_field\": true,\n \"display_field\": true,\n \"conditions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"hidden\": true,\n \"picker\": {\n \"type\": \"google_drive\",\n \"views\": [],\n \"selectable_mime_types\": [\n \"<string>\"\n ]\n },\n \"requires\": [\n \"<string>\"\n ],\n \"disable_variables\": true,\n \"allowed_types\": [\n \"<string>\"\n ],\n \"visibility\": \"PRIVATE\"\n },\n \"config\": {},\n \"icon\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"unique\": true,\n \"readonly\": true,\n \"before\": \"<string>\",\n \"after\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"schema\": {\n \"type\": \"file\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"optional\": true,\n \"array\": true,\n \"placeholder\": \"<string>\",\n \"display\": {},\n \"order\": 1,\n \"link\": \"<string>\",\n \"metadata\": {},\n \"allowed_modes\": [],\n \"broadcast_field\": true,\n \"integration_field\": true,\n \"display_field\": true,\n \"conditions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"hidden\": true,\n \"picker\": {\n \"type\": \"google_drive\",\n \"views\": [],\n \"selectable_mime_types\": [\n \"<string>\"\n ]\n },\n \"requires\": [\n \"<string>\"\n ],\n \"disable_variables\": true,\n \"allowed_types\": [\n \"<string>\"\n ],\n \"visibility\": \"PRIVATE\"\n },\n \"config\": {},\n \"icon\": \"<string>\",\n \"connection_id\": \"<string>\",\n \"unique\": true,\n \"readonly\": true,\n \"before\": \"<string>\",\n \"after\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"table_id": "<string>",
"key": "<string>",
"schema": {
"type": "file",
"name": "<string>",
"description": "<string>",
"optional": true,
"array": true,
"placeholder": "<string>",
"display": {},
"order": 1,
"link": "<string>",
"metadata": {},
"allowed_modes": [],
"broadcast_field": true,
"integration_field": true,
"display_field": true,
"conditions": [
{
"field": "<string>",
"value": "<unknown>"
}
],
"hidden": true,
"picker": {
"type": "google_drive",
"views": [],
"selectable_mime_types": [
"<string>"
]
},
"requires": [
"<string>"
],
"disable_variables": true,
"allowed_types": [
"<string>"
],
"visibility": "PRIVATE"
},
"readonly": true,
"kind": "system"
}