Rename a tag

Renames a tag on every card. Renaming to a different casing of the same tag recases it. Returns at once; poll the operation for progress. One tag change runs at a time per account.

POST/v1/tags/rename

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

requiredapplication/json

fromstringrequired

The tag to rename, matched ignoring case.

max length 64

tostringrequired

The new name, written exactly as given.

max length 64

Responses

202

Tag change started

idstringrequired

kindstringrequired

Allowed:renamemergedelete

fromstringrequired

The tag being changed, lowercased.

tostring | nullrequired

The new name (rename) or the tag merged into (merge).

statusstringrequired

Allowed:runningcompletedfailed

totalnumberrequired

Cards carrying the tag when the change started (counted up to 10000).

processednumberrequired

Cards looked at so far.

changednumberrequired

Cards rewritten so far.

errorstring | nullrequired

createdAtnumberrequired

updatedAtnumberrequired

completedAtnumber | nullrequired

operationIdstringrequired

Poll GET /v1/tags/operations/{operationId}.

400

Invalid tag name

404

No card has the tag

409

Another tag change is still running (TAG_OPERATION_RUNNING) or a tag with the new name exists (TAG_EXISTS; merge into it instead)

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

fromstring*The tag to rename, matched ignoring case.tostring*The new name, written exactly as given.

Request

curl -X POST 'https://teakvault.com/api/v1/tags/rename' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "from": "string",
  "to": "string"
}'

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

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

import requests

response = requests.post(
    "https://teakvault.com/api/v1/tags/rename",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"from\": \"string\",\n  \"to\": \"string\"\n}",
)

package main

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

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

$response = curl_exec($curl);

Response

{
  "id": "string",
  "kind": "rename",
  "from": "string",
  "to": "string",
  "status": "running",
  "total": 0,
  "processed": 0,
  "changed": 0,
  "error": "string",
  "createdAt": 0,
  "updatedAt": 0,
  "completedAt": 0,
  "operationId": "string"
}