You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to

Update the Scope of an App

Resource Summary


Content Type

application/json or text/xml


Developer App,



Update the Scope of an App

Updates the scope of an app. Note that this API sets the scopes element under the apiProducts element in the attributes of the app.

The specified scopes must already exist on the API products associated with the app.

Specify the complete list of scopes to apply. The specified list replaces the existing scopes on the app. Therefore, if you are only adding a new scope, you must specify all of the existing scopes along with the new scope.

Apigee recommends that you use the developer's email address when calling this API. Developer IDs are generated internally by Apigee and are not guaranteed to stay the same over time. 

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

Header Parameters

Name Values Description

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

Request Body

The specified scope names must already exist on the API product that you have associated with the app.

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

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?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)