Skip to main content
POST
manage boards

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 key's own.

Body

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

Board name or id, required for get, update and delete.

confirm
string

The word "delete", to delete the board named with its columns and every card's place on them. Permanent; the answer says what went; the items stay.

Allowed value: "delete"
limit
integer

get: how many cards to read, up to 500. The whole board when left out.

cursor
string

get: next_cursor from the read before, with the same board.

name
string

The board's name (create), or its new name (update). Renaming the board renames the field, and the cards keep their columns.

description
string

What this board is for (create or update): the line another agent reads to tell two boards apart.

columns
object[]

Lay out columns left to right. On create this is the whole board; on update they are appended, and a name already on the board is skipped rather than duplicated.

update_columns
object[]

update: rename, recolor or set the limit on a column. Its cards keep their place in it.

reorder_columns
string[]

update: column names or ids in the order they should read left to right. Any left out keep their order behind them.

delete_columns
string[]

update: remove these columns. Whatever sat in them comes OFF the board, since a column is what membership means; the items stay in the library.

order_in_column
object[]

update: the vertical order inside a column, the order a user sets by dragging. A named card sitting elsewhere is skipped, not moved; changing columns is update_items.

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[]