Delete Subscriber

The Delete Subscriber API accepts a list of KSIDs in the request body of subscribers to be deleted. Before the subscriber is deleted, the subscriber must be in an “inactive” state, as only inactive subscriptions can be deleted. If an attempt is made to delete an active subscription, an error code is returned.

URL

The HTTP URL for Delete Subscriber API is:

http://<host>:<port>/api/v1/subscribers/delete/ksids

This API is protected and the service implements Gateway Filter for Authentication to authenticate access of the service by a user.

Method

POST

Header

The payload’s request header includes Content-Type as application/json;charset=UTF-8.

Input Parameters

The following fields are input parameters:

Sample Request

{
"ksids":["121324343545454545"]
}

Important: You can pass an array of KSIDs in the sample request to delete subscribers.

Output Parameters

The following fields are output parameters:

Sample Response

{
"id" : "",
"message" : "Subscribers deleted successfully"
}

Response Status