Change a highlight's note

PATCH/v1/highlights/{highlightId}

Authorization

AuthorizationBearer token (OAuth access token or teakapi_ API key) · headerrequired

Bearer token. Accepts either an OAuth 2.0 access token (obtained via browser sign-in; expires after 1 hour and is refreshable) or a teakapi_ API key.

Path parameters

highlightIdstringrequired

Request body

requiredapplication/json

notestring | nullrequired

The new note, at most 2,000 characters, or null to clear it.

Responses

200

Highlight updated

idstringrequired

cardIdstringrequired

quotestringrequired

The highlighted text.

notestring | nullrequired

anchoredbooleanrequired

False while Teak hasn't found the quote in the card's saved article: an imported highlight waiting for the article, or one the article doesn't have.

sourcestringrequired

Where it was made: in Teak's reader, through this API, or by an import. Clients should accept values they don't know.

Allowed:readerapiimport

createdAtnumberrequired

updatedAtnumberrequired

400

INVALID_INPUT: no note, or a note too long

codestringrequired

errorstringrequired

retryAtnumber | null

404

Highlight not found

codestringrequired

errorstringrequired

retryAtnumber | null

429

RATE_LIMITED

codestringrequired

errorstringrequired

retryAtnumber | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (OAuth access token or teakapi_ API key)Remember on this deviceInclude my values in samples

Parameters

highlightIdpath*

Bodyapplication/json

notestring*The new note, at most 2,000 characters, or null to clear it.

Request

curl -X PATCH 'https://teakvault.com/api/v1/highlights/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "note": "string"
}'

const response = await fetch("https://teakvault.com/api/v1/highlights/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"note\": \"string\"\n}"
});

const response: Response = await fetch("https://teakvault.com/api/v1/highlights/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"note\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://teakvault.com/api/v1/highlights/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"note\": \"string\"\n}",
)

package main

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

func main() {
	body := strings.NewReader("{\n  \"note\": \"string\"\n}")
	req, err := http.NewRequest("PATCH", "https://teakvault.com/api/v1/highlights/string", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

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

require "net/http"

uri = URI("https://teakvault.com/api/v1/highlights/string")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\n  \"note\": \"string\"\n}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://teakvault.com/api/v1/highlights/string',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'PATCH',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "note": "string"
}',
]);

$response = curl_exec($curl);

Response

{
  "id": "string",
  "cardId": "string",
  "quote": "string",
  "note": "string",
  "anchored": true,
  "source": "reader",
  "createdAt": 0,
  "updatedAt": 0
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}

{
  "code": "string",
  "error": "string",
  "retryAt": 0
}