Skip to main content
POST
Prepare a launch on the AdStellar Launch page for a person to review, edit and launch there. Puts images and videos from Assets (sizes of the same creative become one ad), optionally existing Meta ad sets of the ad account and shared copy, into a new launch and returns its URL plus what is still missing before it can launch. Does NOT launch anything: nothing is written to Meta and nothing is spent, and the ads start paused. It cannot create campaigns or ad sets (use build_campaign to build a new campaign). Requires an active subscription and the Launch page enabled for the team.

Authorizations

Authorization
string
header
required

AdStellar API key (ast_live_...)

Body

application/json
adAccountId
string
required

Meta ad account id (from list_ad_accounts). Must be connected to the workspace.

Pattern: ^(act_)?\d{1,32}$
assetIds
string[]
required

Media asset ids (uuids) of the images and videos to launch, 1 to 200. Sizes of the same creative become ONE ad (up to 3 sizes).

Required array length: 1 - 200 elements
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
name
string

A name for the launch, as the user would recognise it in their list of launches.

Required string length: 1 - 200
adSetIds
string[]

Meta ids of EXISTING ad sets of this ad account that every ad goes into (up to 20). All website ad sets or all instant form ad sets, never a mix. Leave out to let the user choose on the Launch page.

Maximum array length: 20
Pattern: ^\d{8,32}$
primaryTexts
string[]

Primary text shared by every ad: the first is the main one, the rest are variations (up to 5).

Required array length: 1 - 5 elements
Maximum string length: 2000
headlines
string[]

Headline shared by every ad: the first is the main one, the rest are variations (up to 5).

Required array length: 1 - 5 elements
Maximum string length: 255
description
string

Description shared by every ad.

Maximum string length: 255
cta
string

Meta call to action type, e.g. SHOP_NOW, LEARN_MORE, SIGN_UP.

The web page the ads send people to (http or https). Not used by instant form ads.

Maximum string length: 2048
urlTags
string

URL parameters added to the link, e.g. utm_source=meta&utm_campaign=spring (no leading "?").

Maximum string length: 2000

The short link shown on the ad, e.g. example.com.

Maximum string length: 255
pageId
string

Facebook Page the ads run as.

Pattern: ^\d{1,32}$
instagramAccountId
string

Instagram account the ads run as.

Pattern: ^\d{1,32}$
leadFormId
string

Meta instant form the ads open. Only when adSetIds are instant form ad sets.

Pattern: ^\d{1,32}$
workspaceId
string<uuid>

Workspace to act in (must be granted to this credential). Omit for the primary workspace.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Tool result