Edit product
    • PDF

    Edit product

    • PDF

    Article summary

    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:

    MethodURI
    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.

    FieldTypeRequiredDescription
    product-idStringRequiredID of the product to edit

    Request syntax

    The request syntax is as follows.

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

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    subscriptionCodeStringRequiredSubscription method to edit
    • PUBLIC | PROTECTED
      • PUBLIC: The API can be used by anyone without approval
      • PROTECTED: Publisher approval is required to use the API
    descriptionStringOptionalDescription of the product to edit
    • 0 - 300 characters
    productNameStringRequiredProduct 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.


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.