Usage Notes

This method requires a Group Name and a Group Type, and can optionally accept a Group Description and Security Category ID, and will create a new static group in Luminate Online.

Server API callers must have "Group Management/Use Luminate Online Groups API" permission.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

group_name

Required. The name of the group you would like to create.

Type xsd:string.

group_type

Required. The name of the group type you would like this new group to have. If the type does not currently exist, it will be created.

Type xsd:string.

group_security_category_id

Optional. The Security Category ID to be associated with this group.

Type xsd:string.

group_description

Optional. A short description of the purpose of the group.

Type xsd:string.

Response

See topic HTTP Status Codes.

  
    0
    Sample Group 1 Name
    Sample Group 1 Description
    2016-02-01T09:43:53.676-06:00
    2016-02-01T09:43:53.676-06:00
    2016-02-01T09:43:53.676-06:00
    2016-02-01T09:43:53.676-06:00
    STATIC_REBUILDABLE
    ADMINISTRATOR
    2831
    2279
    
      0
      0
      0
      0
    
    
      1
      Sample Security Category
    
    
      334
      Sample Group Type
    
  


        

{"getGroupInfoResponse":{"groupInfo":{"groupType":{"id":"334","name":"Sample Group Type"},"emailStats":{"numOptedOut":"0","numSendable":"0","numSoftBounce":"0","numHardBounce":"0"},"lastBuildTimestamp":"2016-02-01T09:43:53.679-06:00","securityCategory":{"id":"1","label":"Sample Security Category"},"modifyTimestamp":"2016-02-01T09:43:53.679-06:00","id":"0","createTimestamp":"2016-02-01T09:43:53.679-06:00","statsUpdateTimestamp":"2016-02-01T09:43:53.679-06:00","groupMode":"STATIC_REBUILDABLE","description":"Sample Group 1 Description","numActiveMembers":"2279","name":"Sample Group 1 Name","numMembers":"2831","securityMode":"ADMINISTRATOR"}}}