Update Application Information


Update the information of an application.

Request Format


POST https://{apigw-address}/app-portal-service/v2.3/app/modify

Request Parameters (Header)


Name

Required/Optional

Data Type

Description

appId

Required

String

The access key of the application. How to get Access Key >>

tags

Optional

String

Application tag.

  • If some new tags are specified, the existing tags of the application will be overwritten.

  • If null is given, tags are not updated.

  • If no value is given, all existing tags of the application are removed.

key

Optional. Required if tags parameter is not null or empty

String

The key of a tag, up to 5 keys, and they cannot be repeated. Each key can be up to 50 characters.

value

Optional. Required if tags parameter is not null or empty

String

The value of a tag, up to 256 characters each value.

Request Parameters (URI)


Name

Required/Optional

Data Type

Description

orgId

Required

String

OU ID. How to get orgId >>

Response Parameters


Name

Data Type

Description

success

Boolean

The results for updating application tags. true for success, and false for failure.

Error Codes


Error Code

Description

31400

  • The required parameter is empty.

  • The tag key value length is invalid.

  • The number of tags exceeds 5.

  • The tag key is repeated.

31404

  • The application does not exist.

  • The OU does not acquire this application.

Samples

Request Sample


url: /app-portal-service/v2.3/app/modify?orgId=your_org_id

method: POST

requestBody:
{
  "appId": "your_access_key",
  "tags": [
      {
        "key": "your_tag_key",
        "value": "your_tag_value"
      },
      {
        "key": "your_tag_key_2",
        "value": "your_tag_value_2"
      }
    ]
}

Return Sample


{
  "code": 0,
  "message": "OK",
  "data": {
    "success":true
  }
}