Plumsail SP

To know more please visit https://plumsail.com/actions/

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Standard All Flow regions except the following:
     -   US Government (GCC)
PowerApps Standard All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
Access Key securestring

The Access Key for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Activate SharePoint Feature

Activate a feature with specific ID

Add Content Type to SharePoint List

Adds the specified content type to a SharePoint list

Add User to SharePoint Group

Adds a user to a specific SharePoint group

Change SharePoint permissions

Grant, remove and restore permissions for the site, the list, and the item

Check In SharePoint Document

Check-in the document at the specified URL with the specified comment

Check Out SharePoint Document

Check-out the document at the specified URL

Copy List Item to SharePoint List

Copies the specified list item to another SharePoint list

Copy SharePoint Document from Library

Copies the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder

Copy SharePoint Document Set

Copies the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder

Copy SharePoint Folder from Library

Copies the folder from the document library to the specified URL. You can copy the folder to another document library cross-site or to another folder

Copy SharePoint Item Attachments to URL

Copies attachments from the SharePoint list item to the library using the specified folder URL

Create Modern SharePoint Site

Creates a modern SharePoint Team or Communication site

Create SharePoint Document Set

Creates a new document set in the document library by the specified URL

Create SharePoint Folder by URL

Creates a new folder in the document library by the specified URL

Create SharePoint Folder in List

Creates a new folder in the document library or list using the specified path

Create SharePoint Group

Creates the SharePoint group with a specified name

Create SharePoint List or Library

Create list or library by template

Create SharePoint Site from Template

Create a new SharePoint site based on specific template

Delete SharePoint Site

Deletes the SharePoint site by a specific URL

Get Members of SharePoint Group

Gets members of a specific SharePoint group

Get SharePoint Item Versions History

Returns the changes history for the specific field from the SharePoint list item

Get SharePoint Items By CAML Query

Executes a CAML query on a list or on a document library and returns the collection of elements

Get SharePoint Site Option Value

Reads a value from SharePoint Site Options (Property Bag)

Invite External User to SharePoint

Invites external users with specific permission to an SharePoint site, an specific SharePoint group or an item in a SharePoint list

Is User Member of SharePoint Group

Checks if a user is a member of a specifed SharePoint group

Move List Item to SharePoint List

Moves the specified list item to another SharePoint list

Move SharePoint Document from Library

Moves the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder

Move SharePoint Document Set

Moves the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder

Move SharePoint Folder from Library

Moves the folder from the document library to the specified URL. You can move the folder to another document library cross-site or to another folder

Move SharePoint Item Attachments to URL

Moves attachments from the SharePoint list item to the library using the specified folder URL

Provision PnP Template to SharePoint

Applies a PnP template to a SharePoint site

Remove SharePoint Document by URL

Remove the document by a specific URL

Remove SharePoint Folder by URL

Removes the folder from the document library or list by the specified URL

Remove SharePoint Group

Removes the SharePoint group by a specified name

Remove User from SharePoint Group

Removes a user from a specific SharePoint group

Set Default SharePoint Site Group

Configure default groups for the site it is analog of the permsetup.aspx page

Start SharePoint List Workflow (2013)

Starts a SharePoint list level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows

Start SharePoint Site Workflow (2013)

Starts a SharePoint site level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows

Update SharePoint Group Properties

Updates SharePoint group properties like AutoAcceptRequestToJoinLeave, AllowMembersEditMembership or other options described in MSDN

Update SharePoint Site Properties

Updates web properties like Title, Description or other string options described in at MSDN

Activate SharePoint Feature

Activate a feature with specific ID

Parameters

Name Key Required Type Description
Feature ID
featureId True uuid

Guid of the feature

Force
force boolean

true to force activation of the Feature even if there are errors; otherwise, false

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Add Content Type to SharePoint List

Adds the specified content type to a SharePoint list

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Content Type Name
contentTypeName True string

Name of the content type

Make It Default
makeItDefault boolean

Make the content type default for the list

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Add User to SharePoint Group

Adds a user to a specific SharePoint group

Parameters

Name Key Required Type Description
Group Name
groupName True string

The name of the group

User
userLogin True string

Login or email of the user which will be added to the specific group. Also you can specify multiple items using semicolon ';' delimited

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Change SharePoint permissions

Grant, remove and restore permissions for the site, the list, and the item

Parameters

Name Key Required Type Description
Action type
actionType True string

The type of the operation

Target
target True string

The target of the operation

request
request True dynamic

The type of the operation

Check In SharePoint Document

Check-in the document at the specified URL with the specified comment

Parameters

Name Key Required Type Description
Comment
comment string

The comment to accompany document check in

Document URL
documentUrl True string

