APIPay Ops endpointsUser management

Reset password

Use this endpoint to initiate a password reset for a user within an organization.

Authentication

requestTokenstring
API Key authentication via header

Request

This endpoint expects an object.
emailstringOptionalformat: "email"<=320 characters
The user's email address.
entrystringOptional

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

entryTypeintegerOptional

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

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessboolean or null

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

Errors