Content Management API > Schema Menu Item

Update a schema menu item

Body parameters

type string Required

Must be exactly "schema_menu_item". JSON API type field

attributes.label null, string Optional

The label of the schema menu item (only present when the schema menu item is not linked to an item type)

Example:

"Posts"

attributes.position integer Optional

Ordering index

Example:

attributes.kind enum Optional

Indicates if the schema menu item refers to an item type or a modular block

Example:

"item_type"

item_type Optional

modular_block Optional

relationships.item_type.data Optional

Item type associated with the menu item

Type: ResourceLinkage<"item_type">, null

relationships.parent.data Optional

Parent schema menu item

Type: null, ResourceLinkage<"schema_menu_item">

relationships.children.data Optional

Underlying schema menu items

Type: Array<ResourceLinkage<"schema_menu_item">>

Returns

Returns a resource object of type schema_menu_item.

Examples

1
PUT https://site-api.datocms.com/schema-menu-items/:schema_menu_item_id 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
    "type": "schema_menu_item",
10
    "id": "uinr2zfqQLeCo_1O0-ao-Q"
11
  }
12
}

1
curl -g 'https://site-api.datocms.com/schema-menu-items/:schema_menu_item_id' \
2
  -X PUT \
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":{"type":"schema_menu_item","id":"uinr2zfqQLeCo_1O0-ao-Q"}}'

1
await fetch(
2
  "https://site-api.datocms.com/schema-menu-items/:schema_menu_item_id",
3
  {
4
    method: "PUT",
5
    headers: {
6
      Authorization: "Bearer YOUR-API-TOKEN",
7
      Accept: "application/json",
8
      "X-Api-Version": "3",
9
      "Content-Type": "application/vnd.api+json",
10
    },
11
    body: JSON.stringify({
12
      data: { type: "schema_menu_item", id: "uinr2zfqQLeCo_1O0-ao-Q" },
13
    }),
14
  },
15
);

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "schema_menu_item",
10
    "id": "uinr2zfqQLeCo_1O0-ao-Q",
11
    "relationships": {
12
      "item_type": {
13
        "data": {
14
          "type": "item_type",
15
          "id": "DxMaW10UQiCmZcuuA-IkkA"
16
        }
17
      },
18
      "parent": {
19
        "data": null
20
      },
21
      "children": {
22
        "data": [
23
          {
24
            "type": "schema_menu_item",
25
            "id": "uinr2zfqQLeCo_1O0-ao-Q"
26
          }
27
        ]
28
      }
29
    },
30
    "attributes": {
31
      "label": "Posts",
32
      "position": 1,
33
      "kind": "item_type"
34
    }
35
  }
36
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.