notification APIv1.2.0

enableSubscription

POST
/subscription/{subscription_id}/enable
This method allows applications to enable a disabled subscription. To pause (or disable) an enabled subscription, call disableSubscription.

Input

Resource URI (production)

POST https://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}/enable

URI parameters

ParameterTypeDescription
subscription_idstringThe unique identifier for the subscription.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with either authorization code grant flow or client credentials grant flow. Please refer to the note below for more details.

The access token must be created using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope

https://api.ebay.com/oauth/api_scope/commerce.notification.subscription

See OAuth access tokens for more information.

Note: An OAuth token created with the client credentials grant flow and the https://api.ebay.com/oauth/api_scope scope is required in order to create, update, or retrieve application-based subscriptions to notification topics. An OAuth token created with the authorization code grant flow and the https://api.ebay.com/oauth/api_scope/commerce.notification.subscription scope is required in order to create, update, or retrieve user-based subscriptions to notification topics.

Output

HTTP response headers

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
204No Content
404Not Found
409Conflict
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
195000API_NOTIFICATIONAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
195013API_NOTIFICATIONREQUEST Invalid subscription Id.
195014API_NOTIFICATIONREQUESTThe subscription cannot be enabled since the topic or payload is no longer supported.
195015API_NOTIFICATIONREQUESTThe subscription cannot be enabled since the destination is not enabled.

Warnings

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Enable a subscription

This call enables a subscription.

Input

The input is the subscription_id as a path parameter.
POST
https://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}/enable

Output

A successful call returns the HTTP status code 204 No Content. This method has no response payload.