Skip to main content
POST
manage cards

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key
string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id
string

The workspace this one call acts in, when it is not the default: for a key or a connected agent, one of the workspaces the user allowed it.

Body

application/json
action
enum<string>
required
Available options:
list,
read,
create,
update,
delete
on
string

Board or calendar, by name or id. Required for list and create.

card_id
string

Required for read, update and delete.

place
string

Board column by name or id, or calendar day as YYYY-MM-DD. Required for create; on update, moves the card within its board or calendar.

title
string

Required for create.

Required string length: 1 - 200
body
string

Markdown as in save_document, up to 20,000 characters. Empty clears it; omitted keeps it.

Maximum string length: 20000
attachments
string[]

The complete ordered list of library refs or ids. Empty removes every one; omitted keeps them.

Maximum array length: 50
labels
string[]

The complete list of labels by name or id. Empty removes every one; omitted keeps them.

Maximum array length: 20
position
number

update, on a board: the card's place in its column, top to bottom, lower first.

from
string

Calendar list: first day, YYYY-MM-DD.

to
string

Calendar list: last day, YYYY-MM-DD.

if_revision
string

The revision from read. Required for update; a stale one refuses the write.

context
string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok
any
required
data
object
required
meta
object
required
media
object[]