---
title: "Edit product"
slug: "apigateway-product-patchproduct"
updated: 2026-09-17T09:35:41Z
published: 2026-09-17T09:35:41Z
canonical: "api.ncloud-docs.com/apigateway-product-patchproduct"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 | /api/v1/products/{product-id} |

### Request headers

For information about the headers common to all API Gateway APIs, see [API Gateway request headers](/docs/en/ai-application-service-apigateway#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94).

### Request path parameters

You can use the following path parameters with your request:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `product-id` | String | Required | ID of the product to edit - 0 - 10 characters - See [View product list](/docs/en/apigateway-product-getproductlist) |

### 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 information about the HTTP status codes common to all API Gateway APIs, see [API Gateway response status codes](/docs/en/ai-application-service-apigateway#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C).