SendWelcomeNotification

A mechanism for granting access to content to a child organization.

Syntax

int = lmsBinding.SendWelcomeNotification (string licenseeId, string[] personIds, string notificationName)

Usage

When invoked by a client application, Firmwater LMS will send a welcome email to each valid recipient listed in the personIds array. The number of notifications sent is returned.

Rules and Guidelines

Permissions

The client must be authenticated with the web service as a user with sufficient privileges to send welcome notifications to the recipients.

Arguments

Name Type Description
licenseeId string Client ID of organization for which the recipients belong to
personIds string[] This argument contains an ID list of 36-character globally unique identifiers to identifier recipients. The users identified in the list must belong to the organization specified by 'licenseeId'.
notificationName string The name of the welcome notification to send. Currently, only 'welcome' is supported.

Return Object

int