The addGroup() GraphQL mutation is used to create a new group.

For more information on user groups, see the Managing Groups documentation page.


Below is the syntax for the addGroup() mutation field:

      displayName: string!
      lookupName: string
    ): AddGroupMutation!

Returned Data Types

For the input (i.e., addGroup()), there is one parameter that may be given. It's described below:

Table: addGroup

groupGroupyes The group on which to add mutation (see Group Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.