Send Docs Feedback

SmartDocs basics

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge email and password (user must be in the Org Admin role).
3. Tweak the Request Body as needed (if a body is needed).
4. Send the live request to Edge and view the response! You can also view Request data.

Add API Product to Key

Resource Summary

Auth Type


Content Type

application/json, text/xml


Developer App Keys,



Add API Product to Key

Adds an API product to a developer app key, enabling the app that holds the key to access the API resources bundled in the API product.

Use this API to add a new API product to an existing app. After adding the API product, you can use the same key to access all API products associated with the app.

Resource URL /organizations/{org_name}/developers/{developer_email_or_id}/apps/{app_name}/keys/{consumer_key}

    Header Parameters

  • Name
  • Content-Type
    Specify the Content-Type as application/json or text/xml.

Request Body

Name Description Default Required?
apiProducts The name of the API product to added to the developer app key. The name of the API product is the name returned by a GET request to the "List API Products" endpoint. For example, if the Display Name of the API product in the Edge UI is 'Premium API Product', then the name is 'premium-api-product' (all lowercase with spaces replaced by hyphens).   Yes
attributes Arbitrary name/value attributes added to the profile for the developer app key, usually used for app specific processing or metadata/analytics   No

org_name Mention the organization name true

developer_email_or_id Mention the developer email or ID true

app_name Mention the app name true

consumer_key Mention the consumer key true

Basic Auth

OAuth 2

Custom Token


Make a request and see the response.

Make a request and see the response.


Help or comments?