Skip to content
calternal docs

Change Task properties

PATCH
/api/v1/notes/tasks/properties
curl --request PATCH \
  --url https://example.com/api/v1/notes/tasks/properties \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "fields": { "additionalProperty": "example" }, "tags": [ "example" ], "task_id": "example" }'

Route: /api/v1/notes/tasks/properties. Inputs: If-Match. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
If-Match
string | null

Optional Task revision for guarded Undo

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Edit a standalone Task by its identity, without Note property fields (#833, §41).

object
fields

Task fields plus the internal task-root-block-id reminder identity. Null removes an optional field.

object
key
additional properties
string | null
tags
Array<string> | null
task_id
required
string
Examplegenerated
{
  "fields": {
    "additionalProperty": "example"
  },
  "tags": [
    "example"
  ],
  "task_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
attached_day
string | null
created
string | null
created_at

RFC 3339 creation instant, including the User’s offset (#655).

string | null
due
string | null
due_time

Local clock paired with due, when this Task has a timed due date.

string | null
kind
required
string
links
required

Outgoing links for the derived ## Links view.

Array<string>
priority
string | null
recurrence
string | null
revision

Strong revision returned by Task writes for guarded Undo.

string | null
scheduled
string | null
scheduled_time

Local clock paired with scheduled, when this Task has a timed date.

string | null
source
required
string
start
string | null
start_time

Local clock paired with start, when this Task has a timed date.

string | null
status
required
string
tags
required
Array<string>
task_id
required

File Tasks use calternal-id; inline tasks keep their block identity.

string
title
required
string
Examplegenerated
{
  "attached_day": "example",
  "created": "example",
  "created_at": "example",
  "due": "example",
  "due_time": "example",
  "kind": "example",
  "links": [
    "example"
  ],
  "priority": "example",
  "recurrence": "example",
  "revision": "example",
  "scheduled": "example",
  "scheduled_time": "example",
  "source": "example",
  "start": "example",
  "start_time": "example",
  "status": "example",
  "tags": [
    "example"
  ],
  "task_id": "example",
  "title": "example"
}

412

Section titled “412”

Task changed