PUT api/customergroups/{id}

Update a customer group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

CustomerGroupDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

Max length: 50

Customer

CustomerDto

None.

IsActive

boolean

None.

Settings

Collection of CustomerGroupSettingDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "8bcafbd3-a1b4-46b5-8b95-ae30f9a5c0c0",
  "Name": "sample string 2",
  "Customer": {
    "Id": "052f0ab4-ae6e-4656-9e4f-e0272d1f721f",
    "Name": "sample string 2"
  },
  "IsActive": true,
  "Settings": [
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    },
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    }
  ]
}

Response Information

Resource Description

CustomerGroupDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

Max length: 50

Customer

CustomerDto

None.

IsActive

boolean

None.

Settings

Collection of CustomerGroupSettingDto

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "f0a10f2a-c7fb-45b9-8144-cdb55cb546ac",
  "Name": "sample string 2",
  "Customer": {
    "Id": "ec76ba1e-386d-49c4-9151-9574679ef2e5",
    "Name": "sample string 2"
  },
  "IsActive": true,
  "Settings": [
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    },
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    }
  ]
}