Add a new customer

Using this endpoint, you can add a new customer to the system. The response includes an id which is required in subsequent calls, such as GET /customers/{customerId}, PUT /customers/{customerId}, PATCH /customers/{customerId}, and more.
When externalId is specified, the customers have the ability to manage their own details through the storefront UI.

Authorizations

Authorization

string

header

required

The access token.

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id

string

A UUID of the request.

Body

application/json

emailAddress

string

required

The customer's email.

name

object

required

The full name of the customer.

Show child attributes

name.firstName

string

required

The customer's first name.

name.lastName

string

required

The customer's last name.

name.middleName

string

The customer's middle name.

name.suffix

string

The suffix for the customer's name, such as Jr., PhD, and more.

name.title

string

The customer's title, such as Mr., Mrs, and Dr.

additionalAttributes

object

A placeholder for additional info, in key-value pairs.

externalId

string

A UUID of the customer.

phone

object

Show child attributes

phone.number

string

The customer's phone number.

phone.type

enum<string> | null

The type of phone number.

Available options:

MOBILE,

HOME,

BUSINESS

Response

201 - application/json

createdAt

string

required

The time when the customer was added, in UTC format.

emailAddress

string

required

The customer's email.

id

string

required

A 24-character system-generated customer ID.

isDeleted

boolean

required

A flag indicating whether the customer data is deleted. true indicates the customer data is deleted and false indicates otherwise.

name

object

required

The full name of the customer.

Show child attributes

name.firstName

string

required

The customer's first name.

name.lastName

string

required

The customer's last name.

name.middleName

string

The customer's middle name.

name.suffix

string

The suffix for the customer's name, such as Jr., PhD, and more.

name.title

string

The customer's title, such as Mr., Mrs, and Dr.

updatedAt

string | null

required

The time when the customer details were last updated, in UTC format.

additionalAttributes

object

A placeholder for additional info, in key-value pairs.

deletedAt

string | null

The time when the customer data was deleted, in UTC format.

externalId

string

A UUID of the customer.

phone

object

Show child attributes

phone.number

string

The customer's phone number.

phone.type

enum<string> | null

The type of phone number.

Available options:

MOBILE,

HOME,

BUSINESS

status

enum<string>

The status of the customer.

Available options:

ACTIVE,

INACTIVE,

BLOCKED