CData Python Connector for Microsoft SharePoint

Build 25.0.9454

UpdateListColumn

Updates the properties of an existing column in a SharePoint list. Useful for modifying column attributes without recreating the structure.

Input

Name Type Required Description
List String True The name or globally unique identifier (GUID) of the SharePoint list that contains the column to be updated.
ColumnName String True The internal name of the column that you want to update.
DisplayName String False The new display name for the column, which appears in SharePoint interfaces.
DefaultValue String False The new default value assigned to the column if no other value is specified.
ColumnType String False The new data type of the column. The valid options are defined by the FieldTypes available in the SharePoint API: https://learn.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15). Allowed values include Integer, Text, Note, DateTime, Counter, Choice, Lookup, Boolean, Number, Currency, URL, Computed, Threading, Guid, MultiChoice, GridChoice, Calculated, File, Attachments, User, Recurrence, CrossProjectLink, ModStat, Error, ContentTypeId, PageSeparator, ThreadIndex, WorkflowStatus, AllDayEvent, WorkflowEventType, Geolocation, and OutcomeChoice.
MaxLength Integer False The new maximum number of characters allowed for the column (applies to text-based fields).
PrimaryKey Boolean False Set to 'true' if the column should be designated as the primary key for the list.
ReadOnly Boolean False Set to 'true' if the column should be marked as read-only, preventing users from editing its value in New or Edit forms.
Required Boolean False Set to 'true' if the column must have a value before an item can be saved.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the column update was successful. Returns 'true' if the operation was successful, otherwise 'false'.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454