Skip to main content
POST
Create a planned post
A manual post (kind: "manual") publishes the app’s own media URLs and needs only WRITE_SOCIAL. An AI post (kind: "ai", the default) generates images from prompt with the store’s AI credits and also needs USE_MERCHANT_AI. Set requiresPromptApproval: true to save a prompt-only draft that generates nothing until approved.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side, so never send a shop id.

Body

application/json
platforms
enum<string>[]
required
Minimum array length: 1
Available options:
instagram,
tiktok,
linkedin
scheduledAt
string<date-time>
required
kind
enum<string>
default:ai

Defaults to ai. An AI post needs USE_MERCHANT_AI unless requiresPromptApproval is true; a manual post needs media.

Available options:
ai,
manual
title
string
Maximum string length: 120
prompt
string

Required for an AI post.

Required string length: 3 - 2500
caption
string
Maximum string length: 2200
captions
object
formats
string[]

Placements. Derived from platforms when omitted.

media
object[]

Manual posts only. The app's own hosted files.

Maximum array length: 35
slides
object[]
references
object[]
Maximum array length: 4
colors
string[]
generateAheadHours
integer
default:24
Required range: 0 <= x <= 168
mode
enum<string>

Manual posts default to auto; AI posts default to approval.

Available options:
auto,
approval
premium
boolean
default:false
requiresPromptApproval
boolean
default:false

Create a prompt-only draft. It generates nothing until approve-prompt is called, so it needs no AI grant.

taggedAccounts
object[]
collaborators
string[]
Maximum array length: 3

Response

The created post.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required
success
boolean
required
message
string
required
data
object

A planned post. kind: "ai" generates its images from prompt; kind: "manual" publishes the files in media.