Delete subscriber
Added by IBM contributorIBM | Edited by Claudia R Elbourn on July 1, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars1 comment

Delete a subscriber from an organization. This action also frees the assigned seats to the subscribers. The subscriber must be owned by the organization of the authenticated user.
The API caller must have one of the following roles to run the API:
  • CustomerAdministrator
  • VSR
 

Table 1. API details

Method
Resource address
Operation header
DELETE
/resource/subscriber/<id>

/resource/subscriber/<id>?moveToSoftDelete=true

None

 

URL parameters


Provide the following parameter.

Table 2. Parameters

Parameter
Required
Description
id
Yes
The ID of the subscriber. To obtain the ID, see the Get subscriber list by email address and Get subscriber list by customer ID topics.

 

Behaviour:

This operation checks for the existence of the Subscriber and it marks subscriber state as REMOVED.

Behavior with moveToSoftDelete flag : the operation with ?moveToSoftDelete=true will move the subscriber in SOFT_DELETED state instead of REMOVED. This is a transient state introduced to avoid accidental deletion. In this state, the user login will be suspended from TAM/endpoints.


Admin can restore the Subscriber from this state within 30 days.

For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.
Parent topic: Subscriber management services

 

Input
Method URI Description
DELETE /api/bss/resource/subscriber/{id} Delete a subscriber from an organization. This action also frees the assigned seats to the subscribers. The subscriber must be owned by the organization of the authenticated user.
The API caller must have one of the following roles to run the API:
CustomerAdministrator
User
VSR
Name Type Optional Description
id
string No The ID of the subscriber. To obtain the ID, see the [[Get subscriber list by email address bss: Get subscriber list by email address]] and [[Get subscriber list by customer ID bss|Get subscriber list by customer ID]] topics.
Name Type Optional Description
moveToSoftDelete
boolean Yes Enables the Soft Deleting of a Registered User
Kevin Holohan commented on Apr 20, 2016

Re: Delete subscriber

What about user data, where is the option for that to be reassigned ?