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": "8a900602-542f-4011-92e7-2f05967c6c49",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "fc8afc77-bbea-4c41-8d55-d7ca9847f752",
      "Name": "sample string 2",
      "Customer": {
        "Id": "a474fb87-b660-474c-81b8-b63415f38145",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "fc8afc77-bbea-4c41-8d55-d7ca9847f752",
      "Name": "sample string 2",
      "Customer": {
        "Id": "a474fb87-b660-474c-81b8-b63415f38145",
        "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": "9e7120dd-fe64-4d4d-8376-0751fdd90941",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "657e9008-1f7b-404a-9eeb-b6ab6ae9da64",
      "Name": "sample string 2",
      "Customer": {
        "Id": "46480968-f855-4bc8-91ad-63eb4a54b948",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "657e9008-1f7b-404a-9eeb-b6ab6ae9da64",
      "Name": "sample string 2",
      "Customer": {
        "Id": "46480968-f855-4bc8-91ad-63eb4a54b948",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    }
  ]
}