Edit group

Prev Next

Available in Classic and VPC

Edit the group name.

Request

This section describes the request format. The method and URI are as follows:

Method URI
PUT /api/v1/groups/{groupId}

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
groupId String Required Group ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
groupName String Required Group name
  • 3-30 characters using Korean, English uppercase and lowercase letters, Japanese, and special characters . _ -
  • First letter must be Korean, English uppercase and lowercase letter, or Japanese

Request example

The request example is as follows:

curl --location --request PUT 'https://subaccount.apigw.ntruss.com/api/v1/groups/50b77400-****-****-****-246e96591a38' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
    "groupName": "group000"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API call success status
  • true | false
    • true: succeeded
    • false: failed

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

{
    "success": true
}