Create a new item in a list

Create a new listItem in a list.

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.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application Sites.ReadWrite.All

HTTP request

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

Request body

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

Example

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

POST https://graph.microsoft.com/v1.0/sites/{site-id}/lists/{list-id}/items
Content-Type: application/json

{
  "fields": {
    "Title": "Widget",
    "Color": "Purple",
    "Weight": 32
  }
}

Response

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

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

{
  "id": "20",
  "createdDateTime": "2016-08-30T08:26: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"
    }
  }
}

SDK sample code


const options = {
	authProvider,
};

const client = Client.init(options);

const listItem = {
  fields: {
    Title: "Widget",
    Color: "Purple",
    Weight: 32
  }
};

let res = await client.api('/sites/{site-id}/lists/{list-id}/items')
	.post({listItem : listItem});

Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

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