creative

put

https://buzz-key.api.beeswax.com/rest/creative

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

creative_id

int32

required

Unique ID of the Creative

advertiser_id

int32

Must belong to the same account as the Advertiser and be active

creative_name

string

Name of the Creative, e.g. "Blue Banner Ad"

width

int32

Width in pixels. Use the creative_sizes view to see all acceptable width and height combinations.

height

int32

Height in pixels. Use the creative_sizes view to see all acceptable width and height combinations.

sizeless

boolean

Defaults to false

Is the creative sizeless, meaning it can match any size placement that is an interstitial.

secure

boolean

Defaults to false

Is the creative intended to serve in a secure (HTTPS) environment.

click_url

string

Defaults to 0

URL the ad should click or tap to, must be a valid URL. This field is required when using a Creative Template that is not a tag (e.g. an image or video)

creative_assets

array of int32s

DEPRECATED, use primary_asset and secondary_asset fields instead.

creative_assets

primary_asset

int32

ID of the creative_asset to use in the Creative, for example the ID of an Image or Video.

secondary_asset

int32

ID of a secondary creative_asset to use in the Creative. Most commonly used for the companion asset within a Video Creative.

native_offer

int32

For Native creatives, the NativeOffer to be used for the Creative content

creative_content_tag

string

For tag creatives the tag can be placed in this field and on save the creative_rule_key will be applied to insert relevant macros. This is recommended vs completing the creative_content field directly.

creative_template_id

int32

The ID of the Creative Template to use for this creative. Must be a valid and active Creative Template that either belongs to this Account, OR is marked as "global".

creative_rule_id

int32

DEPRECATED

creative_rule_key

string

Defaults to none

Thy key corresponding to the creative_rule to apply to the creative_content_tag field. The rule will insert click and timestamp macros. You can use auto_detect for easiest implementation.

attributes

object

Creative Attributes JSON.

pixels

array of strings

List of URLs to be added to the Creative as pixels

pixels

scripts

array of strings

List of URLs to be added to the Creative as scripts

scripts

events

object

List of video event objects

progess_events

object

List of objects to track VAST video progress

creative_addons

array of int32s

List of CreativeAddOn IDs to add to the Creativ

creative_addons

creative_thumbnail_url

string

URL to an image thumbnail for the creative. This field will be automatically set if you associate the creative with a Creative Asset that has a valid thumbnail but must be updated manually when using a tag-based Creative. Thumbnail is required by some exchanges to serve.

start_date

date

Start date of the creative, optional

end_date

date

End date of the creative, optional

alternative_id

string

An alternative id to lookup the creative, if desired

notes

string

Notes about the Creative, up to 255 chars

active

boolean

Defaults to false

Is the Creative active?

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200