Create field

POST/workspaces/{organizationId}/fields

Path parameters

organizationIdstringrequired

Request body

application/json

entityTypestringrequired

min length 1

namestringrequired

min length 1

typestringrequired

Allowed:textnumberselectdateboolean

optionsstring[]

positioninteger

Responses

201

Created field

fieldobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

entityTypestringrequired

namestringrequired

typestringrequired

Allowed:textnumberselectdateboolean

optionsstring[] | nullrequired

positionnumberrequired

createdAtstringrequired

updatedAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST '/workspaces/string/fields' \
  -H 'Content-Type: application/json' \
  -d '{
  "entityType": "string",
  "name": "string",
  "type": "text",
  "options": [
    "string"
  ],
  "position": 0
}'

const response = await fetch("/workspaces/string/fields", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"entityType\": \"string\",\n  \"name\": \"string\",\n  \"type\": \"text\",\n  \"options\": [\n    \"string\"\n  ],\n  \"position\": 0\n}"
});

import requests

response = requests.post(
    "/workspaces/string/fields",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"entityType\": \"string\",\n  \"name\": \"string\",\n  \"type\": \"text\",\n  \"options\": [\n    \"string\"\n  ],\n  \"position\": 0\n}",
)

Response

{
  "field": {
    "id": "string",
    "organizationId": "string",
    "entityType": "string",
    "name": "string",
    "type": "text",
    "options": [
      "string"
    ],
    "position": 0,
    "createdAt": "string",
    "updatedAt": "string"
  }
}