English

Deutsch

English

Deutsch

Appearance

Sets the current user's sleep mode. For the temporary mode, both 'from' and 'to' need to be given. Both are assumed to be in the format 'd.m.Y'. For other modes the two fields will be ignored. Optionally, a message can be added.​

PATCH
/api/user/sleepmode

Authorizations​

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

Request Body​

JSON
{
"mode": "string",
"from": "string",
"to": "string",
"message": "string"
}

Responses​

Success
Authorization
api_key
cURL
curl -X PATCH \
'http://localhost/api/user/sleepmode' \
 --data '{
  "mode": "string",
  "from": "string",
  "to": "string",
  "message": "string"
}'

Samples​

cURL
curl -X PATCH http://localhost/api/user/sleepmode
JavaScript
fetch("http://localhost/api/user/sleepmode", { method: "PATCH" })
  .then(response => response.json())
  .then(data => console.log(data));
PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://localhost/api/user/sleepmode");
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/sleepmode")
print(response.json())