Forgot Password

Sends an email to a user with a reset password link. This API is invoked when a user initiates the forgot password flow on the app of a business.

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
Accept-Language
Type: string

Preferred language
User-Agent
Type: string
required

Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.

Body

application/json

client
Type: string
required

OAuth client ID provided by the business
user
Type: object

Responses

application/json
application/json
application/json

post/api2/mobile/users/forgot_password

curl https://SERVER_NAME_GOES_HERE.punchh.com/api2/mobile/users/forgot_password \
  --request POST \
  --header 'x-pch-digest: {{$$.env.signature}}' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Accept-Language: en' \
  --header 'User-Agent: AppName/AppVersion/BuildNumber (OS; Model; MANUFACTURER; MODEL; OS Version)' \
  --data '{
  "client": "CLIENT_GOES_HERE",
  "user": {
    "email": "test@example.com"
  }
}'

Show Schema

{}