AdButler

Bulk delete catalog ad items from a campaign

Cancel a signature request

Convert a native ad item to an image ad item

Create a new advertiser

Create a new audience in a user database

Create a new audio creative. The API uses multipart file upload.

Create a new beacon signing key

Create a new bidder

Create a new standard campaign

Create a new campaign assignment (assign an ad item to a campaign)

Create a new catalog ad item

Create a new catalog zone for product/retail ad serving

Create a new channel

Assign a zone to a channel

Create a new contact

Create a new contract

Create a new document for a contract

Create a contract document from a template

Create a new payment for a contract

Create a new contract template. Requires name, file, attributes (JSON string), email_subject, and email_body.

Create a new image creative. The API uses multipart file upload — pass the media group ID and file attributes.

Create a new custom HTML ad item

Create a new report configuration

Create a new data key for custom targeting

Create a new data key target (targeting rule)

Create a new data list

Create a new day parting rule for time-of-day targeting. Ranges is an object with day names as keys and arrays of time range strings (e.g. "09:00:00-17:00:00") as values.

Create a new demand endpoint

Create a new demand source

Create a new email zone for serving ads in email newsletters

Create a new event log upload configuration

Create a new geo target for geographic targeting. Areas is an array of objects with continent, country (2-letter code), region, city fields.

Create a new image ad item (banner)

Create a new list target (inclusion/exclusion using a data list)

Create a new manager

Create a new media group

Create a new native ad item using a native template

Create a new native ad template with HTML and variable placeholders

Create a new data asset for an ORTB native template

Create a new OpenRTB native template

Create a new placement (assign an ad item or campaign to a zone or channel)

Create a new platform target for device/OS/browser targeting

Create a new PMP deal

Create a new postal code target

Create a new product catalog for a publisher

Create a new item in a product catalog

Create a new product source for a publisher

Create a new product source target for a publisher

Create a new publisher

Create a new report schedule

Create a new rich media ad item

Create a new rich media creative. The API uses multipart file upload (ZIP for HTML5).

Create a new role with permission settings

Create a new schedule for time-based ad delivery. Schedules are automatically linked to ad items via placements.

Create a new SFTP connection

Create a new signature request for a contract

Create a new trusted redirect domain

Create a new user in a user database

Create a new user attribute in a user database

Create a new user database

Create a new VAST report configuration

Create a new video creative. The API uses multipart file upload.

Create a new standard zone. Set dimensions to "dynamic" for a dynamic zone (width/height must be 0), or "fixed" (default) for a fixed-size zone.

Delete an advertiser

Permanently delete an archived standard campaign

Permanently delete an archived channel

Permanently delete an archived contract

Delete an audience from a user database

Delete an audio creative

Delete a beacon signing key

Delete a bidder

Delete a standard campaign

Delete a campaign assignment

Delete a catalog ad item

Delete a catalog zone

Delete a channel

Remove a zone from a channel

Delete a contact

Delete a contract

Delete a contract document

Delete a contract payment

Delete a contract template

Delete an image creative

Delete a custom HTML ad item

Delete a report configuration

Delete a data key

Delete a data key target

Delete a data list

Delete a day parting rule

Delete a demand endpoint

Delete a demand source

Delete an email zone

Delete an event log upload configuration

Delete a geo target

Delete an image ad item

Delete a list target

Delete a manager

Delete a media group

Delete a native ad item

Delete a native template

Delete a data asset from an ORTB native template

Delete an OpenRTB native template

Delete a placement (remove an ad item from a zone)

Delete a platform target

Delete a PMP deal

Delete a postal code target

Delete a product source

Delete a product source target

Delete a publisher

Delete a report schedule

Delete a rich media ad item

Delete a rich media creative

Delete a role

Delete a schedule

Delete an SFTP connection

Delete a signature request

Delete a recipient from a signature request

Delete a trusted redirect domain

Delete a user attribute from a user database

Delete a video creative

