PUT api/group/{id}/displaysettings

Edit Display settings for the Group. Primarily shown in the GroupHub e.g. the icon and background image.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

GroupDisplaySettingsDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

Notes

string

None.

GroupIcon

EnumDataContract

None.

ImageReference

string

None.

GroupType

EnumDataContract

None.

ExternalProviderTypes

Collection of EnumDataContract

None.

IsSeparated

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Notes": "sample string 3",
  "GroupIcon": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ImageReference": "sample string 4",
  "GroupType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ExternalProviderTypes": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IsSeparated": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.