Skip to main content
POST
publish to feed

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
timeline_id
string

The timeline, or any clip of a project. Give this or canvas_id.

canvas_id
string

The canvas. Give this or timeline_id.

hide
boolean

Take the post off the feed instead of publishing. The work stays.

resolved
boolean

Fold the post to its line (true) or open it again (false), instead of publishing. The work stays.

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