Delete a standard zone

Download a file revision for a contract document

Create a new draft standard campaign. Fields go inside a "draft" object wrapper.

Create a new draft campaign assignment

Create a new draft catalog ad item

Create a new draft custom HTML ad item

Create a new draft image ad item

Create a new draft native ad item

Create a new draft placement

Create a new draft rich media ad item

Create a new draft schedule

Delete a draft standard campaign

Delete a draft campaign assignment

Delete a draft catalog ad item

Delete a draft custom HTML ad item

Delete a draft image ad item

Delete a draft native ad item

Delete a draft placement

Delete a draft rich media ad item

Delete a draft schedule

Get a draft ad item of any type by ID

Get details of a specific draft standard campaign

Get details of a specific draft campaign assignment

Get details of a specific draft catalog ad item

Get details of a specific draft custom HTML ad item

Get details of a specific draft image ad item

Get details of a specific draft native ad item

Get details of a specific draft placement

Get details of a specific draft rich media ad item

Get details of a specific draft schedule

List all draft ad items across all types

List all draft campaign assignments

List all draft standard campaigns

List all draft catalog ad items

List all draft custom HTML ad items

List all draft image ad items

List all draft native ad items

List all draft placements

List all draft rich media ad items

List all draft schedules

Save/publish a draft campaign (converts draft to live campaign)

Update an existing draft standard campaign

Update an existing draft campaign assignment

Update an existing draft catalog ad item

Update an existing draft custom HTML ad item

Update an existing draft image ad item

Update an existing draft native ad item

Update an existing draft placement

Update an existing draft rich media ad item

Update an existing draft schedule

Generate ad serving tags for multiple zones at once

Retrieve an ad via GET request. Same parameters as serve_ad but uses GET instead of POST.

Get details of a specific advertiser by ID

Get details of a specific archived advertiser

Get details of a specific archived standard campaign

Get details of a specific archived channel

Get details of a specific archived contract

Get details of a specific archived email zone

Get details of a specific archived publisher

Get details of a specific archived standard zone

Get auction placement statistics report

Get details of a specific audience in a user database

Get details of a specific audio creative

Get details of a specific beacon signing key by ID

Get details of a specific bidder by ID

Get details of a specific standard campaign

Get details of a specific campaign assignment

Get conversion tag for a campaign

Get eligible zones for a campaign

Get details of a specific catalog ad item

Get details of a specific catalog zone

Get the ad serving tag for a catalog zone

Get details of a specific channel

Get details of a specific channel zone assignment

Get click details report

Get details of a specific contact by ID

List report schedules for a contact

Get details of a specific contract

Get the active signature request for a contract

Get campaigns assigned to a contract

Get details of a specific contract document

Get a specific file revision for a contract document

Get details of a specific contract payment

Get details of a specific contract template

Get conversion details report

Get details of a specific image creative

Get details of a specific custom HTML ad item

Get conversion tracking tag for a custom HTML ad item

Get details of a specific report configuration

Get details of a specific data key

Get details of a specific data key target

Get details of a specific data list by ID

Get details of a specific day parting rule

Get details of a specific demand endpoint by ID

Get details of a specific demand source by ID

Get demand source statistics report

Get display channel forecast report

Get display forecast report

Get display platform estimate statistics

Get display advertising report with impressions, clicks, and CTR

Get details of a specific email zone

Get the conversion tracking tag for an email zone

Get the ad serving tag for an email zone

Get details of a specific event log upload configuration

Get details of a specific event log upload log entry

Get event logs for account activity (changes, logins, etc.)

Get geographic summary report

Get details of a specific geo target

Get details of a specific image ad item

Get conversion tracking tag for an image ad item

Get details of a specific list target

Get live website preview URL

Get details of a specific manager by ID

Generate manual tracking links for an ad item

Get details of a specific media group

Get details of a specific native ad item

Get conversion tracking tag for a native ad item

Get details of a specific native template

