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": "61179a5a-2605-4829-bf39-351520879d89",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "ebe39c46-37ef-4aa2-b24f-d9f5dbedbc70",
      "Name": "sample string 2",
      "Customer": {
        "Id": "4541f88d-4899-4574-8e00-9f945ef401bb",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "ebe39c46-37ef-4aa2-b24f-d9f5dbedbc70",
      "Name": "sample string 2",
      "Customer": {
        "Id": "4541f88d-4899-4574-8e00-9f945ef401bb",
        "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": "b6773912-b3f2-464f-a1fa-4d5051f6696b",
  "Name": "sample string 2",
  "IsActive": true,
  "NotificationType": "Bubble",
  "CustomerGroups": [
    {
      "Id": "811fe646-7058-4edf-bb83-827839a3c15a",
      "Name": "sample string 2",
      "Customer": {
        "Id": "7e0ef121-1e95-435d-a3f7-e760f16c76cd",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    },
    {
      "Id": "811fe646-7058-4edf-bb83-827839a3c15a",
      "Name": "sample string 2",
      "Customer": {
        "Id": "7e0ef121-1e95-435d-a3f7-e760f16c76cd",
        "Name": "sample string 2"
      },
      "IsActive": true,
      "Settings": [
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        },
        {
          "Name": "EmbedReportUrl",
          "Value": "sample string 1"
        }
      ]
    }
  ]
}