Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ activity / workspaceAddMember

  • Article
  • 1 minutes to read

Description

Invoke this operation to add one or more new members to the workspace. You need to be the workspace owner or have admin privilege level or have changeWorkspaceOwner system right (only applicable for Public Workspaces) in order to add a member to a workspace.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.e.addWorkspaceMember
 --- --- ---

Request Parameters

The workspaceAddMember method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
activityStreamID xs:anyURI Required The workspace/activity stream ID.
newMemberRef Array<xs:anyURI> Required The new member URN. This must be a valid and existing user account URN.
description xs:string Optional Optionally provide a brief description of the members role within the workspace.
announceMembership xs:boolean Optional
Default=true		 Set this ‘true’ to make an announcement to the group that the user is now a member.
isTeamMember xs:boolean Optional
Default=false		 Set this ‘true’ to make this user a team member.
teamMemberRole xs:string Optional Set this to the team mebers role if required. This is the role the team member performs within this workspace.

Response Parameters

Name Type Attributes Description
announcementActivityID xs:anyURI Optional Activity created when a member is added to workspace.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document