Modify Customer Details

This API is used to update the details of a single customer. The request should contain only those elements that require modification. Empty elements denote the overriding of the existing value with a NULL value.

HTTP URL  
PATCH /api/v2/customer/{id}

Eligibility

The Requester is eligible to request modifications on sub-customers’ information. The Requester is not eligible to request modifications on its own profile.

API Request

Request Structure

Element Type M/O/CM Description
type String O Customer type. For example, Private
name String O Business or private name
allowOfferDelegation Boolean O

Defines whether the customer is allowed by the parent customer to attach parent packages or parent plans to his subscribers.

  • True = The customer is allowed to self-attach parent customer packages or plans to its own subscribers.
  • False = The customer is not allowed to self-attach parent customer packages or plans.
isAllowedImeiLock Boolean O  
vatRegistrationNumber String O Tax registration number
contact Object O Customer contact details object.
address Object O Array of customer address details object.
invoiceConfiguration Object O Invoice configuration details object. If not provided, the system will apply the default configuration values.
campaign Numeric O Array of customer related campaign IDs.
customFields Object O Placeholder array used for customization purposes (future feature).
mfaConfiguration String O

Defines whether to change Multi-Function Authentication (MFA) configuration for his users. ENUM valid values: MANDATORY, ENABLED, DISABLED

  • Mandatory – The MFA feature is configured as always turned on.

  • Enabled – The MFA feature is configured as turned on by default but can be turned off.

  • Disabled – The MFA feature is configured as always turned off.

Contact Data objects

Element Type M/O/CM Description
id UUID M Contact ID
emailAddress String O Email address; validated via Regular Expression
type String O Contact type, whether owner of the customer or a member. ENUM: OWNER, MEMBER
role String M Eligible to enter the self-care application. ENUM: SELFCARE, NONE
salutation String O Contact salutation. ENUM: MR, MS
firstName String O Contact first name
middleName String O Contact middle name
lastName String O Contact last name
identity Object O Array of contact identity numbers.
gender String O Contact gender.ENUM: MALE, FEMALE
birthdate Date O Contact date of birth. Format: DDMMYYYY
landlinePhoneNumber String O CBR, can be reached phone number. Mandatory if mobilePhoneNumber is not provided
mobilePhoneNumber String O CBR, can be reached phone number. Mandatory if landlinePhoneNumber is not provided. Format: International E.164
additionalPhoneNumber String O Additional phone number where the contact can be reached
picture String O Contact photograph (future feature)
remarks String O General remarks
isPrimary Boolean O

Determines whether the contact is primary or not.

  • True = Primary contact

  • False = No primary contact

Identity data objects

Element Type M/O/CM Description
idType String O Identity type: ENUM: ID, PASSPORT, DRIVER_LICENSE
idNumber String O ID number

Address data objects

Element Type M/O/CM Description
id UUID M Address ID
type String O Address type. ENUM: PRIVATE, SHIPPING, MAILING
street String O Street name
buildingNumber String O Building number on the street
buildingName String O Building name (alias) if it exists
buildingFloor String O Floor number in the building
zipCode String O Zip postal code
apartmentNumber String O Apartment number in the building
entrance String O Entrance identifier. Can be a letter or number
city String O City name
province String O Province name
state String O State name
country String O Country name
pobox String O Postal Office Box number
salutation String O Address representative salutation. ENUM: MR, MS
fullName String O Representative full name
title String O Address representative title. ENUM: DR, PROF
company String O Company name
emailAddress String O Email address. Validated via Regular Expression
isPrimary Boolean O

Determines whether the contact is primary or not.

  • True = Primary contact

  • False = No primary contact

Invoice configuration data objects

Element Type M/O/CM Description
chargeByActive String O Charge by SIM (ICCID) or IMSI. ENUM: SIM, IMSI
activityIndication String O DWH event mapping. ENUM: NETWORK_REGISTRATION, DATA_CONSUMPTION
deviceCost Decimal O Cost of the chosen active device
deliveryMethod String O The requested invoice delivery method. ENUM: EMAIL, POSTAL, EDI
paymentDueAfterInvoiceIssued Numeric O The invoice payment due after some period. The count starts once the invoice is issued.
paymentDueUnits String CM Selected time interval to use in Payment Due After Invoice Issued. ENUM: DAYS. Mandatory if paymentDueAfterInvoiceIssued is provided.
vat Decimal O

Fixed tax percentage.

  • Range:

  • Minimum: 0%

  • Maximum: Unlimited
invoiceText String O Free text shown in the invoice. Maximum size: 60 bytes

Custom fields data objects (Not available in current release)

Element Type M/O/CM Description
keyName String O Name of the custom element
keyValue String O Custom element 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
GLOBAL_1001 Service unavailable. Please try again
CUSTOMER_1002 Customer does not exist
CUSTOMER_1003 Failed to update customer details

Examples

Request Body

Copy 
{
    "name": "Volvo"
}

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": "GLOBAL_1001",
  "errorMessage": "Service unavailable. Please try again",
  "content": "",
  "pageable": ""
}