POST - Create Group

Creates a new group.

Parameters

  • default_domain (str): Default Domain for the Group

  • user_limit (int): User Limit for the Group

  • group_name (str): Name of the Group

  • group_id (str): Target Group ID

  • service_provider_id (str): Target Service Provider ID

Returns

  • Dict: Returns the newly created Group's information, such as the ID, userCount, Domain and Timezone.

How To Use:

my_api.groups.post_group{
     "serviceProviderId",
     "groupId",
     "groupName",
     200,
     "DefaultDomain"
}

Example Data Returned (Formatted)

{
  "defaultDomain": "domain.com",
  "userLimit": 25,
  "userCount": 8,
  "groupName": "grp.test",
  "timeZone": "America/New_York",
  "timeZoneDisplayName": "(GMT-05:00) (US) Eastern Time",
  "serviceProviderId": "ent.test",
  "groupId": "grp.test"
}

Last updated

Was this helpful?