Get details of a specific data asset for an ORTB native template

Get details of a specific OpenRTB native template by ID

Get details of a specific placement

Get conversion tracking tag for a placement

Get placement forecast report

Get details of a specific platform target

Get details of a specific PMP deal by ID

Get details of a specific postal code target

Get details of a specific product catalog

Get details of a specific product catalog item

Get details of a specific product source

Get details of a specific product source target

Get details of a specific publisher

Get a specific generated report

Get a specific report schedule

Get a specific generated report from a schedule

Get details of a specific rich media ad item

Get conversion tracking tag for a rich media ad item

Get details of a specific rich media creative

Get details of a specific role by ID

Get details of a specific schedule

Get details of a specific SFTP connection by ID

Get details of a specific signature request

Get a specific recipient for a signature request

Get details of a specific trusted redirect domain by ID

Get a single user from a user database

Get details of a specific user attribute in a user database

Get details of a specific user database by ID

Get conversion tracking tag for a VAST ad item

Get VAST auction placements report

Get conversion tracking tag for a VAST campaign

Get VAST channel forecast report

Get a specific VAST report

Get VAST forecast report

Get VAST geographic summary report

Get conversion tracking tag for a VAST placement

Get VAST platform estimate statistics

Get VAST video advertising report

Get VAST zone conversion tracking tag

Get VAST zone serving tags

Get details of a specific video creative

Get details of a specific standard zone

Get the conversion tracking tag for a standard zone

Get the ad serving tag (embed code) for a zone

List all ad items (banners) across all types (image, custom HTML, rich media, native, catalog)

List all advertisers in your AdButler account

List all campaigns across all types

List all creatives across all types (image, rich media, video, audio)

List all generated reports across all configurations

List all report schedules across all configurations

List all zones across all types (standard, email, catalog)

List all archived advertisers

List all archived standard campaigns

List all archived channels

List all archived contracts

List all archived email zones

List all archived publishers

List all archived standard zones

List all audiences in a user database

List all audio creatives

List all beacon signing keys in your AdButler account

List all bidders in your AdButler account

List all campaign assignments (ad items assigned to campaigns)

List all standard campaigns

List all catalog ad items

List all catalog zones (for product/retail ad serving)

List all channel zone assignments

List all channels

List all contacts in your AdButler account

List file revisions for a contract document

List all documents for a contract

List all payments for a contract

List all contract templates

List all contracts

List all image creatives

List all custom HTML ad items

List all saved report configurations

List all data key targets (targeting rules using data key values)

List all data keys (custom key-value targeting variables)

List all data lists in your AdButler account

List all data targets

List all day parting rules (time-of-day targeting)

List all demand endpoints in your AdButler account

List all demand sources in your AdButler account

List all email zones

List all event log upload configurations

List all event log upload logs

List all geo targets (geographic targeting rules)

List all image ad items

List all list targets (allowlist/blocklist targeting)

List all managers in your AdButler account

List all media groups (collections of creatives)

List all native ad items

List all native ad templates

List all data assets for an ORTB native template

List all OpenRTB native templates in your AdButler account

List all placements (assignments of ad items to zones)

List all platform targets (device/OS/browser targeting)

List all PMP deals in your AdButler account

List all postal code targets

List all product catalogs for a publisher

List all product source targets for a publisher

List all product sources for a publisher

List all publishers in your AdButler account

List generated reports for a specific report configuration

List generated reports for a specific schedule

List schedules for a specific report configuration

List all rich media ad items

List all rich media creatives

List all roles in your AdButler account

List all schedules (time-based delivery rules for ad items)

List all SFTP connections in your AdButler account

List all recipients for a signature request

List all signature requests for a contract

List all trusted redirect domains in your AdButler account

List all user attributes in a user database

List all user databases in your AdButler account

List all VAST report data

List all video creatives

List all standard zones

Remove all usages of a list target

Remove values from a list attribute for a user

