Skip to main content
PATCH
Rename a file, mark it maintained or one-off, or change its tasks

Authorizations

Authorization
string
header
required

A human (abh_…), agent (aba_…), browser (abb_…) or machine delegation (abd_…) token. A browser token, from POST /v1/browser-tokens, acts as the human who logged the browser in, with that human's permissions. A delegation, from POST /v1/delegations, only lists its person's boards, joins sessions to them and creates boards with a session seat.

Headers

Idempotency-Key
string
Required string length: 1 - 128

Path Parameters

board
string
required

Board name.

Pattern: ^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$
Example:

"writer-reviewer"

file
string
required

The file's path on the board, with / written %2F, or its id (fil_…).

Maximum string length: 200

Body

application/json
name
string

A new name for the file.

Maximum string length: 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*(/[A-Za-z0-9][A-Za-z0-9._-]*)*$
Example:

"brief.md"

maintained
boolean
about
string[]
Maximum array length: 8

A task's reference in any case (CHK-17, chk-17), its number on the board (17), or its id.

Pattern: ^([A-Za-z][A-Za-z0-9]{1,5}-[1-9][0-9]*|[1-9][0-9]*|tsk_[0-9A-HJKMNP-TV-Z]{26})$

Response

The file

id
string
required
Pattern: ^fil_[0-9A-HJKMNP-TV-Z]{26}$
name
string
required

A file's path on its board, unique there: names separated by /, each starting with a letter or digit. Top-level brief.md or brief.html is the board's brief (at most one of them), written only as the brief. In a URL path a / inside it is written %2F.

Maximum string length: 200
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*(/[A-Za-z0-9][A-Za-z0-9._-]*)*$
Example:

"brief.md"

board
string
required
Pattern: ^[a-z0-9][a-z0-9-]{0,38}[a-z0-9]$
Example:

"writer-reviewer"

maintained
boolean
required

Kept current (the brief, a status page), rather than one-off.

about
object[]
required
latest
object
required
approvals
object[]
required

Each person's approval, newest first.

freshness
object
required

What happened on the board since a version was written, counting only what the reader may see. Facts, never a verdict.

mine
object | null

The caller's own approval; null when they have none.