Set favorite state

PATCH/v1/cards/{cardId}/favorite

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

cardIdstringrequired

Request body

application/json

isFavoritedbooleanrequired

Responses

200

Updated favorite state

aiSummarystring | null

aiTagsstring[]required

appUrlstring<uri>required

compactUrlstring | nullrequired

256px rendition URL for small cards; present for image uploads.

contentstringrequired

createdAtnumberrequired

detailUrlstring | null

fileExtensionstring | null

fileKindstring | null

fileLanguagestring | null

fileNamestring | null

filePreviewobject | null

fileSizenumber | null

fileUrlstring | null

idstringrequired

isFavoritedbooleanrequired

linkPreviewImageUrlstring | null

metadataDescriptionstring | null

metadataTitlestring | null

mimeTypestring | null

notesstring | null

placeholderUrlstring | nullrequired

48px loading-placeholder rendition URL; present for image uploads.

screenshotUrlstring | null

tagsstring[]required

thumbnailUrlstring | null

typestringrequired

updatedAtnumberrequired

urlstring | 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

cardIdpath*

Bodyapplication/json

isFavoritedboolean*

Request

curl -X PATCH "https://teakvault.com/api/v1/cards/string/favorite" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "isFavorited": true
}'

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

import requests

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

Response

{
  "aiSummary": "string",
  "aiTags": [
    "string"
  ],
  "appUrl": "http://example.com",
  "compactUrl": "string",
  "content": "string",
  "createdAt": 0,
  "detailUrl": "string",
  "fileExtension": "string",
  "fileKind": "string",
  "fileLanguage": "string",
  "fileName": "string",
  "filePreview": {},
  "fileSize": 0,
  "fileUrl": "string",
  "id": "string",
  "isFavorited": true,
  "linkPreviewImageUrl": "string",
  "metadataDescription": "string",
  "metadataTitle": "string",
  "mimeType": "string",
  "notes": "string",
  "placeholderUrl": "string",
  "screenshotUrl": "string",
  "tags": [
    "string"
  ],
  "thumbnailUrl": "string",
  "type": "string",
  "updatedAt": 0,
  "url": "string"
}