REST API

The ZuperPost API,
version 1.

Schedule posts, manage the content library, and run your brands from your own scripts. Version 1 uses the same behavior as the app.

Base URL

Every call below is relative to:

https://api.zuperpost.com/api/v1/

The unversioned https://api.zuperpost.com/api/ paths keep working. New integrations should use /api/v1/. A future version will get its own prefix. This version will not change the meaning of these paths.

Authentication

Create a key at app.zuperpost.com/api-key. The key belongs to your user. Send it on every call except reading a public invitation link.

Authorization: Bearer YOUR_API_KEY Accept: application/json Content-Type: application/json

For a specific brand, add brand_id as a query or JSON field, or send X-Brand-Id. You only receive brands, posts, channels, and teammates your account is allowed to see. Owners, approvers, and members do not all have the same actions.

Generating a new key replaces the previous one.

A request

cURL

curl "https://api.zuperpost.com/api/v1/scheduled_posts?brand_id=1" \ -H "Accept: application/json" \ -H "Authorization: Bearer YOUR_API_KEY"

JavaScript

const response = await fetch("https://api.zuperpost.com/api/v1/contents/create", { method: "POST", headers: { Accept: "application/json", "Content-Type": "application/json", Authorization: "Bearer YOUR_API_KEY", "X-Brand-Id": "1" }, body: JSON.stringify({ content: "Hello from the API", title: "Launch" }) }); const body = await response.json();

PHP

$ch = curl_init("https://api.zuperpost.com/api/v1/brands"); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Accept: application/json", "Authorization: Bearer YOUR_API_KEY", ], ]); $body = json_decode(curl_exec($ch), true); $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

Lists, search, and pages

List endpoints that return a library use Laravel’s paginator. Pass page. The body includes data, current_page, last_page, per_page, and total.

Content library filters, all optional:

  • q matches title or text. GET contents/search/{keyword} is the keyword path.
  • category is a category id, or none.
  • platform is a platform id from 1 to 10.
  • sort is newest, oldest, updated, or title.

Calendar lists accept status: scheduled, cancelled, published, failed, publishing, or partially_failed.

Errors

Failed calls return JSON. Validation errors look like {"message":"...","errors":{"field":["..."]}}. Other failures use {"message":"..."}.

StatusMeaning
200The call succeeded. Some actions return 201 when a record is created.
401Missing or invalid API key. Body message is Unauthenticated.
403The key is valid, and this account cannot do that to this brand.
404That record does not exist, or it belongs to a brand you cannot access.
422A field is missing or invalid. Read errors.
429Too many requests. The API allows 60 requests a minute per user.

Uploads

Media, video thumbnails, and brand logos are multipart, not JSON. The file field names are media, thumbnail, and logo.

curl https://api.zuperpost.com/api/v1/contents/42/media \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "[email protected]"

Content library

CallWhat it does
GET contents/readList posts. Filters: q, category, platform, sort, page, brand_id.
GET contents/read/{id}Read one post, including media.
GET contents/search/{keyword}Search posts.
POST contents/createCreate a post. JSON: content (required), title, platform, category_id, media_url, brand_id.
PUT contents/update/{id}Update a post. content is required.
DELETE contents/delete/{id}Delete a post.
POST contents/bulkMove or delete several posts. JSON: action, ids, optional category_id.
POST contents/importImport rows. JSON: rows, optional dry_run.
GET content-categoriesList categories.
POST content-categoriesCreate a category. JSON: name, optional color.
PUT content-categories/{id}Rename a category.
DELETE content-categories/{id}Delete a category.

Create a post

curl https://api.zuperpost.com/api/v1/contents/create \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d "{\"content\":\"Shipping Friday.\",\"title\":\"Friday\",\"brand_id\":1}"

A successful body contains content with the new id. A missing content field returns 422.

Content media

CallWhat it does
GET contents/{id}/mediaList images and video.
POST contents/{id}/mediaUpload media. Multipart field media.
PUT contents/{id}/media/reorderReorder. JSON: order, an array of media ids.
DELETE contents/{id}/media/{mediaId}Remove one file.
POST contents/{id}/media/{mediaId}/thumbnailSet a video thumbnail. Multipart field thumbnail.
DELETE contents/{id}/media/{mediaId}/thumbnailRemove that thumbnail.

