core_v2_userInvitation Script API

Enables scripted content fragments to get user invitation information.

Properties
Accept
Create
Get

Properties

Name	Access	Type	Description
Current	Read	`UserInvitation`	Returns the current contextual user invitation

Methods

Accept

Accepts an invitation for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_userInvitation.Accept($invitationKey))

JavaScript

var additionalInfoResponse = core_v2_userInvitation.Accept(invitationKey);

Parameters

Name	Type	Description	Required	Default	Options
invitationKey	`Guid`	Invitation Key	Required

Returns

AdditionalInfo

Create

Create Overload 1

Creates a user invitation

Velocity

#set($userInvitationResponse = $core_v2_userInvitation.Create($email, $message))

JavaScript

var userInvitationResponse = core_v2_userInvitation.Create(email, message);

Parameters

Name	Type	Description	Required	Default	Options
email	`String`	Email	Required
message	`String`	Message	Required

Create Overload 2

Creates a user invitation

Velocity

#set($userInvitationResponse = $core_v2_userInvitation.Create($email, $message, $groupId, $groupMembershipType))

JavaScript

var userInvitationResponse = core_v2_userInvitation.Create(email, message, groupId, groupMembershipType);

Parameters

Name	Type	Description	Required	Options
email	`String`	Email	Required
message	`String`	Message	Required
groupId	`Int32`	Group Id	Required
groupMembershipType	`String`	Group Membership Type	Required	EffectiveMember, Manager, Member, None, Owner, PendingMember

Create Overload 3

Creates multiple user invitations

Velocity

#set($userInvitationResponse = $core_v2_userInvitation.Create($emails, $message))

JavaScript

var userInvitationResponse = core_v2_userInvitation.Create(emails, message);

Parameters

Name	Type	Description	Required	Default	Options
emails	`IList of String`	Emails	Required
message	`String`	Message	Required

Create Overload 4

Creates multiple user invitations

Velocity

#set($userInvitationResponse = $core_v2_userInvitation.Create($emails, $message, $groupId, $groupMembershipType))

JavaScript

var userInvitationResponse = core_v2_userInvitation.Create(emails, message, groupId, groupMembershipType);

Parameters

Name	Type	Description	Required	Options
emails	`IList of String`	Emails	Required
message	`String`	Message	Required
groupId	`Int32`	Group Id	Required
groupMembershipType	`String`	Group Membership Type	Required	EffectiveMember, Manager, Member, None, Owner, PendingMember

Returns

UserInvitation

Get

Gets an invitation for the accessing user

Velocity

#set($userInvitationResponse = $core_v2_userInvitation.Get($invitationKey))

JavaScript

var userInvitationResponse = core_v2_userInvitation.Get(invitationKey);

Parameters

Name	Type	Description	Required	Default	Options
invitationKey	`Guid`	Invitation Key	Required

Returns

UserInvitation

Recommended