Skip to main content
PATCH
/
tasks
/
{taskId}
Update a task
curl --request PATCH \
  --url https://rest.breakcold.com/api/v1/tasks/{taskId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "descriptionHtml": "<string>",
  "descriptionPlain": "<string>",
  "dueAt": 123,
  "assigneeUserIds": [
    "<string>"
  ]
}
'
import requests

url = "https://rest.breakcold.com/api/v1/tasks/{taskId}"

payload = {
"title": "<string>",
"descriptionHtml": "<string>",
"descriptionPlain": "<string>",
"dueAt": 123,
"assigneeUserIds": ["<string>"]
}
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({
title: '<string>',
descriptionHtml: '<string>',
descriptionPlain: '<string>',
dueAt: 123,
assigneeUserIds: ['<string>']
})
};

fetch('https://rest.breakcold.com/api/v1/tasks/{taskId}', 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://rest.breakcold.com/api/v1/tasks/{taskId}",
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([
'title' => '<string>',
'descriptionHtml' => '<string>',
'descriptionPlain' => '<string>',
'dueAt' => 123,
'assigneeUserIds' => [
'<string>'
]
]),
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://rest.breakcold.com/api/v1/tasks/{taskId}"

payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"descriptionHtml\": \"<string>\",\n \"descriptionPlain\": \"<string>\",\n \"dueAt\": 123,\n \"assigneeUserIds\": [\n \"<string>\"\n ]\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://rest.breakcold.com/api/v1/tasks/{taskId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"descriptionHtml\": \"<string>\",\n \"descriptionPlain\": \"<string>\",\n \"dueAt\": 123,\n \"assigneeUserIds\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://rest.breakcold.com/api/v1/tasks/{taskId}")

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 \"title\": \"<string>\",\n \"descriptionHtml\": \"<string>\",\n \"descriptionPlain\": \"<string>\",\n \"dueAt\": 123,\n \"assigneeUserIds\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "task": {
    "id": "<string>",
    "workspaceId": "<string>",
    "title": "<string>",
    "createdAt": 123,
    "updatedAt": 123,
    "recordId": "<string>",
    "descriptionHtml": "<string>",
    "descriptionPlain": "<string>",
    "dueAt": 123,
    "assigneeUserIds": [
      "<string>"
    ],
    "linkedResources": [
      {
        "resourceType": "<string>",
        "resourceId": "<string>",
        "label": "<string>",
        "channel": "<string>"
      }
    ]
  }
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}
{
"error": {
"code": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>",
"retryAfterMs": 123
}
}

Authorizations

Authorization
string
header
required

Breakcold public API key, for example Bearer bc_live_....

Headers

X-Breakcold-Organization-Id
string

Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token.

Path Parameters

taskId
string
required

Body

application/json
title
string
descriptionHtml
string
descriptionPlain
string
status
enum<string>
Available options:
todo,
done
dueAt
number | null
assigneeUserIds
string[]
Minimum string length: 6

Response

Success

task
object
required