Skip to content
calternal docs

Create a Task

POST
/api/v1/notes/tasks
curl --request POST \
  --url https://example.com/api/v1/notes/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "body": "example", "standalone": true, "status": "example", "text": "example" }'

Requires a signed-in User with the data scope. It creates a Task from text and optional body content. It returns 400 when the Task text or fields are invalid. Route: /api/v1/notes/tasks. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
body

Markdown prose placed before the Task checkbox.

string | null
standalone

Keep the Task standalone even when a Log entry exists.

boolean
status

Initial workflow Status for a Board lane Add task action (todo, doing, waiting, blocked, done or cancelled).

string | null
text
required

TickTick-style composer text. The server resolves dates and properties.

string
Examplegenerated
{
  "body": "example",
  "standalone": true,
  "status": "example",
  "text": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”
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"
}