Change a field

PATCH/api/v1/objects/{objectId}/fields/{fieldId}

Authorization

AuthorizationOAuth2 access token · headerrequired

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

Scopes:api.access

Path parameters

objectIdstringrequired

An object's id

min length 1 · max length 255

fieldIdstringrequired

A field's id

min length 1 · max length 255

Header parameters

Idempotency-Keystringrequired

Replays the first answer for a repeated request

min length 8 · max length 128

Request body

requiredapplication/json

keystring

matches ^[a-z][a-z0-9_]{0,62}$

labelstring

min length 1 · max length 120

requiredboolean

targetObjectIdstring

min length 1 · max length 255

typestring

Allowed:textlongtextdecimalcurrencypercentbooleandatedatetimeemailurlphoneuseraddressselectmulti_selectrelationformularollupdays_since

Responses

200

The field as it now stands

definitionobjectrequired

Show properties

One of:

object

keystringrequired

matches ^[a-z][a-z0-9_]{0,62}$

labelstringrequired

min length 1 · max length 120

requiredbooleanrequired

default: false

visibleByDefaultboolean

typestringrequired

Allowed:textlongtextdecimalcurrencypercentbooleandatedatetimeemailurlphoneuseraddress

object

keystringrequired

matches ^[a-z][a-z0-9_]{0,62}$

labelstringrequired

min length 1 · max length 120

requiredbooleanrequired

default: false

visibleByDefaultboolean

optionsstring[]required

max items 200

typestringrequired

object

keystringrequired

matches ^[a-z][a-z0-9_]{0,62}$

labelstringrequired

min length 1 · max length 120

requiredbooleanrequired

default: false

visibleByDefaultboolean

optionsstring[]required

max items 200

typestringrequired

object

keystringrequired

matches ^[a-z][a-z0-9_]{0,62}$

labelstringrequired

min length 1 · max length 120

requiredbooleanrequired

default: false

visibleByDefaultboolean

cardinalitystringrequired

Allowed:onemany

targetObjectIdstringrequired

min length 1 · max length 255

typestringrequired

object

keystringrequired

matches ^[a-z][a-z0-9_]{0,62}$

labelstringrequired

min length 1 · max length 120

requiredbooleanrequired

default: false

visibleByDefaultboolean

formulaobjectrequired

Show properties

leftstringrequired

matches ^[a-z][a-z0-9_]{0,62}$

operatorstringrequired

Allowed:addsubtractmultiplydivide

rightstringrequired

matches ^[a-z][a-z0-9_]{0,62}$

typestringrequired

object

keystringrequired

matches ^[a-z][a-z0-9_]{0,62}$

labelstringrequired

min length 1 · max length 120

requiredbooleanrequired

default: false

visibleByDefaultboolean

rollupobjectrequired

Show properties

aggstringrequired

Allowed:countsumavgminmaxlastfirst

columnstring | nullrequired

Show properties

Any of:

string

string

null

null

filtersobject[]required

max items 20

Show properties

Array of object

idstringrequired

max length 128

keystringrequired

min length 1 · max length 128

opstringrequired

Allowed:containsnotContainsisisNotisAnyOfisNoneOfgtgteltltebeforeafteronOrBeforeonOrAfterisBetweenisYesterdayisTodayisTomorrowisLastWeekisThisWeekisNextWeekisLastMonthisThisMonthisNextMonthisPastisFutureisEmptyisNotEmptyisTrueisFalse

valuestringrequired

max length 500

valuesstring[]required

max items 50

foreignKeystringrequired

min length 1 · max length 128

modestring

Allowed:relatedListrelationship

objectstringrequired

min length 1 · max length 128

orderBystring | null

Show properties

Any of:

string

string

null

null

scoreobject | null

Show properties

Any of:

object

bucketsinteger

min 1 · max 20

directionstring

Allowed:descasc

null

null

typestringrequired

object

keystringrequired

matches ^[a-z][a-z0-9_]{0,62}$

labelstringrequired

min length 1 · max length 120

requiredbooleanrequired

default: false

visibleByDefaultboolean

daysSinceobjectrequired

Show properties

columnstringrequired

min length 1 · max length 128

typestringrequired

idstringrequired

min length 1 · max length 255

systembooleanrequired

400

The request body, query or parameters were refused

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

401

The access token is missing, invalid or revoked

errorstringrequired

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

404

No such record, or none the caller may read

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

409

The operation conflicts with the current state

codestringrequired

Allowed:invalid_inputnot_foundconflictforbidden

detailany

errorstringrequired

reasonstring

413

The request exceeds the route's body limit

errorstringrequired

500

An unexpected failure

errorstringrequired

Request

curl -X PATCH '/api/v1/api/v1/objects/string/fields/string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "key": "string",
  "label": "string",
  "required": true,
  "targetObjectId": "string",
  "type": "text"
}'

const response = await fetch("/api/v1/api/v1/objects/string/fields/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"key\": \"string\",\n  \"label\": \"string\",\n  \"required\": true,\n  \"targetObjectId\": \"string\",\n  \"type\": \"text\"\n}"
});

import requests

response = requests.patch(
    "/api/v1/api/v1/objects/string/fields/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"key\": \"string\",\n  \"label\": \"string\",\n  \"required\": true,\n  \"targetObjectId\": \"string\",\n  \"type\": \"text\"\n}",
)

Response

{
  "definition": {
    "key": "string",
    "label": "string",
    "required": false,
    "visibleByDefault": true,
    "type": "text"
  },
  "id": "string",
  "system": true
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}