POST
/
User
/
authreset
curl --request POST \
  --url https://api-sandbox.payabli.com/api/User/authreset \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "email": "example@email.com",
  "entry": "test",
  "entryType": 2
}'
{
  "responseText": "Success",
  "isSuccess": true
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Body

Input data to validate user
email
string | null

The user's email address.

Maximum length: 320
Example:

"example@email.com"

entry
string | null

Identifier for entrypoint originating the request (used by front-end apps)

Example:

"test"

entryType
integer | null

Type of entry identifier: 0 - partner, 2 - paypoint
used by front-end apps, required if an Entry is indicated.

Example:

2

Response

200 - application/json
Success
isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

Was this page helpful?