GroupCloneOptions

Prev Next

The object for a description of how to clone a given group and mandatory fields for the cloned group.

Name

Type

Description

Constraints

name

String

Name of the group clone. The name must be unique in the system.

required maxLength:150

description

String

Description of the group clone.

optionalmaxLength:3,000

email

String

Email for the group clone. The email must be unique and valid.

required

includePreparedMessages

Boolean

If true, the group is cloned with all prepared messages; otherwise, without.

required

includeTestUsers

Boolean

If true, the group is cloned with the test recipients; otherwise, without.

required

keepOwner

Boolean

If true, the group owner from the source group is added as a member to the destination group and also keeps ownership of the group.

required

withOwnerAsMember

Boolean

If true, a member of the owner is created.

required