Update a time category

Updates fields of a time category. Pass archived: true to archive (soft-delete).

PATCH /{team_id}/time/categories/{time_category_id}

Update a time category

cURL

curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/time/categories/{time_category_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "billable_default": true,
  "color": "<string>",
  "archived": true
}
'

import requests

url = "https://api.superthread.com/v1/{team_id}/time/categories/{time_category_id}"

payload = {
    "name": "<string>",
    "billable_default": True,
    "color": "<string>",
    "archived": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', billable_default: true, color: '<string>', archived: true})
};

fetch('https://api.superthread.com/v1/{team_id}/time/categories/{time_category_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superthread.com/v1/{team_id}/time/categories/{time_category_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'billable_default' => true,
    'color' => '<string>',
    'archived' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.superthread.com/v1/{team_id}/time/categories/{time_category_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"billable_default\": true,\n  \"color\": \"<string>\",\n  \"archived\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.superthread.com/v1/{team_id}/time/categories/{time_category_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"billable_default\": true,\n  \"color\": \"<string>\",\n  \"archived\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superthread.com/v1/{team_id}/time/categories/{time_category_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"billable_default\": true,\n  \"color\": \"<string>\",\n  \"archived\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "time_category": {
    "id": "tc_01HQK6Z9YJZ4M9JX8FVB6QXYAB",
    "type": "time_category",
    "team_id": "tDsu0j19",
    "name": "Internal meetings",
    "billable_default": false,
    "color": "fog",
    "archived_at": 1608742037016
  }
}

{
  "error": {
    "id": "err5f744ab",
    "code": 403,
    "sec": "SEC:000-00014",
    "message": "You do not have access to this resource",
    "date": 1608742037016
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id · string · required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

time_category_id · string · required

Time Category ID.

Body

application/json

name · string | null

billable_default · boolean | null

color · string | null

archived · boolean | null

Pass true to archive (soft-delete) this category.

Response

200

application/json

Updated time category

time_category · object

Show child attributes