Skip to main content
POST
organize items

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
moves
object[]
labels
object[]
unlabel
object[]

Take a label off these items. The label itself stays, on everything else that carries it.

favorite
object[]
hide
object[]

Take items off the feed, or put them back. Nothing else changes: the files, their folders and every search are untouched, and search_library with hidden: true finds them again.

create_folders
string[]
rename_folders
object[]

Rename in place; everything inside moves with it.

describe_folders
object[]

Say what a folder is for, in a line. It comes back with the folder everywhere it is read, so the next session opens the job already knowing it. Empty text clears it.

update_labels
object[]

Rename or recolor a label. Items keep it; the assignment rides on the label, not its wording.

delete_labels
string[]

Delete a label. It comes off every item that carried it; no item is deleted or changed otherwise.

Label name or id.

move_folders
object[]

Reparent a folder; everything inside comes with it.

delete_folders
string[]

Delete a folder and the folders inside it. Nothing filed in them is deleted; every item moves to the top level, and the response says how many.

Folder path or id.

group_variations
object[]

Each entry groups its refs as one variation set (peers, no parent). To add items to an existing set, include any current member, and the sets merge.

ungroup_variations
string[]

Remove these items from their variation sets.

An item ref, item id, or the job id that made it.

stack_versions
object[]

Stack an item as a version of another: v2 of a cut, a re-render, a corrected export. A stack shows one item with its history behind it, where a variation set shows every peer side by side.

unstack_versions
string[]

Take these out of their version stack; each stands on its own again.

An item ref, item id, or the job id that made it.

set_current_version
string[]

Make each of these the version its stack shows.

An item ref, item id, or the job id that made it.

create_fields
object[]

Create typed columns on the workspace. A date field is what a calendar view reads, a select is what a board reads. update_items sets values by name and refuses a name that does not exist, so the field is made here first.

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