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": "63a684f4-6b64-4d6d-80d0-c48b16ae11c5",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "dbc31e8e-4b16-4305-9ba3-bd7921d0e6af",
      "Name": "sample string 2",
      "Customer": {
        "Id": "8b180b79-f551-421d-84ae-69a0aeffbff6",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "dbc31e8e-4b16-4305-9ba3-bd7921d0e6af",
      "Name": "sample string 2",
      "Customer": {
        "Id": "8b180b79-f551-421d-84ae-69a0aeffbff6",
        "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": "8012f3cf-02bf-4fb2-a0d4-77bb2166047e",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "d4ef15b9-df15-4fbd-b8bb-4ca35bfaee97",
      "Name": "sample string 2",
      "Customer": {
        "Id": "7610c8a1-ab8c-43a6-a3a5-15264076d1a5",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "d4ef15b9-df15-4fbd-b8bb-4ca35bfaee97",
      "Name": "sample string 2",
      "Customer": {
        "Id": "7610c8a1-ab8c-43a6-a3a5-15264076d1a5",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    }
  ]
}