PUT
/
v1
/
customers
/
{id}
curl --request PUT \
  --url https://prod01.copilot.fabric.inc/data-subscription/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "customerReferenceId": "12345",
  "locale": "en_US",
  "email": "customer@example.com",
  "contactnumber": "+923333709568",
  "firstName": "Pat",
  "middleName": "E",
  "lastName": "Kake",
  "segment": [
    "employee"
  ],
  "employeeId": "345",
  "communicationPreference": {
    "email": true,
    "sms": true
  }
}'
{
  "id": "62cffd65e8d7eb868c6a29d6",
  "customerReferenceId": "12345",
  "locale": "en_US",
  "email": "customer@example.com",
  "contactNumber": "+923333709568",
  "firstName": "Pat",
  "middleName": "E",
  "lastName": "Kake",
  "segment": [
    "employee"
  ],
  "employeeId": "345",
  "communicationPreference": {
    "email": true,
    "sms": true
  },
  "status": "ACTIVE",
  "createdAt": "2021-10-12T21:35:05.756Z",
  "updatedAt": "2021-10-14T05:40:55.997Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Customer ID

Example:

"62cffd65e8d7eb868c6a29d6"

Body

application/json
Details of customer being updated

Customer details

​
customerReferenceId
string
required

Unique customer reference ID

Example:

"12345"

​
locale
string
required

Customer locale (language_country)

Example:

"en_US"

​
email
string
required

Customer's email address

Example:

"customer@example.com"

​
firstName
string
required

Customer's first name

Example:

"Pat"

​
lastName
string
required

Customer's last name

Example:

"Kake"

​
communicationPreference
object
required

Customer's communications preferences

​
contactnumber
string

Customer's contact number

Example:

"+923333709568"

​
middleName
string

Customer's middle name or initial

Example:

"E"

​
segment
string[]

Customer's segments

Customer's segment (employee, management, pro user, etc.)

​
employeeId
string

Customer employee ID

Example:

"345"

Response

200
application/json
Request processed successfully

Customer details after creation

​
id
string

Customer ID

Example:

"62cffd65e8d7eb868c6a29d6"

​
customerReferenceId
string

Customer reference ID

Example:

"12345"

​
locale
string

Customer locale (language_country)

Example:

"en_US"

​
email
string

Customer's email address

Example:

"customer@example.com"

​
contactNumber
string

Customer's contact number

Example:

"+923333709568"

​
firstName
string

Customer's first name

Example:

"Pat"

​
middleName
string

Customer's middle name or initial

Example:

"E"

​
lastName
string

Customer's last name

Example:

"Kake"

​
segment
string[]

Customer's segments

Customer's segment (employee, management, pro user, etc.)

​
employeeId
string

Customer employee ID

Example:

"345"

​
communicationPreference
object

Customer's communications preferences

​
status
enum<string>

Customer status

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
createdAt
string

Time customer was created

Example:

"2021-10-12T21:35:05.756Z"

​
updatedAt
string

Most recent time customer was updated

Example:

"2021-10-14T05:40:55.997Z"

Was this page helpful?