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": "65654da5-0bdc-4020-809d-141618a8496b",
  "Name": "sample string 2",
  "Customer": {
    "Id": "2030ebbe-71b0-44b7-af9a-a9d37cc8f881",
    "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": "a0830f94-5b7d-41b1-8b41-32ddec60fe3b",
  "Name": "sample string 2",
  "Customer": {
    "Id": "db567185-75a6-4c73-8752-a0a353eab11c",
    "Name": "sample string 2"
  },
  "IsActive": true,
  "Settings": [
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    },
    {
      "Name": "EmbedReportUrl",
      "Value": "sample string 1"
    }
  ]
}