The API reference moved here from eksis.io/developers.

Publishing

Schedule and publish posts on your customers' channels, and learn the result without polling.

Publishing for a customer works the same as publishing for yourself: the post names the customer's channel in targets. The Quick start walks through every request with full bodies. This page covers what changes when the channels belong to many customers.

Scheduling and publishing need a key with the editor role. A contributor key can create posts, but they wait for approval (pending_approval) until someone approves them.

The flow

Bring in the media

Import a file that already has a public address with POST /v1/media/imports, or upload one with POST /v1/media/uploads followed by POST /v1/media/{mediaId}/complete. Each gives you a media id. See Import media from a URL and Start an upload.

Check the post first

Send the body to Validate a post. It runs the same platform checks as creating the post, without saving anything, so your interface can show the customer what to fix before they press publish.

Create it

POST /v1/posts with targets holding one entry per channel. Each target can override caption and mediaIds, and platform options go in targets[].settings. mode decides when it goes out:

modeResult
draftSaved, not published. The default.
scheduleGoes out at scheduledAt, an ISO 8601 time with an offset or Z.
queueTakes the next free slot of the channel's queue.
nowGoes out right away.

Reference: Create a post.

Learn the result

Publishing happens in the background. Subscribe to post.target.published and post.target.failed: each event names the post, the target, and its channelId, and a published target carries its permalink. Or read Read one post after the scheduled time.

After the post exists

EndpointUse
Publish nowSends every target that has not gone out yet, and returns right away.
Reschedule a postA new scheduledAt, or mode: "queue".
Retry failed channelsQueues the targets that failed, all of them or the channelIds you pick.
List postsFilter by status, channels, a search q, and a date range. Pass one customer's channel ids in channels to list only their posts.
Read the calendarPosts and free queue slots in a date range.
List queue slotsThe weekly times mode: "queue" fills.

Rules of each network

What a network accepts (post types, media, caption length, required settings) is in the platform specifications and in Platform capabilities. A post that breaks a rule is refused with 422, and error.details.validations lists each failed check.

On Pro Eksis and Super Eksis, eksis adds no daily cap of its own: only the network's limit applies. A post over that limit waits and goes out when there is room, instead of failing. See Publishing limits.

On this page