Edit product

Available in Classic and VPC

Edit product information according to the user-defined conditions.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
PATCH	/products/{product-id}

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`product-id`	String	Required	ID of the product to edit 0 - 10 characters Check through View product list

Request syntax

The request syntax is as follows.

{
    "subscriptionCode" : "PROTECTED",
    "description" : "description",
    "productName" : "productName"
}

Request body

The following describes the request body.

Field	Type	Required	Description
`subscriptionCode`	String	Required	Subscription method to edit `PUBLIC` \| `PROTECTED` `PUBLIC`: The API can be used by anyone without approval `PROTECTED`: Publisher approval is required to use the API
`description`	String	Optional	Description of the product to edit 0 - 300 characters
`productName`	String	Required	Product name to edit to 0 - 100 characters Enter the existing product name if you don't want to edit it

Request example

The following is a sample request.

curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***681e***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "subscriptionCode" : "PUBLIC",
    "description" : "product002",
    "productName" : "product002"
}'

Response

The following describes the response format.

Response status codes

For response status codes common to API Gateway, see API Gateway response status codes.