Send Docs Feedback

Update API Product

Resource Summary


Content Type

application/json, text/xml


API Product,



Update API Product

Updates an existing API product.

You must include all required values, whether or not you are updating them, as well as any optional values that you are updating. For information about required values, see the "Create API Product" API.

The API product name required in the request URL is not the "Display Name" value displayed for the API product in the Edge UI. While they may be the same, they are not always the same depending on whether the API product was created via UI or API.

For this reason, be sure to get the exact API product name by performing a GET request to the List API Products endpoint. Use the "name" value returned in the response as the API product name in the request URL.

CPS: With Core Persistence Services, the custom attribute limit is 18.


Resource URL /organizations/{org_name}/apiproducts/{apiproduct_name}

Header Parameters

Name Values Description

Specify the content type as application/json or text/xml.

Request Body

For more information on setting the body, see the 'Create API Product' API.

org_name Mention the organization name true

apiproduct_name Mention the API Product name true

HTTP Basic

OAuth 2.0



Make a request and see the response.

Make a request and see the response.

Make a request and see the response.


Help or comments?