POST
/
Customers
Add a new customer
curl --request POST \
  --url https://api.fabric.inc/v3/Customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": {
    "title": "Dr.",
    "firstName": "Pat",
    "middleName": "E",
    "lastName": "Doe",
    "suffix": "Jr."
  },
  "emailAddress": "test@example.com",
  "phone": {
    "number": 15555551234,
    "type": "MOBILE"
  },
  "externalId": "1231012312-312-31231asda",
  "additionalAttributes": {
    "type": "shopper"
  }
}'
{
  "id": "61df41892bf06d00092d0d8a",
  "name": {
    "title": "Dr.",
    "firstName": "Pat",
    "middleName": "E",
    "lastName": "Doe",
    "suffix": "Jr."
  },
  "status": "ACTIVE",
  "emailAddress": "test@example.com",
  "phone": {
    "number": 15555551234,
    "type": "MOBILE"
  },
  "externalId": "1231012312-312-31231asda",
  "additionalAttributes": {
    "middleName": "user"
  },
  "isDeleted": false,
  "deletedAt": "2023-08-30T23:20:42.822Z",
  "createdAt": "2023-08-30T23:20:42.822Z",
  "updatedAt": "2023-08-30T23:20:42.822Z"
}

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.

Example:

"517fa9dfd42d8b00g1o3k312"

​
x-fabric-request-id
string

A UUID of the request.

Body

application/json

A sample request to add a new customer.

​
name
object
required

The full name of the customer.

​
emailAddress
string<email>
required

The customer's email.

Example:

"test@example.com"

​
phone
object
​
externalId
string

A UUID of the customer.

Example:

"1231012312-312-31231asda"

​
additionalAttributes
object

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

Example:
{ "type": "shopper" }

Response

OK

​
id
string
required

A 24-character system-generated customer ID.

Example:

"61df41892bf06d00092d0d8a"

​
name
object
required

The full name of the customer.

​
emailAddress
string<email>
required

The customer's email.

Example:

"test@example.com"

​
isDeleted
boolean
required

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

Example:

false

​
createdAt
string<date-time>
required

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

Example:

"2023-08-30T23:20:42.822Z"

​
updatedAt
string<date-time> | null
required

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

Example:

"2023-08-30T23:20:42.822Z"

​
status
enum<string>

The status of the customer.

Available options:
ACTIVE,
INACTIVE,
BLOCKED
Example:

"ACTIVE"

​
phone
object
​
externalId
string

A UUID of the customer.

Example:

"1231012312-312-31231asda"

​
additionalAttributes
object

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

Example:
{ "middleName": "user" }
​
deletedAt
string<date-time> | null

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

Example:

"2023-08-30T23:20:42.822Z"