Forgot Password

Triggers the forgot password email sent to the user's email address containing the password reset link.

Headers

x-pch-digest
Type: string
required

The signature for the API call
Content-Type
Type: string
required

Set this header to application/json.
Accept
Type: string
required

Advertises which content types the client is able to understand
User-Agent
Type: string
required

For details, see User Agent.

Body

application/json

client
Type: string
required

Client key of the business
user
Type: object
Properties: 1

Responses

application/json
412

Sending invalid Signature
422

Sending invalid Entity

post/api/auth/users/forgot_password

curl https://SERVER_NAME_GOES_HERE.punchh.com/api/auth/users/forgot_password \
  --request POST \
  --header 'x-pch-digest: SIGNATURE_GOES_HERE' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'User-Agent: Punchh/OnlineOrder/1.0/Web/BrowserVersion/OS_Type' \
  --data '{
  "user": {
    "email": "test@example.com"
  },
  "client": "CLIENT_GOES_HERE"
}'

Show Schema

Blank Response

Blank Response.