Bulk Subscriber APIs

Bulk Modify Subscriber Details

This API is used to modify attributes of multiple Subscribers in the platform with a single API call.

The request should contain only elements that require modification. Empty elements denote overriding of the existing value with a NULL value.

HTTP URL
PATCH	/api/v2/bulk/subscriber

Eligibility

The Requester is eligible to modify its own subscribers’ details only.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
bulk	Object	M	Array of main request body object.

Bulk data objects

Element	Type	M/O/CM	Description
subscriberIdentifiers	Object	M	Subscriber unique keys object, defines the search criteria.
content	Object	M	Main elements container object.

subscriberidentifiers data objects

Element	Type	M/O/CM	Description
type	String	M	Define the search criteria. ENUMs: IMSI, ICCID, MSISDN, IMEI, IMEISV
value	String	M	Type value. IMSI or ICCID or MSISDN, IMEI or IMEISV number.

Content data objects

Parameter	Type	M/O/CM	Description
alias	String	O	Subscriber alias for more easily identifying the subscriber by name

API Response

Response Structure

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

Bulk data objects

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
requestId	UUID	CM	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed. Displayed when an API call was successful. For a failure, it will be empty.
subscriberIdentifiers	Object	M	Subscriber unique keys object, defines the search criteria
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.

subscriberidentifiers data objects

Parameter	Type	M/O/CM	Description
type	String	M	Define the search criteria. ENUMs: IMSI, ICCID, MSISDN, IMEI, IMEISV
value	String	M	Type value. IMSI or ICCID or MSISDN IMEI or IMEISV number.

Content data objects

Element	Type	M/O/CM	Description
alias	String	O	Subscriber alias for more easily identifying the subscriber by name

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

Copy

{
  "bulk": [
    {
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        
"alias": "Camera1"
 
      }
    },
    {
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000034535"
      },
      "content": {
        
"alias": "Camera1"
 
      }
    }
  ]
}

Response Body: Full Success

ACK:

Copy

{
  "bulk": [
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        
"alias": "Camera1"
 
      }
    },
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000035687"
      },
      "content": {
        
"alias": "Camera1"
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Includes Failure(s) (NAK)

Copy

{
  "bulk": [
    {
      "errorCode": "AUTH_1013",
      "errorMessage": "You are not allowed to detach parent customer plans from your own SIM card",
      "requestId": "",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        
"alias": "Camera1"
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}