OpeneBayParticipantInterface Call Reference Version 1.3.0 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History

Sent by eBay to request that you remove an eBay member from your subscription database. eBay sends the request when a user clicks the Unsubscribe button in My eBay. Your application must use a subscription listener to receive removeSubscriber requests from eBay. Decrypt the data in credentials.token.tokenValue in order to obtain the user name of the eBay member to remove from your subscription database. You must use the user name from credentials.token.tokenValue, not the auth token, because in a removeSubscriber request, the credentials.token.tokenValue field does not contain a token.

See User Guide for information about a subscription listener.

Back to top

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<removeSubscriberRequest xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Input Fields -->
  <credentials appId="string"> OpeneBayRequestCredentialsType 
    <token type="OpeneBayTokenType"> OpeneBaySecurityTokenType 
      <signature> string </signature>
      <tokenValue> string </tokenValue>
    </token>
  </credentials>
  <!-- Call-specific Input Fields -->
  <subscriptionInfo> OpeneBaySubscriptionInfoType 
    <externalPlanId> string </externalPlanId>
    <planId> string </planId>
    <planName> string </planName>
    <subscriptionId> string </subscriptionId>
  </subscriptionInfo>
  <userInfo> OpeneBaySubscriberInfoType 
    <userName> string </userName>
  </userInfo>
</removeSubscriberRequest>

Back to top

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

<?xml version="1.0" encoding="utf-8"?>
<removeSubscriberResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValueType </ack>
  <errorMessage> string </errorMessage>
  <errorSeverity> ErrorSeverityType </errorSeverity>
  <timestamp> dateTime </timestamp>
</removeSubscriberResponse>

Back to top

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

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Requests removal of a subscriber from a Selling Manager application.

Description

Selling Manager Applications is requesting that a third-party application remove a user from the third-party application's subscription database.

Input

Your application must decrypt the string in the tokenValue field to determine the username to remove from your application's subscription database. For more information, see the User Guide.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<removeSubscriber xmlns="http://www.ebay.com/marketplace/services">
  <credentials appId="your_app_id">
    <token type="Value">
      <tokenValue>token_value</tokenValue>
      <signature>signature_value</signature>
    </token>
  </credentials>
  <userInfo>
    <userName>magicalbookseller</userName>
  </userInfo>
  <subscriptionInfo>
    <subscriptionId>5000004267</subscriptionId>
    <planId>5000000627</planId>
    <planName>EasyBill</planName>
    <externalPlanId>ARKLS3</externalPlanId>
  </subscriptionInfo>
</removeSubscriber> 

Output

The third-party application responds with an Ack field containing Success, indicating that the user was removed from the application's subscription database.

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<removeSubscriberResponse xmlns="http://www.ebay.com/marketplace/services">
  <ack>Success</ack>
  <timestamp>2009-05-18T16:34:09.423-0700</timestamp>
</removeSubscriberResponse> 

Back to top

This document was generated with a customized version of the apireferencedocs tool.

© 2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.