(PowerShell) SharePoint -- Update List

See more SharePoint Examples

This example shows how to update a SharePoint (to change the value of a list property, such as Title).

For more information, see https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
$http.Login = "SHAREPOINT_USERNAME"
$http.Password = "SHAREPOINT_PASSWORD"
$http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
$http.NtlmAuth = $true

# The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
# If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
# establish the cookie as shown at SharePoint Online Authentication

# To create a list, we're going to POST to
# https://SHAREPOINT_HTTPS_DOMAIN/_api/web/lists(guid'{list_guid}')
# with a request body containing the following JSON:
# 
# {
#   "__metadata": {
#     "type": "SP.List"
#   },
#   "Title": "New title"
# }

# In this case, the list_guid is "b0d92cec-4be1-4e52-943d-ebcb432e1c3b"
$req = New-Object Chilkat.HttpRequest
$req.HttpVerb = "POST"
$req.Path = "/_api/web/lists(guid'b0d92cec-4be1-4e52-943d-ebcb432e1c3b')"

# We need to add a form digest value in the X-RequestDigest header field.
# See this example for details on
# how to get (and cache) a form digest value
$req.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

# Set the Content-Type, and indicate that a JSON response is desired.
$req.ContentType = "application/json;odata=verbose"
$req.AddHeader("Accept","application/json;odata=verbose")

# Create and add the JSON body.
# Use this online tool to generate code from sample JSON: 
# Generate Code to Create JSON
$json = New-Object Chilkat.JsonObject
$json.UpdateString("__metadata.type","SP.List")
$json.UpdateString("Title","New title")

# Send the POST using HTTPS (TLS). Port 443 is the default port for https.
$bUseTls = $true
$resp = $http.SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,$bUseTls,$req)
if ($http.LastMethodSuccess -ne $true) {
    $($http.LastErrorText)
    exit
}

# The response body contains JSON.
$json.Load($resp.BodyStr)
$json.EmitCompact = $false

# The expected success response code is 201.
# (Let's also check for 200, just in case things change..)
if (($resp.StatusCode -ne 200) -and ($resp.StatusCode -ne 201)) {
    $("Response status code = " + $resp.StatusCode)
    $($json.Emit())
    $("Failed")

    exit
}

# Show the successful JSON response.
$($json.Emit())
$("Success.")

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON