Excel Add-In for Microsoft SharePoint

Build 24.0.9175

AddListColumn

Adds a new column to the specified list.

Input

Name Type Required Description
List String True The name of the list on the SharePoint server.
ColumnName String True The name of the column to add.
DisplayName String False The display name of the column to add.
DefaultValue String False The default value of the column to add.
ColumnType String True The data type of the column to add. The valid options are defined by the FieldTypes available in the SharePoint API: https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15). The allowed values are 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, OutcomeChoice.

The default value is Text.

MaxLength String False The column's maximum length.
PrimaryKey Boolean False A Boolean value indicating whether the column should be the primary key.
ReadOnly Boolean False A Boolean value indicating whether the column is read only.
Required Boolean False A Boolean value indicating whether the column is required.

Result Set Columns

Name Type Description
Success Boolean A Boolean value indicating whether the operation was successful.

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