The URL of the document to check in

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Check Out SharePoint Document

Check-out the document at the specified URL

Parameters

Name Key Required Type Description
Document URL
documentUrl True string

The URL of the document to check in

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy List Item to SharePoint List

Copies the specified list item to another SharePoint list

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Item ID
itemId True integer

The ID of the source item

Destination List URL
destinationListUrl True string

The URL of the destination list. This list must contain same fields like in the source list

Copy Attachments
copyAttachments boolean

Copy the item with attached files or not

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy SharePoint Document from Library

Copies the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder

Parameters

Name Key Required Type Description
Source URL
sourceUrl True string

The URL of the document to be copied. You can use full URL as well as domain relative URL

Destination URL
destinationUrl True string

The URL where the source document will be copied. You can use full URL as well as domain relative URL

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy SharePoint Document Set

Copies the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder

Parameters

Name Key Required Type Description
Source URL
sourceUrl True string

The URL of the document set to be copied. You can use full URL as well as domain relative URL

Destination URL
destinationUrl True string

The URL where the source document set will be copied. You can use full URL as well as domain relative URL. If the URL ends with slash '/' the document sets will be placed in this folder without name changes. Otherwise the document set will be renamed

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy SharePoint Folder from Library

Copies the folder from the document library to the specified URL. You can copy the folder to another document library cross-site or to another folder

Parameters

Name Key Required Type Description
Source URL
sourceUrl True string

The URL of the folder to be copied. You can use full URL as well as domain relative URL

Destination URL
destinationUrl True string

The URL where the source folder will be copied. You can use full URL as well as domain relative URL

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy SharePoint Item Attachments to URL

Copies attachments from the SharePoint list item to the library using the specified folder URL

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Item ID
itemId True integer

The ID of the source item

Destination Folder URL
destinationUrl True string

The URL of the folder where the attachments will be copied

Overwrite
overwrite boolean

Overwrite if a file with the same name already exists

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Create Modern SharePoint Site

Creates a modern SharePoint Team or Communication site

Parameters

Name Key Required Type Description
Site Type
siteType True string

The type of the site for create

request
request True dynamic

The type of the site for create

Returns

Create SharePoint Document Set

Creates a new document set in the document library by the specified URL

Parameters

Name Key Required Type Description
DocumentSet Name
documentSetName True string

The name of the document set

Target List
targetListUrl True string

The name or the URL of a library or a list where the document set will be created. You can use full URL as well as domain relative URL

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Create SharePoint Folder by URL

Creates a new folder in the document library by the specified URL

Parameters

Name Key Required Type Description
Folder URL
folderUrl True string

The URL of the folder. If you specify full path, you can create several folders

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Create SharePoint Folder in List

Creates a new folder in the document library or list using the specified path

Parameters

Name Key Required Type Description
Target List
targetListUrl True string

The name or the URL of a library or a list where the folder will be created. You can use full URL as well as domain relative URL

Folder Path
folderPath True string

The path where the folder will be created. The action will create all folders included into the path

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Create SharePoint Group

Creates the SharePoint group with a specified name

Parameters

Name Key Required Type Description
Group Name
groupName True string

The name of the group

Group Description
groupDescription string

The description of the group

Group Owner
userLogin string

The owner of the group, can be email or the user login

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Create SharePoint List or Library

Create list or library by template

Parameters

Name Key Required Type Description
Title
title True string

Title of the list

Template
template True string

Title of the template that will be used for this list

Partial URL
partialUrl string

Partial url of the list

Description
description string

Description of the list

On Quick Launch
onQuickLaunch boolean

Display this list on the Quick Launch

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Create SharePoint Site from Template

Create a new SharePoint site based on specific template

Parameters

Name Key Required Type Description
Title
title True string

Title of new site

Template
template True string

Title of the site template that will be used for the new site

Leaf URL
leafUrl True string

A string that represents the URL leaf name

Description
description string

Description of the web

Lcid
lcid integer

LCID of the new web

Inherit Permissions
inheritPermissions boolean

Specifies whether the new site will inherit permissions from its parent site

Inherit Navigation
inheritNavigation boolean

Specifies whether the site inherits navigation

On Top Navigation
onTopNav boolean

Display this site on the top link bar of the parent site. Default value is Yes

On Quick Launch
onQuickLaunch boolean

Display this site on the Quick Launch of the parent site. Default value is No

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Delete SharePoint Site

Deletes the SharePoint site by a specific URL

Parameters

Name Key Required Type Description
SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Get Members of SharePoint Group

Gets members of a specific SharePoint group

Parameters

Name Key Required Type Description
Group Name
groupName True string

The name of the group

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Get SharePoint Item Versions History

