PUT - Update Group

Updates an existing Group with the specified settings.

Parameters

  • group_id (str): Target Group ID

  • service_provider_id (str): Target Service Provider ID

  • default_domain (str): Default Domain for the Group

  • time_zone (int): Timezone of the Group

  • updates_ (dict): Dictionary of updates to apply to the group.

Returns

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

How To Use:

updates = "contact": {"contactName": "test name"}

my_api.groups.post_group{
     "serviceProviderId",
     "groupId",
     "defaultDomain",
     "timeZone",
     updates
}

Example Data Returned (Formatted)

{
  "defaultDomain": "domain.com",
  "userLimit": 25,
  "userCount": 8,
  "groupName": "grp.test",
  "callingLineIdName": "test solutions",
  "callingLineIdPhoneNumber": "+12345678900",
  "callingLineIdDisplayPhoneNumber": 2345678900,
  "timeZone": "America/New_York",
  "timeZoneDisplayName": "(GMT-05:00) (US) Eastern Time",
  "locationDialingCode": 234,
  "contact": {
    "contactName": "test name",
  },
  "serviceProviderId": "ent.test",
  "groupId": "grp.test"
}

Last updated

Was this helpful?