Content Management API > Field

Update a field

Body parameters

default_valueOptional

Default value for Field. When field is localized accepts an object of default values with site locales as keys

Type:boolean, null, string, number, object

Example:

{ en: "A default value", it: "Un valore di default" }

labelstringOptional

The label of the field

Example:

"Title"

api_keystringOptional

Field API key

Example:

"title"

localizedbooleanOptional

Whether the field needs to be multilanguage or not

validatorsobjectOptional

Optional field validations

Example:

{ required: {} }

appearanceobjectOptional

Field appearance details, plugin configuration and field add-ons

Example:

{
  editor: "single_line",
  parameters: { heading: false },
  addons: [{ id: "1234", field_extension: "lorem_ipsum", parameters: {} }],
}

editorstringRequired

A valid editor can be a DatoCMS default field editor type (ie. "single_line"), or a plugin ID offering a custom field editor

parametersobjectRequired

The editor plugin's parameters

addonsRequired

An array of add-on plugins with id and parameters

Type:Array<object>

idstringRequired

The ID of a plugin offering a field addon

parametersobjectRequired

field_extensionstringOptional

The specific field extension to use for the field (only if the editor is a modern plugin)

field_extensionstringOptional

The specific field extension to use for the field (only if the editor is a modern plugin)

positionintegerOptional

Ordering index

Example:

field_typeenumOptional

Type of input

Example:

"string"

booleanOptional

colorOptional

dateOptional

date_timeOptional

fileOptional

floatOptional

galleryOptional

integerOptional

jsonOptional

lat_lonOptional

linkOptional

linksOptional

rich_textOptional

seoOptional

single_blockOptional

slugOptional

stringOptional

structured_textOptional

textOptional

videoOptional

hintstring, nullOptional

Field hint

Example:

"This field will be used as post title"

deep_filtering_enabledbooleanOptional

Whether deep filtering for block models is enabled in GraphQL or not

content_link_enabledbooleanOptional

Whether Content Link (visual editing) encoding is emitted for this field's value in the Content Delivery API. Defaults to true; can only be set to false on string, text and structured_text fields

fieldsetOptional

Fieldset linkage

Type:null, <a href="/docs/content-management-api/resources/fieldset">ResourceLinkage<"fieldset"></a>

appeareanceobjectDeprecated

Field appearance

This field contains a typo and will be removed in future versions: use appearance instead

editorstringRequired

parametersobjectRequired

Returns

Returns a resource object of type field

Examples

1
import { buildClient } from "@datocms/cma-client-node";
2

3
async function run() {
4
  const client = buildClient({ apiToken: process.env.DATOCMS_API_TOKEN });
5

6
  const fieldIdOrApiKey = "blog_post::title";
7

8
  const field = await client.fields.update(fieldIdOrApiKey, {
9
    id: "Pkg-oztERp6o-Rj76nYKJg",
10
  });
11

12
  // Check the 'Returned output' tab for the result ☝️
13
  console.log(field);
14
}
15

16
run();

1
{
2
  id: "Pkg-oztERp6o-Rj76nYKJg",
3
  label: "Title",
4
  field_type: "string",
5
  api_key: "title",
6
  localized: true,
7
  validators: { required: {} },
8
  position: 1,
9
  hint: "This field will be used as post title",
10
  default_value: { en: "A default value", it: "Un valore di default" },
11
  appearance: {
12
    editor: "single_line",
13
    parameters: { heading: false },
14
    addons: [{ id: "1234", field_extension: "lorem_ipsum", parameters: {} }],
15
  },
16
  deep_filtering_enabled: true,
17
  content_link_enabled: true,
18
  item_type: { type: "item_type", id: "DxMaW10UQiCmZcuuA-IkkA" },
19
  fieldset: null,
20
}