Updated on 2025-12-05 GMT+08:00

Modifying an Application

Function

This API is used to adjust an application's name or description as required after the application is created.

URI

PUT /v1/applications/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

Definition

Application ID.

Constraints

N/A

Range

The value can be customized. The value contains 24 characters.

Default value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Definition

Application name.

Constraints

The value can contain only letters, digits, hyphens (-), and underscores (_).

Range

It contains 3 to 50 characters.

Default value

N/A

description

No

String

Definition

Description.

Constraints

N/A

Range

The value can be customized and contains 1 to 256 characters.

Default value

N/A

is_collection

No

Boolean

Definition

Whether to add it to favorites.

Constraints

N/A

Range

  • true: The application is added to favorites and can be viewed in my favorites.

  • false: The application is not added to favorites.

Default value

By default, it is not added to favorites.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

String

Definition

ID of the application to be modified.

Range

N/A

Example Requests

Change the application name.

PUT https://{Endpoint}/v1/applications/{id}

{
  "name" : "Crf_Large-scale application 1144",
  "description" : "test"
}

Example Responses

Status code: 200

An application is modified.

{
  "data" : "67e3b885ef614c77c8b76f49"
}

Status Codes

Status Code

Description

200

An application is modified.

Error Codes

See Error Codes.