How to create SharePoint Online List Item using REST API


You can perform basic CRUD operations on SharePoint lists, libraries, sites using REST API's.
Here is an example with sample code to create list item with REST endpoint.

The post covers steps to test the query from Postman. Once tested successfully, it can be used with your code (C#, Python, Java, Power Automate, SPFX, etc.).


⚡️ Create SharePoint list item from Postman

Assumptions for this example, you have configuration like below.
- SharePoint Tenant Name = c2c
- SharePoint Site Name = SPDev
- SharePoint List Name = Projects
- SharePoint List Columns = Title, Comments
- SharePoint Add-in App is already configured with Client Id and Secret for accessing externally, refer below reference articles.

o Steps to generate SharePoint Client Id and Secret
o Steps to test SharePoint REST API from Postman


  1. Launch the Postman tool.
  2. Select POST Method for Request (refer image below).
  3. In the "Enter request URL" textbox, enter URL in this format.
  4. FORMAT --> https://[Tenant].sharepoint.com/sites/[SiteName]/_api/web/lists/GetByTitle('[ListName]')/items

    EXAMPLE --> https://c2c.sharepoint.com/sites/SPDev/_api/web/lists/GetByTitle('Projects')/items

  5. Navigate to the Header section and add below 3 KEY's (steps to generate Token)

  6. Authorization Bearer [Token]
    Accept application/json;odata=verbose
    Content-Type application/json;odata=verbose

  7. Navigate to the Body section and select raw/JSON. Copy-paste below JSON code which will create a ListItem in SharePoint List.
  8. { "__metadata": {"type": "SP.Data.ProjectsListItem"},
     "Title": "New Title 1", 
    "Comments": "This entry is created from Postman"
    }
    Important - Value for type will be in this format --> SP.Data.[ListName]ListItem

  9. Click Send button to submit the request.
  10. If all configurations are correct, you will see a success response with Status "201 Created".
  11. SharePoint REST create list item from Postman
    SharePoint REST create list item from Postman
  12. Navigate to the SharePoint list in order to confirm the list item is created successfully based on the values passed in JSON.
  13. SharePoint list item created using REST API
    SharePoint list item created using REST API

⛏️ Troubleshooting

You may face some errors/exceptions while working with SharePoint REST API's using Postman, here are solutions to some common problems.

403 Forbidden - UnauthorizedAccessException - Access denied

<?xml version="1.0" encoding="utf-8"?>
<m:error xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    <m:code>-2147024891, System.UnauthorizedAccessException</m:code>
    <m:message xml:lang="en-US">Access denied. You do not have permission to perform this action or access this resource.</m:message>
</m:error>
SharePoint REST create list item - 403 Access denied error
SharePoint REST create list item - 403 Access denied error

Solution - You are missing the Authorization Key in Headers, Postman used the bearer token to connect to SharePoint. Refer earlier steps to add Authorization key in Header section and how to generate the token.



400 Bad Request - InvalidClientQueryException - An unexpected 'PrimitiveValue' node was found

{
    "error": {
        "code": "-1, Microsoft.SharePoint.Client.InvalidClientQueryException",
        "message": {
            "lang": "en-US",
            "value": "An unexpected 'PrimitiveValue' node was found when reading from the JSON reader. A 'StartObject' node was expected."
        }
    }
}
SharePoint REST create list item - PrimitiveValue node found error
SharePoint REST create list item - PrimitiveValue node found error

Solution - Most probably, your JSON is not well formed. Check for additional or missing braces, quotes. There are many online tools available to validate JSON, use them to fix the JSON code before using.



400 Bad Request - InvalidClientQueryException - The property '__metadata' does not exist

{
    "error": {
        "code": "-1, Microsoft.SharePoint.Client.InvalidClientQueryException",
        "message": {
            "lang": "en-US",
            "value": "The property '__metadata' does not exist on type 'SP.Data.ProjectsListItem'. Make sure to only use property names that are defined by the type."
        }
    }
}
SharePoint REST create list item - property metadata does not exist error
SharePoint REST create list item - property metadata does not exist error

Solution - Ensure that the Content-Type request header value is application/json;odata=verbose and not application/json.


Now you can use this code in SPFX web part (modern), or JQuery + HTML (classic), or may be even directly embed in Content Editor web part / Script Editor web part.
Try to extend the basic code to build more complex queries like adding a lookup value, adding user in a people picker field, add values to Managed Metadata columns, etc.



Have Questions? Post them here!



Recent Posts:




Code2care is an initiative to publish and share varied knowledge in programming and technical areas gathered during day-to-day learnings and development activities.

Students and Software Developers can leverage this portal to find solutions to their various queries without re-inventing the wheel by referring to our easy to understand posts. Technical posts might include Learnings, Video Tutorials, Code Snippets, How Tos, Blogs, Articles, etc.