Returns the changes history for the specific field from the SharePoint list item

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Item ID
itemId True integer

Item ID of the item for which you want to get the version history

Field Name
fieldName True string

Name of the field for which you want to get the version history

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Get SharePoint Items By CAML Query

Executes a CAML query on a list or on a document library and returns the collection of elements

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Folder URL
folderUrl string

The server relative URL of a list folder from which results will be returned

CAML Query
camlQuery True string

CAML query that will be run

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

The outputs of this operation are dynamic.

Get SharePoint Site Option Value

Reads a value from SharePoint Site Options (Property Bag)

Parameters

Name Key Required Type Description
Option Name
optionName True string

Name of the option

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Invite External User to SharePoint

Invites external users with specific permission to an SharePoint site, an specific SharePoint group or an item in a SharePoint list

Parameters

Name Key Required Type Description
Target
target True string

The target of the operation

request
request True dynamic

The target of the operation

Is User Member of SharePoint Group

Checks if a user is a member of a specifed SharePoint group

Parameters

Name Key Required Type Description
Group Name
groupName True string

The name of the group

User
userLogin True string

Login or email of a user for checking if he is a member in the specified group

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move List Item to SharePoint List

Moves the specified list item to another SharePoint list

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Item ID
itemId True integer

The ID of the source item

Destination List URL
destinationListUrl True string

The URL of the destination list. This list must contain same fields like in the source list

Move Attachments
copyAttachments boolean

Move the item with attached files or not

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move SharePoint Document from Library

Moves the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder

Parameters

Name Key Required Type Description
Source URL
sourceUrl True string

The URL of the document to be moved. You can use full URL as well as domain relative URL

Destination URL
destinationUrl True string

The URL where the source document will be moved. You can use full URL as well as domain relative URL

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move SharePoint Document Set

Moves the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder

Parameters

Name Key Required Type Description
Source URL
sourceUrl True string

The URL of the document set to be moved. You can use full URL as well as domain relative URL

Destination URL
destinationUrl True string

The URL where the source document set will be moved. You can use full URL as well as domain relative URL. If the URL ends with slash '/' the document sets will be placed in this folder without name changes. Otherwise the Document set will be renamed

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move SharePoint Folder from Library

Moves the folder from the document library to the specified URL. You can move the folder to another document library cross-site or to another folder

Parameters

Name Key Required Type Description
Source URL
sourceUrl True string

The URL of the folder to be moved. You can use full URL as well as domain relative URL

Destination URL
destinationUrl True string

The URL where the source folder will be moved. You can use full URL as well as domain relative URL

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move SharePoint Item Attachments to URL

Moves attachments from the SharePoint list item to the library using the specified folder URL

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Item ID
itemId True integer

The ID of the source item

Destination Folder URL
destinationUrl True string

The URL of the folder where the attachments will be moved

Overwrite
overwrite boolean

Overwrite if a file with the same name already exists

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Provision PnP Template to SharePoint

Applies a PnP template to a SharePoint site

Parameters

Name Key Required Type Description
Xml Template Content
xmlTemplateContent True byte

The content of an XML template

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Remove SharePoint Document by URL

Remove the document by a specific URL

Parameters

Name Key Required Type Description
Document URL
sourceUrl True string

The URL of the document to be removed. You can use full URL as well as domain relative URL

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Remove SharePoint Folder by URL

Removes the folder from the document library or list by the specified URL

Parameters

Name Key Required Type Description
Folder URL
sourceUrl True string

The URL of the library where the source folder will be removed. You can use full URL as well as domain relative URL

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Remove SharePoint Group

Removes the SharePoint group by a specified name

Parameters

Name Key Required Type Description
Group Name
groupName True string

The name of the group

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Remove User from SharePoint Group

Removes a user from a specific SharePoint group

Parameters

Name Key Required Type Description
Group Name
groupName True string

The name of the group

User
userLogin True string

Login or email of the user which will be removed from the specific group. Also you can specify multiple items using semicolon ';' delimited

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Set Default SharePoint Site Group

Configure default groups for the site it is analog of the permsetup.aspx page

Parameters

Name Key Required Type Description
Group Type
groupType True string

Type of the group

Group Name
groupName True string

Name of the group

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Start SharePoint List Workflow (2013)

Starts a SharePoint list level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows

Parameters

Name Key Required Type Description
List URL
listUrl True string

List name, URL or Guid

Item ID
itemId True integer

Item ID of the item for which you want to start the list workflow

Workflow Name
workflowName True string

Name of the workflow which will be started

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Start SharePoint Site Workflow (2013)

Starts a SharePoint site level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows

Parameters

Name Key Required Type Description
Workflow Name
workflowName True string

