Change password

curl --request PATCH \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/change-password \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "userId": "6169b2d892a5f30009d76480",
  "resetToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
  "newPassword": "ABC123"
}
'

{
  "isActive": true,
  "registrationDate": "2020-04-15T10:08:04.246Z",
  "expiryDate": "2020-04-15T10:08:04.246Z",
  "roles": "customer",
  "name": {
    "first": "Pat",
    "middle": "E",
    "last": "Kake"
  },
  "phone": [
    {
      "number": "555-123-4567",
      "countryCode": "+91",
      "extenstion": "x-6789",
      "kind": "Mobile"
    }
  ],
  "email": "[email protected]",
  "extra": {},
  "registrationSite": "XXX",
  "account": "xxxxxcxxxxxxxxxxxxxx",
  "userId": "6169b2d892a5f30009d76480",
  "address": [
    {
      "address1": "1234 Main St.",
      "city": "Houston",
      "state": "TX",
      "country": "USA",
      "zipCode": 77035,
      "email": "[email protected]",
      "isValidated": true,
      "isDefault": true,
      "attention": "Account Manager",
      "address2": "Suite 710",
      "address3": "Floor 7",
      "company": "Acme Inc.",
      "kind": "Business",
      "phone": {
        "number": "555-123-4567",
        "kind": "Mobile"
      },
      "name": {
        "first": "Pat",
        "last": "Kake"
      }
    }
  ],
  "provider": [
    {
      "id": "6228f647a257734d91dbb49f",
      "name": "LOCAL",
      "isActive": true,
      "registrationDate": "2020-04-15T10:08:04.246Z",
      "lastLoginDate": "2020-04-15T10:08:04.246Z"
    }
  ],
  "createdAt": "2020-04-15T10:08:04.246Z",
  "updatedAt": "2020-04-15T10:08:04.246Z"
}

PATCH

api-commerceIdentity

auth

change-password

Change password

curl --request PATCH \
  --url https://{customerDomain}.fabric.zone/api-commerceIdentity/auth/change-password \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "userId": "6169b2d892a5f30009d76480",
  "resetToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...",
  "newPassword": "ABC123"
}
'

{
  "isActive": true,
  "registrationDate": "2020-04-15T10:08:04.246Z",
  "expiryDate": "2020-04-15T10:08:04.246Z",
  "roles": "customer",
  "name": {
    "first": "Pat",
    "middle": "E",
    "last": "Kake"
  },
  "phone": [
    {
      "number": "555-123-4567",
      "countryCode": "+91",
      "extenstion": "x-6789",
      "kind": "Mobile"
    }
  ],
  "email": "[email protected]",
  "extra": {},
  "registrationSite": "XXX",
  "account": "xxxxxcxxxxxxxxxxxxxx",
  "userId": "6169b2d892a5f30009d76480",
  "address": [
    {
      "address1": "1234 Main St.",
      "city": "Houston",
      "state": "TX",
      "country": "USA",
      "zipCode": 77035,
      "email": "[email protected]",
      "isValidated": true,
      "isDefault": true,
      "attention": "Account Manager",
      "address2": "Suite 710",
      "address3": "Floor 7",
      "company": "Acme Inc.",
      "kind": "Business",
      "phone": {
        "number": "555-123-4567",
        "kind": "Mobile"
      },
      "name": {
        "first": "Pat",
        "last": "Kake"
      }
    }
  ],
  "provider": [
    {
      "id": "6228f647a257734d91dbb49f",
      "name": "LOCAL",
      "isActive": true,
      "registrationDate": "2020-04-15T10:08:04.246Z",
      "lastLoginDate": "2020-04-15T10:08:04.246Z"
    }
  ],
  "createdAt": "2020-04-15T10:08:04.246Z",
  "updatedAt": "2020-04-15T10:08:04.246Z"
}

Authorizations

x-api-key

string

header

required

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

userId

string

User ID

Example:

"6169b2d892a5f30009d76480"

resetToken

string

Access token

Example:

"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4..."

newPassword

string

New password

Example:

"ABC123"

Response

User

isActive

boolean

true: User is active
false: User is not active

Example:

true

registrationDate

string<date-time>

Time user was registered

Example:

"2020-04-15T10:08:04.246Z"

expiryDate

string<date-time>

Time user's registration expires

Example:

"2020-04-15T10:08:04.246Z"

roles

string[]

User roles

Example:

"customer"

name

object

User's full name

Show child attributes

name.first

string

User's first name

Example:

"Pat"

name.middle

string

User's middle name

Example:

"E"

name.last

string

User's last name

Example:

"Kake"

phone

object[]

User's telephone numbers and details

Show child attributes

phone.number

string

Telephone number

Example:

"555-123-4567"

phone.countryCode

string

Telephone country code

Example:

"+91"

phone.extenstion

string

Telephone number extension

Example:

"x-6789"

phone.kind

string

Phone type

Example:

"Mobile"

string

User's email address

Example:

"[email protected]"

extra

object

Extra user details

registrationSite

string

XXX

Example:

"XXX"

account

string

Merchant account ID

Example:

"xxxxxcxxxxxxxxxxxxxx"

userId

string

User ID

Example:

"6169b2d892a5f30009d76480"

address

object[]

User address

Show child attributes

address.address1

string

required

Primary address

Example:

"1234 Main St."

address.city

string

required

Address city

Example:

"Houston"

address.state

string

required

Address state

Example:

"TX"

address.country

string

required

Address country

Example:

"USA"

address.zipCode

string

required

Address zip code

Example:

77035

address.email

string

required

Email address

Example:

"[email protected]"

address.isValidated

boolean

required

true: Address has been validated
false: Address has not been validated

Example:

true

address.isDefault

boolean

required

true: This is the default address
false: This is an additional address

Example:

true

address.attention

string

Address recipient

Example:

"Account Manager"

address.address2

string

Second address line

Example:

"Suite 710"

address.address3

string

Third address line

Example:

"Floor 7"

address.company

string

Company name

Example:

"Acme Inc."

address.kind

string

Address type

Example:

"Business"

address.phone

object

Telephone number and type associated with address

Show child attributes

address.phone.number

string

Telephone number

Example:

"555-123-4567"

address.phone.kind

string

Phone type

Example:

"Mobile"

address.name

object

Show child attributes

address.name.first

string

First name on address

Example:

"Pat"

address.name.last

string

Last name on address

Example:

"Kake"

provider

object[]

Additional user details

Show child attributes

provider.id

string

Provider ID

Example:

"6228f647a257734d91dbb49f"

provider.name

enum<string>

Provider name

Available options:

LOCAL

Example:

"LOCAL"

provider.isActive

boolean

true: Provider is active
false: Provider is not active

Example:

true

provider.registrationDate

string<date-time>

Date provider was registered

Example:

"2020-04-15T10:08:04.246Z"

Most recent time user logged in

Example:

"2020-04-15T10:08:04.246Z"

createdAt

string<date-time>

Time user was created

Example:

"2020-04-15T10:08:04.246Z"

updatedAt

string<date-time>

Time user was last updated

Example:

"2020-04-15T10:08:04.246Z"

Update password Verify reset token

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Change password

Authorizations

Headers

Body

Response