Schedule a post

CallWhat it does
GET scheduled_postsList calendar items. Optional brand_id and status.
GET scheduled_posts/read/{id}Read one.
POST scheduled_posts/createSchedule a post. JSON: content_id, scheduled_at, timezone, and channel_ids or platforms.
PUT scheduled_posts/update/{id}Change time, copy link, or channels.
POST scheduled_posts/cancel/{id}Cancel it so it is not sent.
DELETE scheduled_posts/delete/{id}Delete it.

Schedule example

{ "content_id": 42, "scheduled_at": "2026-12-01 09:30", "timezone": "Asia/Singapore", "channel_ids": [3, 4], "brand_id": 1 }

scheduled_at is the local time in timezone, and it has to be in the future. The response body contains scheduled_post.

Recurring schedules

CallWhat it does
GET recurring_schedulesList patterns.
GET recurring_schedules/read/{id}Read one.
POST recurring_schedules/createCreate a pattern. JSON: content_id, frequency (daily, weekly, or monthly), start_date (YYYY-MM-DD), start_time (HH:MM), timezone, channel_ids.
PUT recurring_schedules/update/{id}Update it.
POST recurring_schedules/{id}/pausePause.
POST recurring_schedules/{id}/resumeResume.
POST recurring_schedules/{id}/cancelCancel.
DELETE recurring_schedules/delete/{id}Delete.

Channels

Webhook channels can be created here. Facebook, Instagram, Threads, X, and LinkedIn sign-in stays in the browser. After Facebook is connected, these calls list, save, and disconnect Pages. Channel responses never include tokens.

CallWhat it does
GET channelsList channels.
GET channels/typesList channel types.
GET channels/{id}Read one.
POST channelsAdd a webhook channel. JSON: type, name, optional webhook_url.
PUT channels/{id}Update it.
DELETE channels/{id}Remove it.
POST channels/{id}/testSend a test.
GET integrations/facebook/pagesList Facebook Pages to connect.
POST integrations/facebook/pagesSave the chosen Pages. JSON: page_ids.
DELETE integrations/facebook/pages/{id}Disconnect a Page.

Brands

CallWhat it does
GET brandsList brands this account can post as.
POST brandsCreate a brand. JSON: name (required, max 100 characters), optional workspace_id.
GET brands/{id}Read one.
PUT brands/{id}Update it. JSON may include name and require_approval.
DELETE brands/{id}Delete it. Send confirm=1.
POST brands/{id}/logoUpload a logo. Multipart field logo.
DELETE brands/{id}/logoRemove the logo.

Team

CallWhat it does
GET brands/{id}/teamList members and pending invites.
POST brands/{id}/invitationsInvite by email. JSON: email, role (owner, approver, or member).
POST brands/{id}/invitations/{invitationId}/resendResend.
DELETE brands/{id}/invitations/{invitationId}Revoke.
PUT brands/{id}/members/{userId}Change a role. JSON: role.
DELETE brands/{id}/members/{userId}Remove a member.
GET invitations/{token}Read an invite link. No API key.
POST invitations/{token}/acceptAccept it. Requires the invited user’s key.

Approvals

CallWhat it does
GET approvalsList posts waiting for review. Optional brand_id.
POST posts/{id}/approveApprove. Optional brand_id.
POST posts/{id}/request-changesSend it back. JSON: note.

Send a post back

curl https://api.zuperpost.com/api/v1/posts/42/request-changes \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d "{\"note\":\"Please add the product photo.\",\"brand_id\":1}"

Integration notes

  • Store the key on your server. Do not put it in a public web page.
  • Send brand_id whenever a script acts for one brand. Do not assume a default brand in a multi-brand account.
  • Treat 401 as “get a new key”, 403 as “this user cannot do that”, and 422 as “fix the body and retry”.
  • Idempotent reads are safe to retry. Creating a post or a schedule twice creates two records.
  • The same resources are available as MCP tools at zuperpost.com/mcp.

Start with a key

Generate it in the app, then call /api/v1/.