Mark one of my notes as read

Marks a note left for the signed-in user as read and answers with the note as the Notes tab lists it.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/{noteId}/read.do

Marks a note left for the signed-in user as read and answers with the note as the Notes tab lists it. A note already read keeps the time it was first read. Only the user does this: a session in which someone else is signed in as the user (switch user) is refused. Requires the NOTES_TAB_VISIBLE permission.

Path Params

noteId integer required

Numeric id of the note, as the list of my notes reports it

7

Responses

200

{success, note: {id, title, text, date, readAt}}

400

Bad request — invalid or missing parameters

401

Unauthorized — authentication error

403

The role does not show the Notes tab (NOTES_TAB_VISIBLE), or the session is someone signed in as the user

404

The signed-in user has no note with this id

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/user-preference/notes/7/read.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body