Skip to content

Update a card

PATCH/v1/cards/{cardId}
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
contentstring

Replacement card content. Text-card Markdown is preserved exactly and is limited to 512 KiB measured in UTF-8 bytes.

notesstring | null
tagsstring[]
urlstring
Responses
200

Updated card

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
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH "https://teakvault.com/api/v1/cards/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "---\r\ntitle: Notes\r\n---\r\n\r\n# Heading  \r\n",
  "notes": "string",
  "tags": [
    "string"
  ],
  "url": "string"
}'
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"
}