Execute bulk card operations

POST/v1/cards/bulk

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.

Request body

application/json

itemsobject[]required

Up to 100 items. create items take content, url, notes, tags, cardType, sourceUrl and sourceTitle; update items take cardId plus content, url, notes or tags; favorite items take cardId and isFavorited. delete, restore, archive and unarchive items take cardId. addTags and removeTags items take cardId and tags (up to 20, each at most 64 characters); tags are matched ignoring case, and removeTags also clears tags Teak added. Repeating an operation on a card already in that state succeeds without changing it.

operationstringrequired

Allowed:createupdatefavoritedeletearchiveunarchiveaddTagsremoveTagsrestore

Responses

200

Bulk operation result

operationstringrequired

Allowed:createupdatefavoritedeletearchiveunarchiveaddTagsremoveTagsrestore

resultsobject[]required

One result per item, in order: { index, status: "success", cardId } or { index, status: "error", code, error }. An item that fails changes nothing.

failedIdsstring[]required

The cardId of every item that failed, so a client can retry just those.

summaryobjectrequired

Show properties

failednumberrequired

succeedednumberrequired

totalnumberrequired

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

Bodyapplication/json

Request body

Request

curl -X POST 'https://teakvault.com/api/v1/cards/bulk' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "items": [
    {}
  ],
  "operation": "create"
}'

const response = await fetch("https://teakvault.com/api/v1/cards/bulk", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"items\": [\n    {}\n  ],\n  \"operation\": \"create\"\n}"
});

const response: Response = await fetch("https://teakvault.com/api/v1/cards/bulk", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"items\": [\n    {}\n  ],\n  \"operation\": \"create\"\n}"
});

import requests

response = requests.post(
    "https://teakvault.com/api/v1/cards/bulk",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"items\": [\n    {}\n  ],\n  \"operation\": \"create\"\n}",
)

package main

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

func main() {
	body := strings.NewReader("{\n  \"items\": [\n    {}\n  ],\n  \"operation\": \"create\"\n}")
	req, err := http.NewRequest("POST", "https://teakvault.com/api/v1/cards/bulk", 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/cards/bulk")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer YOUR_TOKEN"
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = "{\n  \"items\": [\n    {}\n  ],\n  \"operation\": \"create\"\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/cards/bulk',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "items": [
    {}
  ],
  "operation": "create"
}',
]);

$response = curl_exec($curl);

Response

{
  "operation": "create",
  "results": [
    {}
  ],
  "failedIds": [
    "string"
  ],
  "summary": {
    "failed": 0,
    "succeeded": 0,
    "total": 0
  }
}