/api/client/password2

Request a new password mail for an existing user. Looks up the account by email (and optional /cid suffix) or by numeric id, generates a password if none is set, and sends it to the user's mail address.

Change Note: add blocked indication

Parameters

(string) email address of the user (may include /cid suffix to disambiguate)
(int) numeric customer id (alternative to email)
(int) 1 = return real exit code, 0 = collapse no_user/multiple/no_tour to 'sent' to prevent user enumeration (default 0 , may be enforced by system settings)
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized.

Response Types

SendPasswordResult

SendPasswordResult (v1) docs

Result of a password reminder request. When verbose=0 (default) the only success result is 'sent', regardless of whether the user actually exists; this prevents user enumeration. The 'blocked' and 'slower' results are always returned as-is.

Fields (2)
#FieldTypeDescription
0actionstringthe action that was performed
1resultstringexit code: sent (password mail dispatched, or silently swallowed in non-verbose mode), no_user (no matching user found, only when verbose=1), multiple (email is ambiguous across multiple accounts, only when verbose=1), no_tour (new customer not allowed to request a password, only when verbose=1), blocked (account or email is blocked), slower (rate limit hit on this account or host)

Data (1 record)

actionresult
SendPasswordsent