AddTeamMember
Adds users/teams as members of the specified team.
AddTeamMember Parameters
Team : Identity
Target team.
Member? : Identity
Single user or team to add.
Members? : Identity[]
Array of users and/or teams to add to the target team.
Each item can be Identity object or team name or user email.
AddTeamMember Examples
CreateTask('AddTeamMember', { Key = Value })ChangeUserSettings
Updates custom user settings.
ChangeUserSettings Parameters
UserId? : Guid
Target user ID.
Email? : String
Target user email (used if UserId is not specified).
Settings : Dict
Custom settings to update.
ChangeUserSettings Examples
CreateTask('ChangeUserSettings', { Key = Value })CreateTeam
Creates new team.
CreateTeam Parameters
Name : String
New team name.
MemberOf? : String[]
Array of teams to add the new team to (can be single string).
Each item is a team name.
Members? : Identity[]
Array of users and/or teams to add to the new team.
Each item can be Identity object or team name or user email.
Settings? : Dict
Custom settings for the new team.
CreateTeam Examples
CreateTask('CreateTeam', { Key = Value })CreateUser
Creates new user account.
CreateUser Parameters
Email : String
Email of the new user account.
Password? : String?
Password of the new user account (can be null to generate one).
FirstName : String
First name of the user.
LastName : String
Last name of the user.
Settings? : Dict
User details and custom settings.
CreateUser Examples
CreateTask('CreateUser', { Key = Value })DeleteTeam
Deletes specified team.
DeleteTeam Parameters
Team : Identity
Team to delete (can be team name).
ReplaceRefsWith? : Identity
Team (can be name) to replace any reference to the deleted team with.
DeleteRelated : Boolean = false
True to delete all items having a reference to the deleted team.
DeleteTeam Examples
CreateTask('DeleteTeam', { Key = Value })DeleteUser
Deletes specified user account.
DeleteUser Parameters
User : Identity
User to delete (can be email).
ReplaceRefsWith? : Identity
User (can be email) to replace any reference to the deleted user with.
DeleteUser Examples
CreateTask('DeleteUser', { Key = Value })EnableUser
Enables or disables specified user account.
EnableUser Parameters
Email : String
Target user email.
Enable : Boolean
True to enable, false to disable.
EnableUser Examples
CreateTask('EnableUser', { Key = Value })RemoveTeamMember
Removes users/teams membership from the specified team.
RemoveTeamMember Parameters
Team : Identity
Target team.
Member? : Identity
Single user or team to remove from the target team.
Members? : Identity[]
Array of users and/or teams to remove from the target team.
Each item can be Identity object or team name or user email.
RemoveTeamMember Examples
CreateTask('RemoveTeamMember', { Key = Value })UpdateUser
Updates user details.
UpdateUser Parameters
Email : String
Target user email.
FirstName? : String
New first name.
LastName? : String
New last name.
PhoneNumber? : String
New phone number.
Language? : String
New language.
TimeZone? : String
New time zone.
UpdateUser Examples
CreateTask('UpdateUser', { Key = Value })