Skip to main content
POST
Create a planning card

Authorizations

Authorization
string
header
required

An API key from the web app (Settings → Developer), sent as Authorization: Bearer rvl_live_….

Path Parameters

projectId
string
required

Project id, proj_….

Body

application/json
title
string
required
Required string length: 1 - 200
columnId
string
required

The column (col_…) to add the card to.

type
enum<string>
default:planned

planned (default): work to do, which runs can be linked to. run: tracks one run of the project, given as runId.

Available options:
planned,
run
runId
string

For a run card: the run (run_…) it tracks, which must be in the project.

description
string

The card's description, in format.

Maximum string length: 90000
format
enum<string>
default:markdown

markdown (default) or html. Descriptions are stored as HTML from the web app's editor. Markdown is converted both ways; it drops colours, font sizes and alignment. HTML is sanitised to what the editor itself produces.

Available options:
markdown,
html
engine
string

Engine slug the work is planned for, e.g. revscreen.

Required string length: 1 - 64
plannedStart
string<date>

Planned start, a date (YYYY-MM-DD).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
plannedEnd
string<date>

Planned end, a date (YYYY-MM-DD).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
assignee
string

Who the card is assigned to: a user_… id or an email. They must be the project's owner or one of its members.

Required string length: 1 - 320

Response

OK

id
string
required

Card id, card_….

type
enum<string>
required

planned: work to do, with linkedRuns. run: tracks run.

Available options:
planned,
run
title
string
required
column
object
required
position
number
required

0-based position in the column.

engine
string | null
required

Engine slug the work is planned for; null if none, or for engines the API doesn't expose.

plannedStart
string | null
required

YYYY-MM-DD.

plannedEnd
string | null
required

YYYY-MM-DD.

assignee
object | null
required
createdBy
object
required
run
object | null
required

The run a run card tracks; null for planned cards, or once the run is deleted.

linkedRuns
object[]
required

Runs linked to a planned card, oldest link first.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
format
enum<string>
required
Available options:
markdown,
html
description
string | null
required

The card's description, in format.