Sorry, no results found for "".

Show examples in:
Javascript HTTP
Endpoint info
Available examples

Content Management API > Field

Update a field

Body parameters

default_value Optional

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" }
label string Optional

The label of the field

Example: "Title"
api_key string Optional

Field API key

Example: "title"
localized boolean Optional

Whether the field needs to be multilanguage or not

validators object Optional

Optional field validations

Example: { required: {} }
appearance object Optional

Field appearance details, plugin configuration and field add-ons

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

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

parameters object Required

The editor plugin's parameters

addons Required

An array of add-on plugins with id and parameters

Type: Array<object>
id string Required

The ID of a plugin offering a field addon

parameters object Required
field_extension string Optional

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

field_extension string Optional

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

position integer Optional

Ordering index

Example: 1
field_type enum Optional

Type of input

Example: "string"
boolean Optional
color Optional
date Optional
date_time Optional
file Optional
float Optional
gallery Optional
integer Optional
json Optional
lat_lon Optional
link Optional
links Optional
rich_text Optional
seo Optional
single_block Optional
slug Optional
string Optional
structured_text Optional
text Optional
video Optional
hint string, null Optional

Field hint

Example: "This field will be used as post title"
deep_filtering_enabled boolean Optional

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

fieldset Optional

Fieldset linkage

appeareance object Deprecated

Field appearance

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

editor string Required
parameters object Required

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
item_type: { type: "item_type", id: "DxMaW10UQiCmZcuuA-IkkA" },
18
fieldset: null,
19
}