Skip to main content
POST
Create a campaign.

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
title
string
required
Required string length: 1 - 160
description
string
default:""
Maximum string length: 4000
connectedAccountIds
string[]
Maximum array length: 100
Required string length: 1 - 200
platforms
enum<string>[]
Maximum array length: 50
Available options:
tiktok,
instagram,
youtube,
x,
linkedin,
threads,
reddit,
mastodon,
facebook,
substack,
whatsapp,
telegram,
bluesky,
snapchat,
medium,
quora,
nextdoor,
rumble,
xiaohongshu,
pinterest,
tumblr,
discord,
vimeo,
devto,
hashnode,
google_business,
lemmy,
yelp,
yellowpages,
bing_places,
apple_business
automationMode
enum<string>
default:review-first
Available options:
manual,
review-first,
fire-and-forget
status
enum<string>
default:draft
Available options:
draft,
scheduled,
active,
paused,
completed
scheduledAt
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
remixJobIds
string[]
Maximum array length: 500
Required string length: 1 - 200
playbookId
string | null
Required string length: 1 - 200

Response

Success.

success
boolean
required
campaign
object
required
{key}
any