Requests that the user's login email address will be changed. This does not permanently change the address yet, but sends out the confirmation email. Every user can change the own email address. Changing someone else's address requires certain permissions.

PATCH

/api/user/{userId}/email

Authorizations

api_key

Type: API Key (header: X-CSRF-Token)

Parameters

Path Parameters

userId*

Typestring

Required

Request Body

{

"email": "string",

"password": "string"

}

Responses

Success

PATCH

/api/user/{userId}/email

Authorization

api_key

Variables

Key

Value

userId*

curl -X PATCH \
'http://localhost/api/user/{userId}/email' \
 --data '{
  "email": "string",
  "password": "string"
}'

Samples

cURL

curl -X PATCH http://localhost/api/user/{userId}/email

JavaScript

fetch("http://localhost/api/user/{userId}/email", { method: "PATCH" })
  .then(response => response.json())
  .then(data => console.log(data));

PHP

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://localhost/api/user/{userId}/email");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Python

import requests
response = requests.patch("http://localhost/api/user/{userId}/email")
print(response.json())