Rename or recolor a folder

PATCH/v1/folders/{folderId}

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

folderIdstringrequired

Request body

requiredapplication/json

namestring

1 to 300 characters, unique per account ignoring case.

colorstring | null

A palette color, or null to clear it.

Allowed:grayredorangeambergreentealbluevioletpinknull

Responses

200

Folder updated

idstringrequired

namestringrequired

colorstring | nullrequired

Allowed:grayredorangeambergreentealbluevioletpinknull

kindstringrequired

Allowed:manualsmart

cardCountnumberrequired

Cards in the folder that are not archived or in Trash.

createdAtnumberrequired

updatedAtnumberrequired

404

Folder not found

409

A folder with this name exists

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

folderIdpath*

Bodyapplication/json

namestring1 to 300 characters, unique per account ignoring case.colorstringA palette color, or null to clear it.

Request

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

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

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

import requests

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

package main

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

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

$response = curl_exec($curl);

Response

{
  "id": "string",
  "name": "string",
  "color": "gray",
  "kind": "manual",
  "cardCount": 0,
  "createdAt": 0,
  "updatedAt": 0
}