Skip to main content
POST
manage calendars

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

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

confirm
string

The word "delete", for delete.

Allowed value: "delete"
name
string

The calendar's name (create), or its new name (update); its three and their values follow.

from
string

get: first day to read, YYYY-MM-DD. Default: the start of this month, the user's time.

to
string

get: last day to read, YYYY-MM-DD. Default: the end of the month from falls in.

limit
integer

get: how many entries to read, up to 500. The whole range when left out.

cursor
string

get: next_cursor from the read before, with the same calendar and range.

channels
object[]

create or update: channels to offer. A platform the app knows (Instagram, TikTok, YouTube, X, LinkedIn, Facebook, Threads, Pinterest, Twitch, Spotify) gets its own mark and color from the plain name. A name already on the calendar is skipped.

statuses
object[]

create or update: statuses to offer, in the order work moves through them. A new calendar already has Draft, In review, Approved and Published; pass this only to add to them.

update_channels
object[]

update: rename or recolor a channel. Every item carrying it keeps it.

update_statuses
object[]

update: rename or recolor a status.

delete_channels
string[]

update: remove these channels, and take them off every item carrying them. The items stay dated.

delete_statuses
string[]

update: remove these statuses, and clear them off every item carrying them.

order_on_day
object[]

update: the order of entries within one day, as a user sets by dragging; a day reads by time first, so this settles entries at the same time or with none. An entry on another day is skipped; moving a day 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[]