Modify Customer External Params

This API is used to modify a single External Parameters instance of one of its own customer entities (Sub-customer, Subscriber, Plan).

HTTP URL
PUT	/api/v2/customer/{id}/external-params/{id}

Eligibility

The Requester is eligible to modify an External Parameters instance of its own customer entities (sub-customers, its own subscribers, Sell plans). The Requester is not eligible to modify an existing External Parameters instance at any other customer level, including its own sub-customers’ entities.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
value	String	M	External Parameter value

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
CUSTOMER_1002	Customer does not exist
CUSTOMER_1025	Failed to update external params item
GLOBAL_1001	Service unavailable. Please try again

Examples

Request Body

Response Body: Success ACK

Response Body: Failure NAK