POST
/
v1
/
customers

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Customer details

customerReferenceId
string
required

Unique customer reference ID

locale
string
required

Customer locale (language_country)

email
string
required

Customer's email address

firstName
string
required

Customer's first name

lastName
string
required

Customer's last name

communicationPreference
object
required

Customer's communications preferences

contactnumber
string

Customer's contact number

middleName
string

Customer's middle name or initial

segment
string[]

Customer's segments

employeeId
string

Customer employee ID

Response

200 - application/json

Customer details after creation

id
string

Customer ID

customerReferenceId
string

Customer reference ID

locale
string

Customer locale (language_country)

email
string

Customer's email address

contactNumber
string

Customer's contact number

firstName
string

Customer's first name

middleName
string

Customer's middle name or initial

lastName
string

Customer's last name

segment
string[]

Customer's segments

employeeId
string

Customer employee ID

communicationPreference
object

Customer's communications preferences

status
enum<string>

Customer status

Available options:
ACTIVE,
INACTIVE
createdAt
string

Time customer was created

updatedAt
string

Most recent time customer was updated