Change password

<Info icon="fa-light fa-lock-open" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div> No permission required. Available to all roles. </Info> Changes the password for the currently authenticated user. <Note> The client application should invalidate the authentication token. </Note>

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.
old_passwordstringRequired
new_passwordstringRequired

Response

The server has successfully fulfilled the request and that there is no additional content to send in the response payload body

Errors

422
Unprocessable Entity Error