Create a new list

Create a new list in a site.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Sites.Manage.All
Delegated (personal Microsoft account) Not supported.
Application Sites.ReadWrite.All

HTTP request

POST https://graph.microsoft.com/v1.0/sites/{site-id}/lists

Request body

In the request body, supply a JSON representation of the list resource to create.

Example

Here is an example of how to create a new generic list.

POST /sites/{site-id}/lists
Content-Type: application/json

{
  "displayName": "Books",
  "columns": [
    {
      "name": "Author",
      "text": { }
    },
    {
      "name": "PageCount",
      "number": { }
    }
  ],
  "list": {
    "template": "genericList"
  }
}

Note: Custom columns are optional.

In addition to any columns specified here, new lists are created with columns defined in the referenced template. If the list facet or template is unspecified, the list defaults to the genericList template, which includes a Title column.

Response

If successful, this method returns a list in the response body for the created list.

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "22e03ef3-6ef4-424d-a1d3-92a337807c30",
  "createdDateTime": "2017-04-30T01:21:00Z",
  "createdBy": {
    "user": {
      "displayName": "Ryan Gregg",
      "id": "8606e4d5-d582-4f5f-aeba-7d7c18b20cfd"
    }
  },
  "lastModifiedDateTime": "2016-08-30T08:26:00Z",
  "lastModifiedBy": {
    "user": {
      "displayName": "Ryan Gregg",
      "id": "8606e4d5-d582-4f5f-aeba-7d7c18b20cfd"
    }
  }
}

Note: The response object is truncated for clarity. Default properties will be returned from the actual call.