POST api/customergroups

Create a new customer group

Request Information

URI Parameters

None.

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": "4094a94d-3a82-4aba-ba03-9e85186ed1f0",
  "Name": "sample string 2",
  "Customer": {
    "Id": "8eb63205-755c-40df-a036-9109d4e265b3",
    "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": "b0942e18-3014-40de-bbaf-a683a76a3af9",
  "Name": "sample string 2",
  "Customer": {
    "Id": "a4863f94-2803-44e1-ac84-214a5d490d20",
    "Name": "sample string 2"
  },
  "IsActive": true,
  "Settings": [
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    },
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    }
  ]
}