Request password reset

POST

/customers/password/reset

Sends a password reset email to the specified customer.

Authorizations

bearerToken|siteContext

bearerToken

Personal access token tied to a user account. Requires the X-Nimbu-Site header to scope requests.

TypeHTTP (bearer)

+

siteContext

Identifier of the site context when authenticating with a personal access token.

TypeAPI Key (header: X-Nimbu-Site)

or

siteToken

Site-scoped API token that already encodes the site context.

TypeHTTP (bearer)

Parameters

Header Parameters

X-Nimbu-Site*

Site identifier

Typestring

Required

Authorization*

Bearer OAuth access token

Typestring

Required

Request Body

application/json

{

"email": "string"

}

Responses

reset requested

Content-Type

application/json

{

"message": "string"

}

POST

/customers/password/reset

Playground

Authorization

bearerToken

siteContext

Headers

X-Nimbu-Site*

Authorization*

Body

Samples