author | description | title | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
spgraph-docs-team |
Create a new list in a site. |
Create a SharePoint List |
medium |
sharepoint |
apiPageType |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
POST /sites/{site-id}/lists
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
In the request body, supply a JSON representation of a list object.
If successful, this method returns a 201 Created
response code and a list object in the response body.
The following is an example of how to create a new generic list.
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 not specified, the list defaults to the genericList
template, which includes a Title column.
POST https://graph.microsoft.com/beta/sites/{site-id}/lists
Content-Type: application/json
{
"displayName": "Books",
"columns": [
{
"name": "Author",
"text": { }
},
{
"name": "PageCount",
"number": { }
}
],
"list": {
"template": "genericList"
}
}
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
Note: The response object is truncated for clarity. Default properties will be returned from the actual call.
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"
}
}
}