/api/action11

/api/activity5

/api/agent16

/api/alert3

/api/analytics2

/api/analytics-proxy1

/api/api-key6

/api/automagic-dashboards11

/api/bookmark4

/api/bug-reporting2

/api/cache4

/api/card20

/api/cards2

/api/channel5

/api/cloud-migration3

/api/collection18

/api/comment6

/api/dashboard26

/api/data-studio/table5

/api/database28

/api/dataset8

/api/document10

/api/ee/action-v23

/api/ee/advanced-permissions/application2

/api/ee/advanced-permissions/impersonation2

/api/ee/ai-controls/mcp-permissions4

/api/ee/ai-controls/permissions4

/api/ee/ai-controls/usage8

/api/ee/apps13

/api/ee/audit-app/analytics-dev1

/api/ee/audit-app/user2

/api/ee/billing1

/api/ee/cloud-add-ons4

/api/ee/cloud-proxy1

/api/ee/content-diagnostics6

/api/ee/content-translation4

/api/ee/custom-viz-plugin13

/api/ee/data-complexity-score1

/api/ee/data-studio/table3

/api/ee/database-replication3

/api/ee/database-routing2

/api/ee/dependencies7

/api/ee/email2

/api/ee/erd1

/api/ee/gsheets5

/api/ee/library3

/api/ee/logs1

/api/ee/metabot1

/api/ee/metabot-analytics2

/api/ee/mfa9

/api/ee/permission_debug1

/api/ee/remote-sync13

/api/ee/replacement6

/api/ee/scim2

/api/ee/scim/v210

/api/ee/security-center5

/api/ee/semantic-search1

/api/ee/serialization2

/api/ee/session-management3

/api/ee/stale1

/api/ee/support-access-grant4

/api/ee/tenant4

/api/ee/transform-test8

/api/ee/transforms3

/api/ee/transforms-python3

/api/ee/upload-management2

/api/eid-translation1

/api/email3

/api/embed16

/api/embed-mcp4

/api/embed-theme7

/api/embedding-hub1

/api/embedding-sdk1

/api/eval-trace1

/api/exploration13

/api/field13

/api/frontend-errors1

/api/geojson2

/api/glossary4

/api/google1

/api/health-inspector1

/api/index5

/api/ldap1

/api/llm7

/api/logger4

/api/login-history1

/api/measure7

/api/metabot3

/api/metabot/conversations5

/api/metabot/document1

/api/metabot/metabot7

/api/metabot/permissions1

/api/metabot/slack3

/api/metaplow-proxy1

/api/metric13

/api/model-index4

/api/moderation-review1

/api/mt/gtap6

/api/mt/user2

/api/native-query-snippet4

/api/notification7

/api/notification/admin4

/api/notification/unsubscribe2

/api/notify3

/api/oauth1

/api/osi/ai-context5

/api/permissions15

/api/persist11

/api/premium-features2

/api/preview_embed13

/api/public24

/api/pulse7

/api/pulse/unsubscribe2

/api/revision3

/api/search6

/api/segment6

/api/session12

/api/setting4

/api/setup1

/api/slack4

/api/table16

/api/task8

/api/testing19

/api/tiles3

/api/timeline7

/api/timeline-event4

/api/transform15

/api/transform-dag-run2

/api/transform-job11

/api/transform-tag4

/api/upload1

/api/user12

/api/user-key-value4

/api/util1

/api/field

PUT /api/field/{id}

Changed on Nov 4, 2026

Update Field with ID.

put/api/field/{id}

Request

Base URL
(relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

caveatsstring nullable

value must be a non-blank string.

coercion_strategystring nullable

value must be a valid coercion strategy (keyword or string).

descriptionstring nullable

value must be a non-blank string.

display_namestring

value must be a non-blank string.

fk_target_field_idinteger nullable

value must be an integer greater than zero.

has_field_values'auto-list' | 'list' | 'none' | 'search'

json_unfoldingboolean

points_of_intereststring nullable

value must be a non-blank string.

semantic_typestring nullable

value must be a valid field semantic or relation type (keyword or string).

settingsobject nullable

Value must be a map.

visibility_type'retired' | 'sensitive' | 'normal' | 'hidden' | 'details-only'

Response

Successful response

Changes

Nov 4, 20262e178f5a7934 Revision changes
- breaking
  request property was restricted to a list of enum values
- breaking
  request property was restricted to a list of enum values
- breaking
  request property list-of-types was narrowed by removing types null from media type application/json
- breaking
  request property list-of-types was narrowed by removing types null from media type application/json
- breaking
  request property list-of-types was narrowed by removing types null from media type application/json
- breaking
  the request property's minLength was increased from 0 to 1
- breaking
  removed subschema #2 from the request property oneOf list
- breaking
  removed subschema #1 subschema #2 from the request property oneOf list
- breaking
  removed subschema #1 subschema #2 from the request property oneOf list
- breaking
  removed subschema #1 subschema #2 from the request property oneOf list
- breaking
  removed subschema #1 subschema #2 from the request property oneOf list
- breaking
  removed subschema #1 subschema #2 from the request property oneOf list
- breaking
  removed subschema #1 subschema #2 from the request property oneOf list
- breaking
  removed subschema #1 subschema #2 from the request property oneOf list
- breaking
  the request property type changed from no type to string
- warning
  removed the request property
- info
  added the new optional request property
- info
  added subschema #1 subschema #2 to the request property anyOf list
- info
  added subschema #1 subschema #2 to the request property anyOf list
- info
  added subschema #1 subschema #2 to the request property anyOf list
- info
  added subschema #1 subschema #2 to the request property anyOf list
- info
  added subschema #1 subschema #2 to the request property anyOf list
- info
  added subschema #1 subschema #2 to the request property anyOf list
- info
  added subschema #1 subschema #2 to the request property anyOf list
- info
  added the new auto-list enum value to the request property
- info
  added the new details-only enum value to the request property
- info
  added the new hidden enum value to the request property
- info
  added the new list enum value to the request property
- info
  added the new none enum value to the request property
- info
  added the new normal enum value to the request property
- info
  added the new retired enum value to the request property
- info
  added the new search enum value to the request property
- info
  added the new sensitive enum value to the request property
Mar 9, 202678297d193ca4 Revision changes
- info
  api operation id put-api-field-id was added

Operation history

PUT /api/field/{id}

Request

Path parameters

Request body

Response 2XX

Changes

Response