Content Management API > Record

Validate an existing record

Warning: Experimental API

Please note that this API method is marked as unstable and should be avoided in production environments. Changes may occur at any time without warning, potentially impacting your scripts. We recommend contacting our Support Team to explore alternative approaches that are safer and more reliable!

Checks an update payload for an existing record without saving it. The payload has the same shape as the one for Update a record, and goes through the same checks: the attributes you send are merged with the record's current version, then every field and every nested block is validated against its model.

The response is 204 No Content when the payload is valid, or a 422 with INVALID_FIELD errors when it is not. Nothing is saved.

⚠️ Block records are not accepted

The ID in the URL must belong to a record of a regular model. If it belongs to a block, the endpoint returns 404 NOT_FOUND. A block cannot be validated on its own: validate the payload of the record that contains it instead.

Body parameters

id string Required

RFC 4122 UUID of record expressed in URL-safe base64 format

Example:

"hWl-mnkWRYmMCSTq4z_piQ"

type string Required

Must be exactly "item".

relationships.item_type.data Optional

The record's model

Type: ResourceLinkage<"item_type">

relationships.creator.data Optional

The entity (account/collaborator/access token/sso user) who created the record

Type: ResourceLinkage<"account">, ResourceLinkage<"access_token">, ResourceLinkage<"user">, ResourceLinkage<"sso_user">, ResourceLinkage<"organization">

Examples

1
POST https://site-api.datocms.com/items/:item_id/validate HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "id": "hWl-mnkWRYmMCSTq4z_piQ",
10
    "type": "item",
11
    "attributes": {
12
      "title": "My first blog post!",
13
      "content": "Lorem ipsum dolor sit amet...",
14
      "category": "24",
15
      "image": {
16
        "upload_id": "WxrWMPl3TjeSJYcl6lNCbg",
17
        "alt": "Alt text",
18
        "title": "Image title",
19
        "custom_data": {}
20
      }
21
    }
22
  }
23
}

1
curl -g 'https://site-api.datocms.com/items/:item_id/validate' \
2
  -X POST \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"id":"hWl-mnkWRYmMCSTq4z_piQ","type":"item","attributes":{"title":"My first blog post!","content":"Lorem ipsum dolor sit amet...","category":"24","image":{"upload_id":"WxrWMPl3TjeSJYcl6lNCbg","alt":"Alt text","title":"Image title","custom_data":{}}}}}'

1
await fetch("https://site-api.datocms.com/items/:item_id/validate", {
2
  method: "POST",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
    "Content-Type": "application/vnd.api+json",
8
  },
9
  body: JSON.stringify({
10
    data: {
11
      id: "hWl-mnkWRYmMCSTq4z_piQ",
12
      type: "item",
13
      attributes: {
14
        title: "My first blog post!",
15
        content: "Lorem ipsum dolor sit amet...",
16
        category: "24",
17
        image: {
18
          upload_id: "WxrWMPl3TjeSJYcl6lNCbg",
19
          alt: "Alt text",
20
          title: "Image title",
21
          custom_data: {},
22
        },
23
      },
24
    },
25
  }),
26
});