PUT api/apps/{id}

Update an app

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

AppDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

Max length: 50

IsActive

boolean

None.

NotificationType

NotificationTypeEnum

None.

CustomerGroups

Collection of CustomerGroupDto

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "a349d6dd-950e-4763-afb7-cf609e6d5a16",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "9309206c-678d-433d-9a62-32ebeb318260",
      "Name": "sample string 2",
      "Customer": {
        "Id": "51302b0f-6a81-492a-b4ec-f5be36cda8f5",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "9309206c-678d-433d-9a62-32ebeb318260",
      "Name": "sample string 2",
      "Customer": {
        "Id": "51302b0f-6a81-492a-b4ec-f5be36cda8f5",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    }
  ]
}

Response Information

Resource Description

AppDto
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

Required

Max length: 50

IsActive

boolean

None.

NotificationType

NotificationTypeEnum

None.

CustomerGroups

Collection of CustomerGroupDto

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "6266c9d8-2e3b-4f29-9433-381af5fe71ba",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "741e782e-5947-4072-a79d-0b21a6484898",
      "Name": "sample string 2",
      "Customer": {
        "Id": "ec960988-a5ee-43d5-9095-d8a96daee93a",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "741e782e-5947-4072-a79d-0b21a6484898",
      "Name": "sample string 2",
      "Customer": {
        "Id": "ec960988-a5ee-43d5-9095-d8a96daee93a",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    }
  ]
}