Modify Subscriber Status

This API is used to change the LCP status of a single subscriber in the platform.

HTTP URL
PUT	/api/v2/subscriber/{type}/{value}/status

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requester is eligible to request a status change for own subscribers or for own sub-customer subscribers.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
status	String	M	Request to change the subscriber’s current status to a new status value. ENUM valid values: ACTIVE, SUSPEND, INACTIVE, TERMINATED

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed.

Element

Type

M/O/CM

Description

requestId

UUID

Request instance ID.

To be used by external systems to query the call (operation) status:

In progress

Successful

Failed.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1008	Failed to update subscriber status

Examples

Request Body

Copy

{
  "status": "ACTIVE"
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "SUBSCRIBER_1008",
  "errorMessage": "Failed to update subscriber status",
  "content": "",
  "pageable": ""
}