Update a model/block model
Body parameters
Must be exactly "item_type".
Name of the model/block model
"Blog post"
API key of the model/block model
"post"
The way the model/block model collection should be presented to the editors
"compact"
Compact view
Tabular view
Whether the model is single-instance or not. This property only applies to models, not block models
Whether we require all the project locales to be present for each localized field or not
Whether editors can sort records via drag & drop or not. Must be false for block models
Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
Whether draft/published mode is active or not. Must be false for block models
Whether draft records can be saved without satisfying the validations or not. Must be false for block models
Whether editors can organize records in a tree or not. Must be false for block models
If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
Ascending order
Descending order
Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
"created_at"
Order by date of creation
Order by date of last update
Order by date of first publication
Order by date of last publication
A hint shown to editors to help them understand the purpose of this model/block model
"Blog posts will be shown in our website under the Blog section"
Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
The field upon which the collection is sorted. This relationship does not apply to block models
The field to use as presentation title
The field to use as presentation image
The field to use as fallback title for SEO purposes. This relationship does not apply to block models
The field to use as fallback image for SEO purposes. This relationship does not apply to block models
The field to use as fallback description for SEO purposes. This relationship does not apply to block models
The workflow to enforce on records
The way the model collection should be presented to the editors
This field contains a typo and will be removed in future versions: use collection_appearance instead
"compact"
Compact view
Tabular view
Returns
Returns a Job ID. You can then poll for thecompletion of the jobthat will eventually return a resource object of type item_type
Examples
The response contains the ID of the asynchronous job that started:
PUT https://site-api.datocms.com/item-types/:model_id_or_api_key HTTP/1.1Authorization: Bearer YOUR-API-TOKENAccept: application/jsonX-Api-Version: 3Content-Type: application/vnd.api+json
{ "data": { "type": "item_type", "id": "DxMaW10UQiCmZcuuA-IkkA" }}curl -g 'https://site-api.datocms.com/item-types/:model_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":"item_type","id":"DxMaW10UQiCmZcuuA-IkkA"}}'await fetch("https://site-api.datocms.com/item-types/:model_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: "item_type", id: "DxMaW10UQiCmZcuuA-IkkA" }, }),});HTTP/1.1 202 AcceptedContent-Type: application/jsonCache-Control: cache-control: max-age=0, private, must-revalidateX-RateLimit-Limit: 30X-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.1Authorization: Bearer YOUR-API-TOKENAccept: application/jsonX-Api-Version: 3curl -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 OKContent-Type: application/jsonCache-Control: cache-control: max-age=0, private, must-revalidateX-RateLimit-Limit: 30X-RateLimit-Remaining: 28
{ "data": { "type": "job_result", "id": "34", "attributes": { "status": 200, "payload": { "data": { "type": "item_type", "id": "DxMaW10UQiCmZcuuA-IkkA", "relationships": { "singleton_item": { "data": null }, "fields": { "data": [ { "type": "field", "id": "Pkg-oztERp6o-Rj76nYKJg" } ] }, "fieldsets": { "data": [ { "type": "fieldset", "id": "93Y1C2sySkG4Eg0atBRIwg" } ] }, "presentation_title_field": { "data": null }, "presentation_image_field": { "data": null }, "title_field": { "data": null }, "image_preview_field": { "data": null }, "excerpt_field": { "data": null }, "ordering_field": { "data": null }, "workflow": { "data": null } }, "attributes": { "name": "Blog post", "api_key": "post", "singleton": false, "sortable": true, "modular_block": false, "tree": false, "ordering_direction": null, "ordering_meta": "created_at", "draft_mode_active": false, "all_locales_required": false, "collection_appearance": "compact", "hint": "Blog posts will be shown in our website under the Blog section", "inverse_relationships_enabled": false, "draft_saving_active": false }, "meta": { "has_singleton_item": false } } } } }}