Customers

The Customer object supports the storage of a defined set and custom attributes relating to your customers.

Portal View

Accessing Customers

Assess the Customers screen in the console via the console navigation bar.

Add New Customers

Click Add New to create a new customer.

Specify a First Name. Last Name, Display Name and Email Address.

Click Submit.

Edit Customers

Customers can be accessed by clicking on the main customer screen:

Customer Details can be edited.

Click Save to commit your modifications.

Customers can be deleted by clicking the Delete button.

Customer Properties

Attributes
Sample Object
Attributes

Element

Description

customerId

A unique identifier for the Customer (Guid/UUID)

version

A incremental version number tracking modifications to the Customer object

firstName

Customer First Name

lastName

Customer Last Name

displayName

Customer Display Name

emailAddress

Customer Email Address in

phones[]

An array of Phone numbers

phones[].Key

A unique identifier for the Phone Number (Guid/UUID)

phones[].Type

Unknown, Phone, Mobile

phones[].Country

ISO Country Code

phones[].NumberLocal

Phone Number in Local format

phones[].NumberInternational

Phone Number in International format

addresses[]

An array of address(es)

addresses[].Key

A unique identifier for the Address (Guid/UUID)

addresses[].Address1

Address Line 1

addresses[].Address2

Address Line 2

addresses[].Suburb

Suburb

addresses[].PostCode

Postal Code/Zip Code

addresses[].State

State/Province/Region

addresses[].Country

Country

attributes

Attributes are a list of Key/Value to support customisation of a Customer

Sample Object
{
"customerId": "string",
"version": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"emailAddress": "string",
"phones": [
{
"key": "string",
"type": "Unknown",
"country": "string",
"numberLocal": "string",
"numberInternational": "string"
}
],
"addresses": [
{
"key": "string",
"address1": "string",
"address2": "string",
"suburb": "string",
"postcode": "string",
"state": "string",
"country": "string"
}
],
"attributes": {}
}