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": "9c824375-0614-4481-bcf5-7ba679c258cf",
  "Name": "sample string 2",
  "Customer": {
    "Id": "de2ada03-d667-4980-b7d0-5028a88115e7",
    "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": "787b3b7a-dfbf-472e-8d7e-1d8a233f30a2",
  "Name": "sample string 2",
  "Customer": {
    "Id": "01ad78e5-f17c-443d-a97b-8085187080b7",
    "Name": "sample string 2"
  },
  "IsActive": true,
  "Settings": [
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    },
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    }
  ]
}