Modify Subscriber Details

This API is used to modify attributes of a single Subscriber in the platform.

HTTP URL
PATCH	/api/v2/subscriber/{type}/{value}

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

Eligibility

The Requester is eligible to modify the alias of own subscribers only.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
alias	String	O	Subscriber alias for more easily identifying the subscriber by name (instead of by numerical IDs, such as ICCID) Entering a Null string (“”) for the alias value deletes the existing alias for this subscriber

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.

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_1003	Failed to update subscriber details

Examples

Request Body

Response Body: Success ACK

Response Body: Failure NAK