POST
/
Customers

Authorizations

Authorization
string
headerrequired

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
name
object
required

The full name of the customer.

emailAddress
string
required

The customer's email.

phone
object
externalId
string

A UUID of the customer.

additionalAttributes
object

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

Response

201 - application/json
id
string
required

A 24-character system-generated customer ID.

name
object
required

The full name of the customer.

emailAddress
string
required

The customer's email.

isDeleted
boolean
required

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

createdAt
string
required

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

updatedAt
string | null
required

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

status
enum<string>

The status of the customer.

Available options:
ACTIVE,
INACTIVE,
BLOCKED
phone
object
externalId
string

A UUID of the customer.

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.