Name of the workflow which will be started

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Update SharePoint Group Properties

Updates SharePoint group properties like AutoAcceptRequestToJoinLeave, AllowMembersEditMembership or other options described in MSDN

Parameters

Name Key Required Type Description
Group Name
groupName True string

The name of the group

Title
title string

The title for the group

Description
description string

The description for the group

Owner
owner string

The owner for the group, which can be a user or another group

Allow Members Edit Membership
allowMembersEditMembership boolean

A value that specifies whether group members can modify membership in the group

Allow Request to Join Leave
allowRequestToJoinLeave boolean

A value that specifies whether to allow users to request membership in the group and to allow users to request to leave the group

Auto Accept Request to Join Leave
autoAcceptRequestToJoinLeave boolean

A value that specifies whether users are automatically added or removed when they make a request

Only Allow Members View Membership
onlyAllowMembersViewMembership boolean

A value that specifies whether only group members are allowed to view the list of members in the group

Request to Join Leave Email Setting
requestToJoinLeaveEmailSetting string

The e-mail address to which membership requests are sent

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Update SharePoint Site Properties

Updates web properties like Title, Description or other string options described in at MSDN

Parameters

Name Key Required Type Description
Title
title string

The title for the website

Description
description string

The description for the site

Quick Launch Enabled
quickLaunchEnabled boolean

A value that specifies whether the Quick Launch area is enabled on the website

Tree View Enabled
treeViewEnabled boolean

A value that specifies whether the SharePoint Foundation TreeView is enabled in the left navigational area of website pages

Site Logo URL
siteLogoUrl string

The absolute URL of the website logo

Alternate Css URL
alternateCssUrl string

The URL for an alternate cascading style sheet (CSS) to use in the website

Associated Member Group
associatedMemberGroup string

The users who have been given contribute permissions to the website

Associated Owner Group
associatedOwnerGroup string

The associated owner groups of the website

Associated Visitor Group
associatedVisitorGroup string

The associated visitor group of the website

Contains Confidential Info
containsConfidentialInfo boolean

A value that specifies whether the SharePoint site contain a confidential information

Custom Master URL
customMasterUrl string

The URL for a custom master page file to apply to the website

Enable Minimal Download
enableMinimalDownload boolean

A value that specifies whether the Web site should use Minimal Download Strategy

Is Multilingual
isMultilingual boolean

A value that indicates whether a multilingual user interface is enabled for the website

Master URL
masterUrl string

The URL of the master page that is used for the website

Members Can Share
membersCanShare boolean

Allow Members to share the site and invite others

No Crawl
noCrawl boolean

A value that specifies whether searching is enabled for the website

Overwrite Translations on Change
overwriteTranslationsOnChange boolean

A value that indicates whether changes made to user-specified text in the default language should automatically overwrite existing translations made in all alternate languages

Request Access Email
requestAccessEmail string

The e-mail address to which requests for access are sent

Save Site as Template Enabled
saveSiteAsTemplateEnabled boolean

A value that specifies whether the Web site can be saved as a site template

Server Relative URL
serverRelativeUrl string

The server-relative URL for the website

Syndication Enabled
syndicationEnabled boolean

A value that specifies whether Really Simple Syndication (RSS) is enabled in the website

UI Version
uiVersion integer

The current version number of the user interface

SharePoint Site URL
spUrl True string

This property defines the context of the action. The action will be executed on specified SharePoint site

Definitions

WebUrlResponse

Name Path Type Description
Web URL
url string

DocumentInfoResponse

Name Path Type Description
Document ID
id integer
Document URL
url string

DocumentSetInfoResponse

Name Path Type Description
Document set ID
id integer
Document set URL
url string

FolderInfoResponse

Name Path Type Description
Folder ID
id integer
Folder URL
url string

GetSPGroupMembersResponse

Name Path Type Description
Users
users array of SharePointUserResponse

SharePointUserResponse

Name Path Type Description
User ID
id integer
User Name
loginName string
User Email
email string
User Claims
claims string

UserExistsResponse

Name Path Type Description
User Exists
userExists boolean

SPSiteOptionValueResponse

Name Path Type Description
Option Value
optionValue string

ListFileUrlsResponse

Name Path Type Description
File URLs
fileUrls array of string

ListItemIdResponse

Name Path Type Description
Result Item ID
resultItemId integer

WorkflowGuidResponse

Name Path Type Description
Workflow GUID
workflowGuid string

VersionsHistoryResponse

Name Path Type Description
Count Versions
countVersions integer
Versions
versions array of SharePointVersionResponse

SharePointVersionResponse

Name Path Type Description
editor
editor SharePointUserResponse
Modified
modified date-time
Value
value string