Skip to main content
POST
ads.catalog-ad.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string
required

Connected account from social.accounts.list.

Required string length: 1 - 256
adAccountId
string
required

Advertising account that owns the ad set.

Required string length: 1 - 256
adSetId
string
required

Existing ad set from ads.ad-sets.list; its goal, budget and targeting are inherited.

Required string length: 1 - 256
name
string
required

Name of the new paused ad.

Required string length: 1 - 255
productSetId
string
required

Product set available to the connected advertising account.

Required string length: 1 - 256
headline
string
required

Headline; catalog template tags are allowed.

Required string length: 1 - 255
body
string
required

Ad copy; catalog template tags are allowed.

Required string length: 1 - 5000

Public destination for the catalog ad.

catalogFormat
enum<string>
required

Layout of the catalog template.

Available options:
single_image,
carousel_images_multi_items,
carousel_images_single_item,
carousel_slideshows
dryRun
boolean
default:true

Check the ad set and inputs without creating. Set false to create one paused ad.

Response

The result

validated
boolean
required

Whether the platform accepted the ad. A preview is not sent, so it answers false.

created
boolean
required

Whether a paused ad was created.

ref
string

Reference to what this call created. Pass it as ref to future ad follow-ups.