Skip to main content
POST
Promote advertiser creatives into the library shelf

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

advertiserId
string
required

Advertiser ID

Minimum string length: 1

Body

application/json

Promote advertiser creatives into the library ("the shelf") with a role. Identify the creatives by creative_ids or by collection_id.

role
enum<string>
required

Library role to assign: evergreen (serve-ready) or reference (generation input).

Available options:
evergreen,
reference
creative_ids
string[]

Creative manifest IDs to promote into the advertiser library. Provide this or collection_id.

Minimum string length: 1
collection_id
string

A saved collection (e.g. the one grouped at creative-intent time) whose creative members are all promoted. Provide this or creative_ids — collection_id scales to any number of creatives.

Minimum string length: 1

Response

Promote advertiser creatives into the library shelf

Result of promoting creatives into the advertiser library.

role
enum<string>
required

Advertiser creative-library role: evergreen (serve-ready, reusable across campaigns) or reference (a generation input, not served). Absent for flight-specific creatives.

Available options:
evergreen,
reference
updated
string[]
required

Creative manifest IDs whose role was set.

manifests
object[]
required

The advertiser library after the save (promoted creatives only), so the result can render the shelf.

total
integer
required

Total promoted creatives in the advertiser library.

Required range: 0 <= x <= 9007199254740991