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": {
    "firstName": "Pat",
    "lastName": "Doe",
    "title": "Dr.",
    "middleName": "E",
    "suffix": "Jr."
  },
  "emailAddress": "[email protected]",
  "phone": {
    "number": 15555551234,
    "type": "MOBILE"
  },
  "externalId": "1231012312-312-31231asda",
  "additionalAttributes": {
    "type": "shopper"
  }
}
'

{
  "id": "61df41892bf06d00092d0d8a",
  "name": {
    "firstName": "Pat",
    "lastName": "Doe",
    "title": "Dr.",
    "middleName": "E",
    "suffix": "Jr."
  },
  "emailAddress": "[email protected]",
  "isDeleted": false,
  "createdAt": "2023-08-30T23:20:42.822Z",
  "updatedAt": "2023-08-30T23:20:42.822Z",
  "status": "ACTIVE",
  "phone": {
    "number": 15555551234,
    "type": "MOBILE"
  },
  "externalId": "1231012312-312-31231asda",
  "additionalAttributes": {
    "middleName": "user"
  },
  "deletedAt": "2023-08-30T23:20:42.822Z"
}

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": {
    "firstName": "Pat",
    "lastName": "Doe",
    "title": "Dr.",
    "middleName": "E",
    "suffix": "Jr."
  },
  "emailAddress": "[email protected]",
  "phone": {
    "number": 15555551234,
    "type": "MOBILE"
  },
  "externalId": "1231012312-312-31231asda",
  "additionalAttributes": {
    "type": "shopper"
  }
}
'

{
  "id": "61df41892bf06d00092d0d8a",
  "name": {
    "firstName": "Pat",
    "lastName": "Doe",
    "title": "Dr.",
    "middleName": "E",
    "suffix": "Jr."
  },
  "emailAddress": "[email protected]",
  "isDeleted": false,
  "createdAt": "2023-08-30T23:20:42.822Z",
  "updatedAt": "2023-08-30T23:20:42.822Z",
  "status": "ACTIVE",
  "phone": {
    "number": 15555551234,
    "type": "MOBILE"
  },
  "externalId": "1231012312-312-31231asda",
  "additionalAttributes": {
    "middleName": "user"
  },
  "deletedAt": "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.

Show child attributes

name.firstName

string

required

The customer's first name.

Example:

"Pat"

name.lastName

string

required

The customer's last name.

Example:

"Doe"

name.title

string

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

Example:

"Dr."

name.middleName

string

The customer's middle name.

Example:

"E"

name.suffix

string

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

Example:

"Jr."

emailAddress

string<email>

required

The customer's email.

Example:

"[email protected]"

phone

object

Show child attributes

phone.number

string

The customer's phone number.

Example:

15555551234

phone.type

enum<string> | null

The type of phone number.

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

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

string

required

A 24-character system-generated customer ID.

Example:

"61df41892bf06d00092d0d8a"

name

object

required

The full name of the customer.

Show child attributes

name.firstName

string

required

The customer's first name.

Example:

"Pat"

name.lastName

string

required

The customer's last name.

Example:

"Doe"

name.title

string

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

Example:

"Dr."

name.middleName

string

The customer's middle name.

Example:

"E"

name.suffix

string

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

Example:

"Jr."

emailAddress

string<email>

required

The customer's email.

Example:

"[email protected]"

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

Show child attributes

phone.number

string

The customer's phone number.

Example:

15555551234

phone.type

enum<string> | null

The type of phone number.

Available options:

MOBILE,

HOME,

BUSINESS

Example:

"MOBILE"

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"

Delete customer Update customer status

⌘I

Alerts

Settings

Customers

Add a new customer

Authorizations

Headers

Body

Response