Request a change of a user username.
POST
/api/auth/v1/change_username
const url = 'https://example.com/api/auth/v1/change_username';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"err_redirect_uri":"example","redirect_uri":"example","new_username":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/auth/v1/change_username \ --header 'Content-Type: application/json' \ --data '{ "err_redirect_uri": "example", "redirect_uri": "example", "new_username": "example" }'Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”redirect_uri
string | null
Success (and error if err_redirect_uri not present) redirect target for non-JSON requests.
err_redirect_uri
string | null
Error redirect target for non-JSON requests.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
err_redirect_uri
Error redirect target for non-JSON requests.
string | null
redirect_uri
Success (and error if err_redirect_uri not present) redirect target for non-JSON requests.
string | null
new_username
string | null
Examplegenerated
{ "err_redirect_uri": "example", "redirect_uri": "example", "new_username": "example"}Responses
Section titled “Responses”Success, when redirect_uri not present.
Success, when redirect_uri present.
Fail, username already taken.
Fail, something went wrong.