Change password

Change password for signed-in user
Note: Use this endpoint to change a user’s password

Authorizations

x-api-key

string

headerrequired

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.

Body

application/json

userId

string

User ID

resetToken

string

Access token

newPassword

string

New password

Response

200 - application/json

User

isActive

boolean

true: User is active<br />false: User is not active

registrationDate

string

Time user was registered

expiryDate

string

Time user's registration expires

roles

string[]

User roles

name

object

User's full name

Show child attributes

phone

object[]

User's telephone numbers and details

Show child attributes

email

string

User's email address

extra

object

Extra user details

registrationSite

string

XXX

account

string

Merchant account ID

userId

string

User ID

address

object[]

User address

Show child attributes

provider

object[]

Additional user details

Show child attributes

createdAt

string

Time user was created

updatedAt

string

Time user was last updated