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": "75e3fa60-6890-4d31-b241-c7d6c714f9f3",
  "Name": "sample string 2",
  "Customer": {
    "Id": "bc502578-edee-4400-8bcc-0a0cfbafdee2",
    "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": "3818496c-b473-41ca-80ae-95e4a4914874",
  "Name": "sample string 2",
  "Customer": {
    "Id": "f6e4dcc5-d52d-4e03-87b1-6968e936c130",
    "Name": "sample string 2"
  },
  "IsActive": true,
  "Settings": [
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    },
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    }
  ]
}