Show examples in:
JavascriptHTTP
Endpoint info
Available examples
Content Management API > Field

Update a field

Body parameters

typestringRequired

Must be exactly "field".

attributes.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" }
attributes.labelstringOptional

The label of the field

Example:"Title"
attributes.api_keystringOptional

Field API key

Example:"title"
attributes.localizedbooleanOptional

Whether the field needs to be multilanguage or not

attributes.validatorsobjectOptional

Optional field validations

Example:{ required: {} }
attributes.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)

attributes.positionintegerOptional

Ordering index

Example:1
attributes.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
attributes.hintstring, nullOptional

Field hint

Example:"This field will be used as post title"
attributes.deep_filtering_enabledbooleanOptional

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

attributes.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

relationships.fieldset.dataOptional

Fieldset linkage

Type:null, <a href="/docs/content-management-api/resources/fieldset">ResourceLinkage&#x3C;"fieldset"></a>
attributes.appeareanceobjectDeprecated

Field appearance

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

editorstringRequired
parametersobjectRequired

Returns

Returns a Job ID. You can then poll for thecompletion of the jobthat will eventually return a resource object of type field

Examples

The response contains the ID of the asynchronous job that started:

PUT https://site-api.datocms.com/fields/:field_id_or_api_key HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Content-Type: application/vnd.api+json
{
"data": {
"type": "field",
"id": "Pkg-oztERp6o-Rj76nYKJg"
}
}
Terminal window
curl -g 'https://site-api.datocms.com/fields/:field_id_or_api_key' \
-X PUT \
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3" \
-H "Content-Type: application/vnd.api+json" \
--data-binary '{"data":{"type":"field","id":"Pkg-oztERp6o-Rj76nYKJg"}}'
await fetch("https://site-api.datocms.com/fields/:field_id_or_api_key", {
method: "PUT",
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
"Content-Type": "application/vnd.api+json",
},
body: JSON.stringify({
data: { type: "field", id: "Pkg-oztERp6o-Rj76nYKJg" },
}),
});
HTTP/1.1 202 Accepted
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"data": {
"type": "job",
"id": "4235"
}
}

To get the asynchronous job result, poll the job result endpoint. While the task is in progress, the endpoint returns a 404 status code. When the job completes, the status changes to 200 OK:

GET https://site-api.datocms.com/job-results/:job_result_id HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Terminal window
curl -g 'https://site-api.datocms.com/job-results/:job_result_id' \
\
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3"
await fetch("https://site-api.datocms.com/job-results/:job_result_id", {
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
},
});
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"data": {
"type": "job_result",
"id": "34",
"attributes": {
"status": 200,
"payload": {
"data": {
"type": "field",
"id": "Pkg-oztERp6o-Rj76nYKJg",
"attributes": {
"label": "Title",
"field_type": "string",
"api_key": "title",
"localized": true,
"validators": {
"required": {}
},
"position": 1,
"hint": "This field will be used as post title",
"default_value": {
"en": "A default value",
"it": "Un valore di default"
},
"appearance": {
"editor": "single_line",
"parameters": {
"heading": false
},
"addons": [
{
"id": "1234",
"field_extension": "lorem_ipsum",
"parameters": {}
}
]
},
"deep_filtering_enabled": true,
"content_link_enabled": true
},
"relationships": {
"item_type": {
"data": {
"type": "item_type",
"id": "DxMaW10UQiCmZcuuA-IkkA"
}
},
"fieldset": {
"data": null
}
}
}
}
}
}
}