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": "4d465133-c1aa-4449-a18e-afb0e90f3766",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "38712fd5-b006-40c8-b7c8-0ce6464f11b3",
      "Name": "sample string 2",
      "Customer": {
        "Id": "1b61b815-dafe-41b8-844a-d051521bcb2c",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "38712fd5-b006-40c8-b7c8-0ce6464f11b3",
      "Name": "sample string 2",
      "Customer": {
        "Id": "1b61b815-dafe-41b8-844a-d051521bcb2c",
        "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": "f8ec589d-59d0-4f17-91e8-dc8f58b4dbea",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "7d56fce3-e759-4a2e-b34e-7781b637f810",
      "Name": "sample string 2",
      "Customer": {
        "Id": "4e2bee4e-bddb-4b23-a699-1873ddc6b972",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "7d56fce3-e759-4a2e-b34e-7781b637f810",
      "Name": "sample string 2",
      "Customer": {
        "Id": "4e2bee4e-bddb-4b23-a699-1873ddc6b972",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    }
  ]
}