Skip to main content
POST
manage comments

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
add
object[]
edit
object[]
archive
string[]

Thread ids to put away.

unarchive
string[]

Thread ids to bring back.

delete
string[]

Comment ids to delete. Your own words only, and refused where somebody has replied; a whole thread is deleted only from the app.

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