Content Management API > Menu Item

Create a new menu item

Body parameters

id string Optional

RFC 4122 UUID of menu item expressed in URL-safe base64 format

Example:

"uinr2zfqQLeCo_1O0-ao-Q"

type string Required

Must be exactly "menu_item".

attributes.label string Required

The label of the menu item

Example:

"Posts"

attributes.external_url null, string Optional

The URL to which the menu item points to

attributes.position integer Optional

Ordering index

Example:

attributes.open_in_new_tab boolean Optional

Opens link in new tab (to be used together with external_url)

relationships.item_type.data Optional

Item type associated with the menu item

Type: ResourceLinkage<"item_type">, null

relationships.item_type_filter.data Optional

Item type filter associated with the menu item (to be used together with item_type relationship)

Type: ResourceLinkage<"item_type_filter">, null

relationships.parent.data Optional

Parent menu item

Type: null, ResourceLinkage<"menu_item">

Returns

Returns a resource object of type menu_item.

Examples

1
POST https://site-api.datocms.com/menu-items 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": "menu_item",
10
    "attributes": {
11
      "label": "Posts"
12
    }
13
  }
14
}

1
curl -g 'https://site-api.datocms.com/menu-items' \
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":{"type":"menu_item","attributes":{"label":"Posts"}}}'

1
await fetch("https://site-api.datocms.com/menu-items", {
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: { type: "menu_item", attributes: { label: "Posts" } },
11
  }),
12
});

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": "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
      "item_type_filter": {
19
        "data": {
20
          "type": "item_type_filter",
21
          "id": "FF-P5of6Qp-DD2w0xoaa6Q"
22
        }
23
      },
24
      "parent": {
25
        "data": null
26
      },
27
      "children": {
28
        "data": [
29
          {
30
            "type": "menu_item",
31
            "id": "uinr2zfqQLeCo_1O0-ao-Q"
32
          }
33
        ]
34
      }
35
    },
36
    "attributes": {
37
      "label": "Posts",
38
      "position": 1,
39
      "external_url": "",
40
      "open_in_new_tab": true
41
    }
42
  }
43
}

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.