Replace the file on an audio creative

Replace the file on a contract document

Replace a contract document file from a template

Replace the file on an image creative

Replace the file on a rich media creative

Replace the file on a video creative

Resend a signature request

Revoke historical access for a report schedule

Search for items in a product catalog

Request ad delivery for a zone. Returns the ad(s) that would be served, useful for verifying ad setup. Uses POST /adserve.

Test an SFTP connection with the provided credentials

Restore an archived advertiser back to active status

Restore an archived standard campaign back to active status

Restore an archived channel back to active status

Unarchive a contract (restore from archive)

Restore an archived email zone back to active status

Restore an archived publisher back to active status

Restore an archived standard zone back to active status

Update an existing advertiser

Update an existing audience in a user database

Update an existing audio creative

Update an existing beacon signing key

Update an existing bidder

Update an existing standard campaign

Update an existing campaign assignment

Update an existing catalog ad item

Update an existing catalog zone

Update an existing channel

Update an existing contact

Update an existing contract

Update an existing contract document

Update an existing contract template

Update an existing image creative

Update an existing custom HTML ad item

Update an existing report configuration

Update an existing data key

Update an existing data key target

Update an existing data list

Update an existing day parting rule

Update an existing demand endpoint

Update an existing demand source

Update an existing email zone

Update an existing event log upload configuration

Update an existing geo target

Update an existing image ad item

Update an existing list target

Update an existing manager

Update an existing media group

Update an existing native ad item

Update an existing native template. Variables uses add/remove format for updates.

Update an existing data asset for an ORTB native template

Update an existing OpenRTB native template

Update an existing placement

Update an existing platform target

Update an existing PMP deal

Update an existing postal code target

Update an existing product catalog

Update an existing product catalog item

Update an existing product source

Update an existing product source target

Update an existing publisher

Update a report schedule

Update an existing rich media ad item

Update an existing rich media creative

Update an existing role

Update an existing schedule

Update an existing SFTP connection

Update an existing signature request

Update a recipient for a signature request

Update an existing trusted redirect domain

Update an existing user attribute in a user database

Update an existing video creative

Update an existing standard zone

Validate a beacon signing key

Archive a VAST campaign (soft-delete, can be restored later)

Archive a VAST channel (soft-delete, can be restored later)

Archive a VAST zone (soft-delete, can be restored later)

Create a new VAST ad item

Create a new VAST campaign

Create a VAST campaign assignment (assign an ad item to a campaign)

Create a new VAST channel

Assign a VAST zone to a VAST channel

Create a new VAST companion

Create a new VAST linear media

Create a new VAST non-linear media

Create a new VAST placement (assign a VAST ad item or campaign to a VAST zone or channel)

Create a new VAST schedule for time-based ad delivery

Create a new VAST tracking entry

Create a new VAST zone

Delete a VAST ad item

Permanently delete an archived VAST campaign

Permanently delete an archived VAST channel

Permanently delete an archived VAST zone

Delete a VAST campaign

Delete a VAST campaign assignment

Delete a VAST channel

Remove a VAST zone from a VAST channel

Delete a VAST companion

Delete a VAST linear media

Delete a VAST non-linear media

Delete a VAST placement

Delete a VAST schedule

Delete a VAST tracking entry

Delete a VAST zone

Get details of a specific VAST ad item

Get details of a specific archived VAST campaign

Get details of a specific archived VAST channel

Get details of a specific archived VAST zone

Get details of a specific VAST campaign

Get details of a specific VAST campaign assignment

Get details of a specific VAST channel

Get details of a specific VAST channel zone assignment

Get details of a specific VAST companion

Get details of a specific VAST linear media

Get details of a specific VAST non-linear media

Get details of a specific VAST placement

Get details of a specific VAST schedule

Get details of a specific VAST tracking entry

Get details of a specific VAST zone

List all VAST ad items

List all archived VAST campaigns

List all archived VAST channels

