Update a Group

The update group API allows you to edit the details of an existing group. Only one group can be updated by a single API call. You are allowed to update groups for those you have access to modify.


Sample Request


    "groupName": "Test_Group",
    "description": "This is a test group",
    "configName": "Test_Config",
    "administrators": "066f93d4-1a76-11ea-910b-b75868dc7211,0bfc3854-4a74-11e7-bd1f-03fd1cd47229",
    "parentGroupName": "Test_GroupName",
    "bgColor": "#000000",
    "textColor": "#ffffff",
    "groupId": "426f030a-03a2-11ed-a424-ab074112d429"

API Response Explanation

FieldDescriptionData Type
generatedAtAPI generation timestamp in UTCLong
dataDescription of the responseString
errorError description - if anyList
Click Try It! to start a request and see the response here!