Create customer

post

https://example.com/customers/private/v1/customers

The API allows to create new customer in the system

Body Params

Created customer object

uid

string

Customer ID for the new customer

string

Email address of the new customer

customername

string

Customername of the new customer

firstName

string

First name of the new customer

lastName

string

Last name of the new customer

phoneNumber

string

Phone number of the new customer

isCorporate

boolean

Flag indicating if the customer is a corporate customer

roleName

string

Role name of the new customer

parentId

string

ID of the parent customer

status

string

Status of the new customer

customerGroup

object

customerGroupId

number

ID of the customer group

createdAt

string

Date and time when the customer was created

updatedAt

string

Date and time when the customer was last updated

lastLoginAt

string

Date and time of the customer's last login

lastActedAct

string

Last action performed by the customer

lastLoginIp

string

IP address of the customer's last login

challengeName

string

enum

This information indicates that the customer should do something. For example if the value is equal 'new_password_required' it means the customer should change own password.

Allowed:

blockedUntil

string

Date and time until which the customer is blocked

isPhoneConfirmed

boolean

Flag indicating if the customer's phone number is confirmed

isEmailConfirmed

boolean

Flag indicating if the customer's email address is confirmed

companyDetails

object

companyId

integer

ID of the customer's company

physicalAddresses

array of objects

Array of physical addresses associated with the customer

physicalAddresses

mailingAddresses

array of objects

Array of mailing addresses associated with the customer

mailingAddresses

classId

integer

ID of the customer's class

dateOfBirth

string

Date of birth of the customer

documentType

string

Type of document associated with the customer

documentPersonalId

string

Personal ID document of the customer

internalNotes

string

internal notes left by the admin

position

string

customer's position

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

401Unauthorized

403Forbidden

409Conflict

422Unprocessable Entity

500Internal Server Error