List all archived VAST zones

List all VAST campaign assignments

List all VAST campaigns

List all VAST channel zone assignments

List all VAST channels

List all VAST companions

List all VAST linear media

List all VAST media (linear and non-linear)

List all VAST non-linear media

List all VAST placements (assignments of VAST ad items to VAST zones)

List all VAST schedules

List all VAST tracking entries

List all VAST zones

Restore an archived VAST campaign back to active status

Restore an archived VAST channel back to active status

Restore an archived VAST zone back to active status

Update an existing VAST ad item

Update an existing VAST campaign

Update a VAST campaign assignment

Update an existing VAST channel

Update a VAST channel zone assignment

Update an existing VAST companion

Update an existing VAST linear media

Update an existing VAST non-linear media

Update an existing VAST placement

Update an existing VAST schedule

Update an existing VAST tracking entry

Update an existing VAST zone

Create a VAST 4.2 ad item

Create a VAST 4.2 campaign assignment

Create a VAST 4.2 closed caption file

Create a VAST 4.2 companion

Create a VAST 4.2 creative

Create a VAST 4.2 icon

Create a VAST 4.2 icon click fallback image

Create a VAST 4.2 interactive creative file

Create a VAST 4.2 linear media

Create a VAST 4.2 media file

Create a VAST 4.2 mezzanine

Create a VAST 4.2 non-linear media

Create a VAST 4.2 placement

Create a VAST 4.2 resource

Create a VAST 4.2 universal ad ID

Delete a VAST 4.2 ad item

Delete a VAST 4.2 campaign assignment

Delete a VAST 4.2 closed caption file

Delete a VAST 4.2 companion

Delete a VAST 4.2 creative

Delete a VAST 4.2 icon

Delete a VAST 4.2 icon click fallback image

Delete a VAST 4.2 interactive creative file

Delete a VAST 4.2 linear media

Delete a VAST 4.2 media file

Delete a VAST 4.2 mezzanine

Delete a VAST 4.2 non-linear media

Delete a VAST 4.2 placement

Delete a VAST 4.2 resource

Delete a VAST 4.2 universal ad ID

Get a single VAST 4.2 ad item

Get a single VAST 4.2 campaign assignment

Get a single VAST 4.2 closed caption file

Get a single VAST 4.2 companion

Get a single VAST 4.2 creative

Get a single VAST 4.2 icon

Get a single VAST 4.2 icon click fallback image

Get a single VAST 4.2 interactive creative file

Get a single VAST 4.2 linear media

Get a single VAST 4.2 media file

Get a single VAST 4.2 mezzanine

Get a single VAST 4.2 non-linear media

Get a single VAST 4.2 placement

Get a single VAST 4.2 resource

Get a single VAST 4.2 universal ad ID

List all VAST 4.2 ad items

List all VAST 4.2 campaign assignments

List all VAST 4.2 closed caption files

List all VAST 4.2 companions

List all VAST 4.2 creatives

List all VAST 4.2 icon click fallback images

List all VAST 4.2 icons

List all VAST 4.2 interactive creative files

List all VAST 4.2 linear media

List all VAST 4.2 media files

List all VAST 4.2 mezzanines

List all VAST 4.2 non-linear media

List all VAST 4.2 placements

List all VAST 4.2 resources

List all VAST 4.2 universal ad IDs

Update a VAST 4.2 ad item

Update a VAST 4.2 campaign assignment

Update a VAST 4.2 closed caption file

Update a VAST 4.2 companion

Update a VAST 4.2 creative

Update a VAST 4.2 icon

Update a VAST 4.2 icon click fallback image

Update a VAST 4.2 interactive creative file

Update a VAST 4.2 linear media

Update a VAST 4.2 media file

Update a VAST 4.2 mezzanine

Update a VAST 4.2 non-linear media

Update a VAST 4.2 placement

Update a VAST 4.2 resource

Update a VAST 4.2 universal ad ID