AdButler

List all advertisers in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific advertiser by ID

• idnumberrequiredAdvertiser ID

Create a new advertiser

• namestringrequiredAdvertiser name
• emailstringContact email
• can_change_passwordbooleanWhether advertiser can change password
• can_add_ad_itemsbooleanWhether advertiser can submit advertisements for scheduling
• metadataobjectCustom metadata key-value pairs
• passwordstringPassword for advertiser portal (min 8 chars, must include upper, lower, number)

Update an existing advertiser

• idnumberrequiredAdvertiser ID
• namestringAdvertiser name
• emailstringContact email
• can_change_passwordbooleanWhether advertiser can change password
• can_add_ad_itemsbooleanWhether advertiser can submit advertisements for scheduling
• metadataobjectCustom metadata key-value pairs
• passwordstringPassword for advertiser portal (min 8 chars, must include upper, lower, number)

Delete an advertiser

• idnumberrequiredAdvertiser ID

Archive an advertiser (soft-delete, can be restored later)

• idnumberrequiredAdvertiser ID

List all archived advertisers

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived advertiser

• idnumberrequiredArchived advertiser ID

Restore an archived advertiser back to active status

• idnumberrequiredArchived advertiser ID

List all campaigns across all types

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

List all standard campaigns

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific standard campaign

• idnumberrequiredCampaign ID

Create a new standard campaign

• namestringrequiredCampaign name
• advertisernumberAdvertiser ID
• contractnumberContract ID (requires Contract Management add-on)
• roadblock_tagsstringTag to link campaign to a roadblock
• targeting_sourcestringWhether targeting is set at campaign or ad item level
• scheduling_sourcestringWhether scheduling is set at campaign or ad item level
• metadataobjectCustom metadata key-value pairs
• budgetobjectBudget limits (daily/weekly/monthly/lifetime)
• trusted_redirect_domainsarrayArray of trusted redirect domains

Update an existing standard campaign

• idnumberrequiredCampaign ID
• namestringCampaign name
• advertisernumberAdvertiser ID
• contractnumberContract ID
• roadblock_tagsstringRoadblock tag
• targeting_sourcestringTargeting level
• scheduling_sourcestringScheduling level
• metadataobjectCustom metadata key-value pairs
• budgetobjectBudget limits
• trusted_redirect_domainsarrayTrusted redirect domains

Delete a standard campaign

• idnumberrequiredCampaign ID

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

• idnumberrequiredCampaign ID

List all archived standard campaigns

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived standard campaign

• idnumberrequiredArchived campaign ID

Permanently delete an archived standard campaign

• idnumberrequiredArchived campaign ID

Restore an archived standard campaign back to active status

• idnumberrequiredArchived campaign ID

Get conversion tag for a campaign

• idnumberrequiredCampaign ID

Get eligible zones for a campaign

• idnumberrequiredCampaign ID

Bulk create catalog ad items in a campaign

• campaign_idnumberrequiredCampaign ID
• itemsarrayrequiredArray of catalog ad item objects to create

Bulk delete catalog ad items from a campaign

• campaign_idnumberrequiredCampaign ID
• itemsarrayrequiredArray of catalog ad item IDs to delete

List all campaign assignments (ad items assigned to campaigns)

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific campaign assignment

• idnumberrequiredCampaign assignment ID

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

• advertisementobjectrequiredAdvertisement object with id and type
• campaignobjectrequiredCampaign object with id and type
• activebooleanWhether assignment is active (defaults to true)
• weightnumberRelative delivery weight (defaults to 1)
• schedulenumberSchedule ID (only if campaign scheduling_source is "AD_ITEM")
• geo_targetnumberGeo Target ID (only if campaign targeting_source is "AD_ITEM")
• platform_targetnumberPlatform Target ID
• keywordsstringComma-separated keywords for targeting
• keywords_match_methodstringKeyword matching method
• data_key_targetnumberData Key Target ID
• list_targetnumberList Target ID

Update an existing campaign assignment

• idnumberrequiredCampaign assignment ID
• activebooleanWhether assignment is active
• weightnumberRelative delivery weight
• schedulenumberSchedule ID
• geo_targetnumberGeo Target ID
• platform_targetnumberPlatform Target ID
• keywordsstringComma-separated keywords
• keywords_match_methodstringKeyword matching method
• data_key_targetnumberData Key Target ID
• list_targetnumberList Target ID

Delete a campaign assignment

• idnumberrequiredCampaign assignment ID

List all channels

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific channel

• idnumberrequiredChannel ID

Create a new channel

• namestringrequiredChannel name
• prioritystringServing priority (default: standard)
• use_share_of_voicebooleanWhether to use share of voice as serving strategy (false = use weight)

Update an existing channel

• idnumberrequiredChannel ID
• namestringChannel name
• prioritystringServing priority

Delete a channel

• idnumberrequiredChannel ID

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

• idnumberrequiredChannel ID

List all archived channels

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived channel

• idnumberrequiredArchived channel ID

Permanently delete an archived channel

• idnumberrequiredArchived channel ID

Restore an archived channel back to active status

• idnumberrequiredArchived channel ID

List all channel zone assignments

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific channel zone assignment

• idnumberrequiredChannel zone assignment ID

Assign a zone to a channel

• channelnumberrequiredChannel ID
• zoneobjectrequiredZone object with id and type

Remove a zone from a channel

• idnumberrequiredChannel zone assignment ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

List all standard zones

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific standard zone

• idnumberrequiredZone ID

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.

• namestringrequiredZone name
• publishernumberPublisher ID
• widthnumberZone width in pixels (must be 0 if dimensions is "dynamic")
• heightnumberZone height in pixels (must be 0 if dimensions is "dynamic")
• dimensionsstringZone dimensions type: "fixed" (default) or "dynamic"
• use_share_of_voicebooleanUse "share of voice" as serving strategy
• refresh_frequencynumberInterval in seconds for serving new ads
• refresh_limitnumberTotal times zone will refresh
• responsivestringSize behavior
• unique_deliverybooleanServe unique ads on each zone
• iab_categoriesarrayIAB category descriptors
• allow_demand_sourcesbooleanAllow requests to demand endpoints
• bid_floornumberDefault bid floor for programmatic
• min_payoutnumberMinimum payout per impression (CPM)
• serve_priority_orderstringPriority order: "weight" or "auction"
• pmp_dealsarrayAllowed PMP Deal IDs
• private_auctionbooleanWhether auction ignores non-deal bids
• optimization_strategystringZone optimization strategy
• burn_in_impressionsnumberImpressions before eCPM confidence
• burn_in_hoursnumberHours before eCPM confidence
• ecpm_testing_allowancenumberPercentage for eCPM recalculation testing
• metadataobjectCustom metadata key-value pairs
• rtb_placement_idstringOpenRTB tagid identifier
• api_frameworksarraySupported API frameworks for OpenRTB
• auction_tie_breakstringTie-breaking method for auctions
• allowed_root_native_templatesarrayAllowed root native template IDs
• ad_size_filterobjectAd size filter (dynamic zones only)

Update an existing standard zone

• idnumberrequiredZone ID
• namestringZone name
• publishernumberPublisher ID
• widthnumberZone width in pixels
• heightnumberZone height in pixels
• dimensionsstringZone dimensions type
• refresh_frequencynumberInterval in seconds for serving new ads
• refresh_limitnumberTotal times zone will refresh
• responsivestringSize behavior
• unique_deliverybooleanServe unique ads on each zone
• iab_categoriesarrayIAB category descriptors
• allow_demand_sourcesbooleanAllow requests to demand endpoints
• bid_floornumberDefault bid floor
• min_payoutnumberMinimum payout per impression (CPM)
• serve_priority_orderstringPriority order
• pmp_dealsarrayAllowed PMP Deal IDs
• private_auctionbooleanIgnore non-deal bids in auction
• optimization_strategystringZone optimization strategy
• burn_in_impressionsnumberImpressions before eCPM confidence
• burn_in_hoursnumberHours before eCPM confidence
• ecpm_testing_allowancenumberPercentage for eCPM recalculation
• metadataobjectCustom metadata key-value pairs
• rtb_placement_idstringOpenRTB tagid identifier
• api_frameworksarraySupported API frameworks
• auction_tie_breakstringTie-breaking method
• allowed_root_native_templatesarrayAllowed root native template IDs
• ad_size_filterobjectAd size filter (dynamic zones only)

Delete a standard zone

• idnumberrequiredZone ID

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

• idnumberrequiredZone ID

Get the conversion tracking tag for a standard zone

• idnumberrequiredZone ID

Generate ad serving tags for multiple zones at once

• zone_idsarrayrequiredArray of zone IDs to generate tags for

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

• idnumberrequiredZone ID

List all archived standard zones

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived standard zone

• idnumberrequiredArchived zone ID

Restore an archived standard zone back to active status

• idnumberrequiredArchived zone ID

List all email zones

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific email zone

• idnumberrequiredEmail zone ID

Create a new email zone for serving ads in email newsletters

• namestringrequiredZone name
• widthnumberrequiredZone width in pixels
• heightnumberrequiredZone height in pixels
• publishernumberPublisher ID
• metadataobjectCustom metadata key-value pairs
• uid_rotatebooleanServe different ads per user
• rotate_timerobjectPeriod after which user sees a new ad
• auction_tie_breakstringTie-breaking method for auctions

Update an existing email zone

• idnumberrequiredEmail zone ID
• namestringZone name
• widthnumberZone width in pixels
• heightnumberZone height in pixels
• publishernumberPublisher ID
• metadataobjectCustom metadata key-value pairs
• uid_rotatebooleanServe different ads per user
• rotate_timerobjectPeriod after which user sees a new ad
• auction_tie_breakstringTie-breaking method

Delete an email zone

• idnumberrequiredEmail zone ID

Get the ad serving tag for an email zone

• idnumberrequiredEmail zone ID

Get the conversion tracking tag for an email zone

• idnumberrequiredEmail zone ID

Archive an email zone

• idnumberrequiredEmail zone ID

List all archived email zones

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived email zone

• idnumberrequiredArchived email zone ID

Restore an archived email zone back to active status

• idnumberrequiredArchived email zone ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific catalog zone

• idnumberrequiredCatalog zone ID

Create a new catalog zone for product/retail ad serving

• namestringrequiredZone name
• catalog_idnumberrequiredCatalog ID
• publishernumberPublisher ID
• bid_floornumberDefault bid floor
• bid_floor_cpmnumberCPM bid floor
• bid_floor_cpcnumberCPC bid floor
• advertiser_cost_typestringBilling model
• auction_typestringAuction type
• click_cooldown_periodnumberClick cooldown period in seconds (1-86400)
• conversion_lookback_periodnumberConversion lookback period in seconds (1-7776000)

Update an existing catalog zone

• idnumberrequiredCatalog zone ID
• namestringZone name
• bid_floor_cpmnumberCPM bid floor
• bid_floor_cpcnumberCPC bid floor
• advertiser_cost_typestringBilling model
• auction_typestringAuction type
• click_cooldown_periodnumberClick cooldown period in seconds
• conversion_lookback_periodnumberConversion lookback period in seconds

Delete a catalog zone

• idnumberrequiredCatalog zone ID

Get the ad serving tag for a catalog zone

• idnumberrequiredCatalog zone ID

List all publishers in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific publisher

• idnumberrequiredPublisher ID

Create a new publisher

• namestringrequiredPublisher name
• timezonestringTimezone (e.g., "America/New_York")
• emailstringContact email (allows publisher to log in)
• can_change_passwordbooleanWhether publisher can change password
• can_admin_accountbooleanGrant administrator privileges
• can_approve_adsbooleanAllow publisher to approve/deny ad items
• can_view_wordpress_keybooleanAllow publisher to view WordPress key
• domainstringPublisher domain (top-level domains only)
• seller_typestringSeller type for ads.txt
• default_payoutobjectDefault payout configuration
• metadataobjectCustom metadata key-value pairs

Update an existing publisher

• idnumberrequiredPublisher ID
• namestringPublisher name
• timezonestringTimezone
• emailstringContact email
• can_change_passwordbooleanWhether publisher can change password
• can_admin_accountbooleanGrant administrator privileges
• can_approve_adsbooleanAllow publisher to approve/deny ad items
• can_view_wordpress_keybooleanAllow publisher to view WordPress key
• domainstringPublisher domain
• seller_typestringSeller type
• default_payoutobjectDefault payout configuration
• metadataobjectCustom metadata key-value pairs

Delete a publisher

• idnumberrequiredPublisher ID

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

• idnumberrequiredPublisher ID

List all archived publishers

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived publisher

• idnumberrequiredArchived publisher ID

Restore an archived publisher back to active status

• idnumberrequiredArchived publisher ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

List all image ad items

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific image ad item

• idnumberrequiredAd item ID

Create a new image ad item (banner)

• namestringrequiredAd item name
• creativenumberImage creative ID (mutually exclusive with creative_url)
• creative_urlstringURL to image file — PNG, JPEG, or GIF (mutually exclusive with creative)
• locationstringClick-through URL
• widthnumberAd width in pixels (defaults to 0)
• heightnumberAd height in pixels (defaults to 0)
• html_alt_textstringAlt text for the image
• html_targetstringWindow/frame for destination URL (e.g. "_blank")
• html_content_belowstringHTML content below the ad item
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Update an existing image ad item

• idnumberrequiredAd item ID
• namestringAd item name
• creativenumberImage creative ID
• creative_urlstringURL to image file
• locationstringClick-through URL
• widthnumberAd width in pixels
• heightnumberAd height in pixels
• html_alt_textstringAlt text for the image
• html_targetstringWindow/frame for destination URL
• html_content_belowstringHTML content below the ad item
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Delete an image ad item

• idnumberrequiredAd item ID

Get conversion tracking tag for an image ad item

• idnumberrequiredAd item ID

List all custom HTML ad items

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific custom HTML ad item

• idnumberrequiredAd item ID

Create a new custom HTML ad item

• namestringrequiredAd item name
• custom_htmlstringrequiredThe HTML content of the ad item
• locationstringClick-through URL
• widthnumberAd width in pixels (0 for flexible)
• heightnumberAd height in pixels (0 for flexible)
• html_content_belowstringHTML content below the ad item
• expand_horizontal_directionstringHorizontal expand direction
• expand_vertical_directionstringVertical expand direction
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Update an existing custom HTML ad item

• idnumberrequiredAd item ID
• namestringAd item name
• custom_htmlstringThe HTML content
• locationstringClick-through URL
• widthnumberAd width in pixels
• heightnumberAd height in pixels
• html_content_belowstringHTML content below the ad item
• expand_horizontal_directionstringHorizontal expand direction
• expand_vertical_directionstringVertical expand direction
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Delete a custom HTML ad item

• idnumberrequiredAd item ID

Get conversion tracking tag for a custom HTML ad item

• idnumberrequiredAd item ID

List all rich media ad items

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific rich media ad item

• idnumberrequiredAd item ID

Create a new rich media ad item

• namestringrequiredAd item name
• creativenumberrequiredRich media creative ID
• locationstringClick-through URL
• widthnumberAd width in pixels
• heightnumberAd height in pixels
• html_content_belowstringHTML content below the ad item
• expand_horizontal_directionstringHorizontal expand direction
• expand_vertical_directionstringVertical expand direction
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Update an existing rich media ad item

• idnumberrequiredAd item ID
• namestringAd item name
• creativenumberRich media creative ID
• locationstringClick-through URL
• html_content_belowstringHTML content below the ad item
• expand_horizontal_directionstringHorizontal expand direction
• expand_vertical_directionstringVertical expand direction
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Delete a rich media ad item

• idnumberrequiredAd item ID

Get conversion tracking tag for a rich media ad item

• idnumberrequiredAd item ID

List all native ad items

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific native ad item

• idnumberrequiredAd item ID

Create a new native ad item using a native template

• namestringrequiredAd item name
• templatenumberrequiredNative template ID
• variablesobjectrequiredTemplate variables as key-value pairs (keys should be integer strings)
• locationstringClick-through URL
• widthnumberAd width in pixels
• heightnumberAd height in pixels
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Update an existing native ad item

• idnumberrequiredAd item ID
• namestringAd item name
• templatenumberNative template ID
• variablesobjectTemplate variables as key-value pairs
• locationstringClick-through URL
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs
• trusted_redirect_domainsarrayTrusted redirect domains

Delete a native ad item

• idnumberrequiredAd item ID

Get conversion tracking tag for a native ad item

• idnumberrequiredAd item ID

List all catalog ad items

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific catalog ad item

• idnumberrequiredAd item ID

Create a new catalog ad item

• namestringrequiredAd item name
• catalog_idnumberrequiredCatalog ID
• catalog_item_identifierstringrequiredUnique identifier for the catalog item
• locationstringClick-through URL
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs

Update an existing catalog ad item

• idnumberrequiredAd item ID
• namestringAd item name
• catalog_item_identifierstringUnique identifier for the catalog item
• locationstringClick-through URL
• tracking_pixelstringThird-party tracking pixel URL
• tracking_pixelsarrayArray of tracking pixel URLs
• metadataobjectCustom metadata key-value pairs

Delete a catalog ad item

• idnumberrequiredAd item ID

Convert a native ad item to an image ad item

• idnumberrequiredNative ad item ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

List all image creatives

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific image creative

• idnumberrequiredCreative ID

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

• groupnumberrequiredMedia group ID
• namestringCreative name
• descriptionstringCreative description

Update an existing image creative

• idnumberrequiredCreative ID
• namestringCreative name
• descriptionstringCreative description

Delete an image creative

• idnumberrequiredCreative ID

List all rich media creatives

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific rich media creative

• idnumberrequiredCreative ID

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

• groupnumberrequiredMedia group ID
• namestringCreative name
• descriptionstringCreative description
• index_file_pathstringPath to index HTML file inside ZIP archive (for HTML5)

Update an existing rich media creative

• idnumberrequiredCreative ID
• namestringCreative name
• descriptionstringCreative description

Delete a rich media creative

• idnumberrequiredCreative ID

List all video creatives

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific video creative

• idnumberrequiredCreative ID

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

• groupnumberrequiredMedia group ID
• namestringCreative name
• descriptionstringCreative description

Update an existing video creative

• idnumberrequiredCreative ID
• namestringCreative name
• descriptionstringCreative description

Delete a video creative

• idnumberrequiredCreative ID

List all audio creatives

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific audio creative

• idnumberrequiredCreative ID

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

• groupnumberrequiredMedia group ID
• namestringCreative name
• descriptionstringCreative description

Update an existing audio creative

• idnumberrequiredCreative ID
• namestringCreative name
• descriptionstringCreative description

Delete an audio creative

• idnumberrequiredCreative ID

Replace the file on an image creative

• idnumberrequiredCreative ID

Replace the file on a rich media creative

• idnumberrequiredCreative ID

Replace the file on a video creative

• idnumberrequiredCreative ID

Replace the file on an audio creative

• idnumberrequiredCreative ID

List all placements (assignments of ad items to zones)

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific placement

• idnumberrequiredPlacement ID

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

• advertisementobjectrequiredAdvertisement object with id and type
• zoneobjectZone object (required if channel not set; mutually exclusive with channel)
• channelnumberChannel ID (required if zone not set; mutually exclusive with zone)
• schedulenumberrequiredSchedule ID
• activebooleanWhether placement is active (defaults to true)
• weightnumberRelative delivery weight
• share_of_voicenumberShare of voice percentage (required when zone uses share_of_voice)
• costobjectPricing model: fixed_cost OR cpm/cpc/cpa
• payoutobjectPublisher payout configuration
• prioritystringServing priority level (defaults to "standard")
• serve_methodstringServing system: weight-based or auction-based
• geo_targetnumberGeotarget ID
• platform_targetnumberPlatform target ID
• keywordsstringComma-separated keywords for targeting
• keywords_match_methodstringKeyword matching method
• data_key_target_idnumberData Key Target ID (Enterprise only)
• list_targetnumberList Target ID
• contextual_segmentsarrayArray of contextual segment IDs

Update an existing placement

• idnumberrequiredPlacement ID
• advertisementobjectAdvertisement object with id and type
• zoneobjectZone object (mutually exclusive with channel)
• channelnumberChannel ID (mutually exclusive with zone)
• schedulenumberSchedule ID
• activebooleanWhether placement is active
• weightnumberRelative delivery weight
• share_of_voicenumberShare of voice percentage
• costobjectPricing model
• payoutobjectPublisher payout configuration
• prioritystringServing priority level
• serve_methodstringServing system
• geo_targetnumberGeotarget ID
• platform_targetnumberPlatform target ID
• keywordsstringComma-separated keywords
• keywords_match_methodstringKeyword matching method
• data_key_target_idnumberData Key Target ID
• list_targetnumberList Target ID
• contextual_segmentsarrayArray of contextual segment IDs

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

• idnumberrequiredPlacement ID

Get conversion tracking tag for a placement

• idnumberrequiredPlacement ID

List all native ad templates

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific native template

• idnumberrequiredNative template ID

Create a new native ad template with HTML and variable placeholders

• namestringrequiredTemplate name
• raw_htmlstringrequiredHTML template content with variable placeholders (e.g. "[%title%]")
• variablesarrayrequiredArray of template variables

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

• idnumberrequiredNative template ID
• namestringTemplate name
• raw_htmlstringHTML template content with variable placeholders
• variablesobjectVariables to add/remove

Delete a native template

• idnumberrequiredNative template ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific schedule

• idnumberrequiredSchedule ID

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

• start_datestringStart date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at
• end_datestringEnd date (YYYY-MM-DD HH:MM:SS), null for indefinite — deprecated, use end_at
• start_atstringStart date/time in ISO-8601 format
• start_at_timezonestringIANA timezone for start_at (e.g. "America/New_York")
• end_atstringEnd date/time in ISO-8601 format, null for indefinite
• end_at_timezonestringIANA timezone for end_at
• delivery_methodstringDelivery pacing: "default" (ASAP) or "smooth" (evenly distributed)
• quota_lifetimenumberTotal quota amount (views or clicks, not per thousand)
• quota_typestringQuota measurement type
• day_cap_limitnumberDaily cap limit (number of views or clicks per day)
• day_cap_typestringDaily cap type
• per_user_view_limitnumberPer-user view frequency cap
• per_user_view_periodnumberDays before per-user view counter resets
• under_delivery_behaviourstringWhether to keep serving until quota met or stop on end date
• day_parting_idnumberDay parting ID for time-of-day targeting

Update an existing schedule

• idnumberrequiredSchedule ID
• start_datestringStart date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at
• end_datestringEnd date (YYYY-MM-DD HH:MM:SS) — deprecated, use end_at
• start_atstringStart date/time in ISO-8601 format
• start_at_timezonestringIANA timezone for start_at
• end_atstringEnd date/time in ISO-8601 format
• end_at_timezonestringIANA timezone for end_at
• delivery_methodstringDelivery pacing: "default" (ASAP) or "smooth" (evenly distributed)
• quota_lifetimenumberTotal quota amount (views or clicks, not per thousand)
• quota_typestringQuota measurement type
• day_cap_limitnumberDaily cap limit
• day_cap_typestringDaily cap type
• per_user_view_limitnumberPer-user view frequency cap
• per_user_view_periodnumberDays before per-user view counter resets
• under_delivery_behaviourstringWhether to keep serving until quota met or stop on end date
• day_parting_idnumberDay parting ID for time-of-day targeting

Delete a schedule

• idnumberrequiredSchedule ID

List all media groups (collections of creatives)

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific media group

• idnumberrequiredMedia group ID

Create a new media group

• namestringrequiredMedia group name

Update an existing media group

• idnumberrequiredMedia group ID
• namestringMedia group name

Delete a media group

• idnumberrequiredMedia group ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific data key

• idnumberrequiredData key ID

Create a new data key for custom targeting

• namestringrequiredData key name (max 32 chars, must be unique)
• typestringrequiredData key value type

Update an existing data key

• idnumberrequiredData key ID
• namestringData key name
• typestringData key value type

Delete a data key

• idnumberrequiredData key ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific data key target

• idnumberrequiredData key target ID

Create a new data key target (targeting rule)

• namestringrequiredData key target name
• targetstringrequiredJSON formatted target logic, e.g. ["OR", {"my_number": {"=": "5"}}, {"my_string": {"=": "test"}}]

Update an existing data key target

• idnumberrequiredData key target ID
• namestringData key target name
• targetstringJSON formatted target logic

Delete a data key target

• idnumberrequiredData key target ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific day parting rule

• idnumberrequiredDay parting ID

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.

• namestringDay parting name
• use_member_timezonebooleanIf true, use account timezone; if false, use viewer timezone
• is_templatebooleanIf true, shown in UI when creating/editing schedules
• rangesobjectObject mapping day names (monday-sunday) to arrays of time ranges like "09:00:00-17:00:00"

Update an existing day parting rule

• idnumberrequiredDay parting ID
• namestringDay parting name
• use_member_timezonebooleanIf true, use account timezone; if false, use viewer timezone
• is_templatebooleanIf true, shown in UI when creating/editing schedules
• rangesobjectObject mapping day names (monday-sunday) to arrays of time ranges

Delete a day parting rule

• idnumberrequiredDay parting ID

List all geo targets (geographic targeting rules)

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific geo target

• idnumberrequiredGeo target ID

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

• namestringrequiredGeo target name
• inclusivebooleanIf true, target users IN these areas; if false, EXCLUDE these areas
• areasarrayrequiredArray of geographic areas to target
• rangenumberRadius range for geo-fencing (only applies when targeting a city)
• unitstringDistance unit for range

Update an existing geo target

• idnumberrequiredGeo target ID
• namestringGeo target name
• inclusivebooleanIf true, target users IN these areas; if false, EXCLUDE
• areasarrayArray of geographic areas
• rangenumberRadius range
• unitstringDistance unit

Delete a geo target

• idnumberrequiredGeo target ID

List all postal code targets

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific postal code target

• idnumberrequiredPostal code target ID

Create a new postal code target

• labelstringrequiredPostal code target name
• inclusivebooleanIf true, inclusion target; if false, exclusion target
• locationsarrayrequiredArray of locations grouped by country

Update an existing postal code target

• idnumberrequiredPostal code target ID
• labelstringPostal code target name
• inclusivebooleanIf true, inclusion target; if false, exclusion target
• locationsarrayArray of locations grouped by country

Delete a postal code target

• idnumberrequiredPostal code target ID

List all list targets (allowlist/blocklist targeting)

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific list target

• idnumberrequiredList target ID

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

• labelstringrequiredList target name
• inclusivebooleanIf true, inclusion target; if false, exclusion target
• data_listnumberData list ID containing the values to target

Update an existing list target

• idnumberrequiredList target ID
• labelstringList target name
• inclusivebooleanIf true, inclusion; if false, exclusion
• data_listnumberData list ID

Delete a list target

• idnumberrequiredList target ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific platform target

• idnumberrequiredPlatform target ID

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

• namestringrequiredPlatform target name
• platformstringPreset platform target (default: any)
• device_targetsarrayList of device patterns to target (e.g. "Apple*", "Samsung Galaxy S5")

Update an existing platform target

• idnumberrequiredPlatform target ID
• namestringPlatform target name
• platformstringPreset platform target
• device_targetsarrayList of device patterns to target

Delete a platform target

• idnumberrequiredPlatform target ID

List all data targets

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Remove all usages of a list target

• idnumberrequiredList target ID

Get display advertising report with impressions, clicks, and CTR

• typestringrequiredReport type: overview, advertiser, publisher, zone, campaign, channel, geo-target, ad-item
• periodstringrequiredData grouping period: day, week, month, year
• presetstringDate preset: today, last-24-hours, yesterday, this-week, last-week, this-month, last-month, year-to-date, last-year, last-7-days, last-14-days, last-30-days, last-3-months, last-6-months, last-12-months
• timezonestringTimezone for preset (e.g. "America/New_York")
• summarybooleanInclude summary data
• detailsbooleanInclude detailed breakdown
• breakdownbooleanInclude breakdown data
• financialsbooleanInclude financial data
• publishersstringFilter by publisher IDs (comma-separated)
• zonesstringFilter by zone IDs (comma-separated)
• advertisersstringFilter by advertiser IDs (comma-separated)
• campaignsstringFilter by campaign IDs (comma-separated)
• exclude_publisher_ad_itemsbooleanExclude ad items directly in zones
• exclude_campaign_ad_itemsbooleanExclude ad items in campaigns
• exclude_channel_statsbooleanExclude stats from channel-served ads
• require_channel_statsbooleanOnly include stats from channel-served ads

Get VAST video advertising report

• typestringrequiredReport type: overview, advertiser, publisher, zone, campaign, ad-item
• periodstringrequiredData grouping period: day, week, month, year
• presetstringDate preset (same options as display report)
• timezonestringTimezone for preset
• summarybooleanInclude summary data
• detailsbooleanInclude detailed breakdown
• breakdownbooleanInclude breakdown data
• financialsbooleanInclude financial data
• publishersstringFilter by publisher IDs (comma-separated)
• zonesstringFilter by zone IDs (comma-separated)
• advertisersstringFilter by advertiser IDs (comma-separated)
• campaignsstringFilter by campaign IDs (comma-separated)

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

• log_typestringrequiredType of event log to retrieve
• fromstringStart date filter
• tostringEnd date filter

Get click details report

• presetstringDate preset
• timezonestringTimezone
• publishersstringFilter by publisher IDs (comma-separated)
• zonesstringFilter by zone IDs (comma-separated)
• advertisersstringFilter by advertiser IDs (comma-separated)
• campaignsstringFilter by campaign IDs (comma-separated)

Get conversion details report

• presetstringDate preset
• timezonestringTimezone
• publishersstringFilter by publisher IDs (comma-separated)
• zonesstringFilter by zone IDs (comma-separated)
• advertisersstringFilter by advertiser IDs (comma-separated)
• campaignsstringFilter by campaign IDs (comma-separated)

Get demand source statistics report

• presetstringDate preset
• timezonestringTimezone

Get display platform estimate statistics

• presetstringDate preset
• timezonestringTimezone

Get VAST platform estimate statistics

• presetstringDate preset
• timezonestringTimezone

Get geographic summary report

• presetstringDate preset
• timezonestringTimezone
• publishersstringFilter by publisher IDs (comma-separated)
• zonesstringFilter by zone IDs (comma-separated)
• advertisersstringFilter by advertiser IDs (comma-separated)
• campaignsstringFilter by campaign IDs (comma-separated)

Get auction placement statistics report

• presetstringDate preset
• timezonestringTimezone

Get placement forecast report

• presetstringDate preset
• timezonestringTimezone

Get display forecast report

• presetstringDate preset
• timezonestringTimezone

Get display channel forecast report

• presetstringDate preset
• timezonestringTimezone

Get VAST forecast report

• presetstringDate preset
• timezonestringTimezone

Get VAST channel forecast report

• presetstringDate preset
• timezonestringTimezone

Get VAST auction placements report

• presetstringDate preset
• timezonestringTimezone

Get VAST geographic summary report

• presetstringDate preset
• timezonestringTimezone
• publishersstringFilter by publisher IDs (comma-separated)
• zonesstringFilter by zone IDs (comma-separated)
• advertisersstringFilter by advertiser IDs (comma-separated)
• campaignsstringFilter by campaign IDs (comma-separated)

Get live website preview URL

• zone_idnumberZone ID to preview
• urlstringWebsite URL to preview

Generate manual tracking links for an ad item

• ad_item_idnumberAd item ID
• typestringAd item type

List all saved report configurations

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific report configuration

• idnumberrequiredReport configuration ID

Create a new report configuration

• namestringrequiredReport name
• typestringrequiredReport type
• periodstringrequiredData grouping period
• dateobjectrequiredDate configuration (either preset or start+end required)
• filtersobjectFilter criteria: { publishers: [...], advertisers: [...], zones: [...], campaigns: [...], ad_items: [...], channels: [...] }
• columnsarrayColumns to include: impressions, eligible, viewable, clicks, conversions, ctr, cvr, e_cpm, e_cpc, e_cpa, cost, payout, revenue
• exclude_publisher_ad_itemsbooleanExclude ad items directly in zones
• exclude_campaign_ad_itemsbooleanExclude ad items in campaigns
• exclude_channel_statsbooleanExclude stats from channel-served ads
• require_channel_statsbooleanOnly include stats from channel-served ads

Update an existing report configuration

• idnumberrequiredReport configuration ID
• namestringReport name
• typestringReport type
• periodstringData grouping period
• dateobjectDate configuration
• filtersobjectFilter criteria
• columnsarrayColumns to include
• exclude_publisher_ad_itemsbooleanExclude ad items directly in zones
• exclude_campaign_ad_itemsbooleanExclude ad items in campaigns
• exclude_channel_statsbooleanExclude stats from channel-served ads
• require_channel_statsbooleanOnly include stats from channel-served ads

Delete a report configuration

• idnumberrequiredReport configuration ID

List all VAST report data

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get a specific VAST report

• idnumberrequiredVAST report ID

Create a new VAST report configuration

• namestringrequiredReport name

List all generated reports across all configurations

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

List all report schedules across all configurations

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

List generated reports for a specific report configuration

• report_config_idnumberrequiredReport configuration ID
• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get a specific generated report

• report_config_idnumberrequiredReport configuration ID
• generated_idnumberrequiredGenerated report ID

List schedules for a specific report configuration

• report_config_idnumberrequiredReport configuration ID
• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get a specific report schedule

• report_config_idnumberrequiredReport configuration ID
• schedule_idnumberrequiredSchedule ID

Create a new report schedule

• report_config_idnumberrequiredReport configuration ID
• frequencystringSchedule frequency
• recipientsarrayArray of recipient objects

Update a report schedule

• report_config_idnumberrequiredReport configuration ID
• schedule_idnumberrequiredSchedule ID
• frequencystringSchedule frequency
• recipientsarrayArray of recipient objects

Delete a report schedule

• report_config_idnumberrequiredReport configuration ID
• schedule_idnumberrequiredSchedule ID

List generated reports for a specific schedule

• report_config_idnumberrequiredReport configuration ID
• schedule_idnumberrequiredSchedule ID
• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get a specific generated report from a schedule

• report_config_idnumberrequiredReport configuration ID
• schedule_idnumberrequiredSchedule ID
• generated_idnumberrequiredGenerated report ID

Revoke historical access for a report schedule

• report_config_idnumberrequiredReport configuration ID
• schedule_idnumberrequiredSchedule ID

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

• IDnumberrequiredYour AdButler account ID
• setIDnumberrequiredZone ID to serve an ad from
• typestringrequiredResponse type: "json" for most eligible ad, "jsonr" for all eligible ads ranked
• sizestringExpected ad size (e.g. "300x250")
• kwarrayKeywords for keyword targeting
• referrerstringPage URL for URL targeting (required for server-side requests)
• ipstringIPv4 address for geographic targeting (required for server-side requests)
• uastringUser agent string for platform targeting
• swnumberScreen width for platform targeting
• shnumberScreen height for platform targeting
• sprnumberScreen pixel ratio for platform targeting
• pidnumberPage ID for unique delivery/roadblocks (random number, same for all zones on page)
• placenumberPlace counter for unique delivery (0, 1, 2, etc.)
• _abdk_jsonobjectData key key-value pairs for data key targeting
• rfnumberPass 1 to include is_redirectable field in response
• defer_signingbooleanDefer beacon signing hash generation

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

• IDnumberrequiredYour AdButler account ID
• setIDnumberrequiredZone ID to serve an ad from
• typestringrequiredResponse type: "json" for most eligible ad, "jsonr" for all eligible ads ranked
• sizestringExpected ad size (e.g. "300x250")
• kwarrayKeywords for keyword targeting
• referrerstringPage URL for URL targeting (required for server-side requests)
• ipstringIPv4 address for geographic targeting (required for server-side requests)
• uastringUser agent string for platform targeting
• swnumberScreen width for platform targeting
• shnumberScreen height for platform targeting
• sprnumberScreen pixel ratio for platform targeting
• pidnumberPage ID for unique delivery/roadblocks (random number, same for all zones on page)
• placenumberPlace counter for unique delivery (0, 1, 2, etc.)
• _abdk_jsonobjectData key key-value pairs for data key targeting
• rfnumberPass 1 to include is_redirectable field in response
• defer_signingbooleanDefer beacon signing hash generation

List all VAST ad items

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST ad item

• idnumberrequiredVAST ad item ID

Create a new VAST ad item

• namestringrequiredAd item name
• locationstringrequiredVAST tag URL or media location
• activebooleanWhether ad item is active

Update an existing VAST ad item

• idnumberrequiredVAST ad item ID
• namestringAd item name
• locationstringVAST tag URL or media location
• activebooleanWhether ad item is active

Delete a VAST ad item

• idnumberrequiredVAST ad item ID

List all VAST campaigns

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST campaign

• idnumberrequiredVAST campaign ID

Create a new VAST campaign

• namestringrequiredCampaign name
• advertisernumberrequiredAdvertiser ID
• contractnumberContract ID (requires Contract Management add-on)

Update an existing VAST campaign

• idnumberrequiredVAST campaign ID
• namestringCampaign name
• advertisernumberAdvertiser ID
• contractnumberContract ID (requires Contract Management add-on)

Delete a VAST campaign

• idnumberrequiredVAST campaign ID

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

• idnumberrequiredVAST campaign ID

List all archived VAST campaigns

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived VAST campaign

• idnumberrequiredArchived VAST campaign ID

Permanently delete an archived VAST campaign

• idnumberrequiredArchived VAST campaign ID

Restore an archived VAST campaign back to active status

• idnumberrequiredArchived VAST campaign ID

List all VAST channels

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST channel

• idnumberrequiredVAST channel ID

Create a new VAST channel

• namestringrequiredChannel name
• descriptionstringChannel description

Update an existing VAST channel

• idnumberrequiredVAST channel ID
• namestringChannel name
• descriptionstringChannel description

Delete a VAST channel

• idnumberrequiredVAST channel ID

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

• idnumberrequiredVAST channel ID

List all archived VAST channels

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived VAST channel

• idnumberrequiredArchived VAST channel ID

Permanently delete an archived VAST channel

• idnumberrequiredArchived VAST channel ID

Restore an archived VAST channel back to active status

• idnumberrequiredArchived VAST channel ID

List all VAST channel zone assignments

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST channel zone assignment

• idnumberrequiredVAST channel zone assignment ID

Assign a VAST zone to a VAST channel

• channelnumberrequiredVAST channel ID
• zonenumberrequiredVAST zone ID

Update a VAST channel zone assignment

• idnumberrequiredVAST channel zone assignment ID
• channelnumberVAST channel ID
• zonenumberVAST zone ID

Remove a VAST zone from a VAST channel

• idnumberrequiredVAST channel zone assignment ID

List all VAST zones

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST zone

• idnumberrequiredVAST zone ID

Create a new VAST zone

• namestringrequiredZone name
• publishernumberrequiredPublisher ID
• default_vast_ad_itemnumberDefault VAST ad item ID (mutually exclusive with default_vast_campaign)
• default_vast_campaignnumberDefault VAST campaign ID (mutually exclusive with default_vast_ad_item)
• serve_priority_orderstringPriority order for serving: "weight" or "auction"
• metadataobjectCustom metadata key-value pairs

Update an existing VAST zone

• idnumberrequiredVAST zone ID
• namestringZone name
• publishernumberPublisher ID
• default_vast_ad_itemnumberDefault VAST ad item ID (mutually exclusive with default_vast_campaign)
• default_vast_campaignnumberDefault VAST campaign ID (mutually exclusive with default_vast_ad_item)
• serve_priority_orderstringPriority order for serving: "weight" or "auction"
• metadataobjectCustom metadata key-value pairs

Delete a VAST zone

• idnumberrequiredVAST zone ID

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

• idnumberrequiredVAST zone ID

List all archived VAST zones

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived VAST zone

• idnumberrequiredArchived VAST zone ID

Permanently delete an archived VAST zone

• idnumberrequiredArchived VAST zone ID

Restore an archived VAST zone back to active status

• idnumberrequiredArchived VAST zone ID

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

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST placement

• idnumberrequiredVAST placement ID

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

• advertisementobjectrequiredAdvertisement object with id and type
• zonenumberVAST zone ID (required if channel not set; mutually exclusive with channel)
• channelnumberVAST channel ID (required if zone not set; mutually exclusive with zone)
• schedulenumberrequiredVAST schedule ID
• activebooleanWhether placement is active (defaults to true)
• costobjectPricing model: fixed_cost OR cpm/cpc/cpa
• payoutobjectPublisher payout configuration
• prioritynumberPriority level (sponsorship, standard, network, bulk, house)
• max_frequencynumberFrequency cap limit
• max_frequency_periodnumberDays before frequency counter resets
• max_frequency_typestringEvent type to count for frequency capping
• serve_methodstringServing system: weight-based or auction-based
• data_key_target_idnumberData Key Target ID (Enterprise only)

Update an existing VAST placement

• idnumberrequiredVAST placement ID
• advertisementobjectAdvertisement object with id and type
• zonenumberVAST zone ID (mutually exclusive with channel)
• channelnumberVAST channel ID (mutually exclusive with zone)
• schedulenumberVAST schedule ID
• activebooleanWhether placement is active
• costobjectPricing model: fixed_cost OR cpm/cpc/cpa
• payoutobjectPublisher payout configuration
• prioritynumberPriority level
• max_frequencynumberFrequency cap limit
• max_frequency_periodnumberDays before frequency counter resets
• max_frequency_typestringEvent type for frequency capping
• serve_methodstringServing system: weight-based or auction-based
• data_key_target_idnumberData Key Target ID (Enterprise only)

Delete a VAST placement

• idnumberrequiredVAST placement ID

List all VAST campaign assignments

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST campaign assignment

• idnumberrequiredVAST campaign assignment ID

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

• ad_itemnumberrequiredVAST ad item ID
• campaignnumberrequiredVAST campaign ID
• activebooleanWhether to actively serve ads (defaults to true)

Update a VAST campaign assignment

• idnumberrequiredVAST campaign assignment ID
• ad_itemnumberVAST ad item ID
• campaignnumberVAST campaign ID
• activebooleanWhether to actively serve ads

Delete a VAST campaign assignment

• idnumberrequiredVAST campaign assignment ID

List all VAST schedules

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST schedule

• idnumberrequiredVAST schedule ID

Create a new VAST schedule for time-based ad delivery

• start_datestringStart date (YYYY-MM-DD HH:MM:SS)
• end_datestringEnd date (YYYY-MM-DD HH:MM:SS), null for indefinite
• delivery_methodstringDelivery pacing: "default" (ASAP) or "smooth" (evenly distributed)
• quota_lifetimenumberTotal quota amount (views or clicks, not per thousand)
• quota_typestringQuota measurement type
• geo_targetnumberGeotarget ID (0 = no targeting)
• day_parting_idnumberDay parting ID for time-of-day targeting

Update an existing VAST schedule

• idnumberrequiredVAST schedule ID
• start_datestringStart date (YYYY-MM-DD HH:MM:SS)
• end_datestringEnd date (YYYY-MM-DD HH:MM:SS), null for indefinite
• delivery_methodstringDelivery pacing: "default" (ASAP) or "smooth" (evenly distributed)
• quota_lifetimenumberTotal quota amount (views or clicks, not per thousand)
• quota_typestringQuota measurement type
• geo_targetnumberGeotarget ID (0 = no targeting)
• day_parting_idnumberDay parting ID for time-of-day targeting

Delete a VAST schedule

• idnumberrequiredVAST schedule ID

List all VAST companions

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST companion

• idnumberrequiredVAST companion ID

Create a new VAST companion

• namestringrequiredCompanion name
• widthnumberCompanion width in pixels
• heightnumberCompanion height in pixels

Update an existing VAST companion

• idnumberrequiredVAST companion ID
• namestringCompanion name
• widthnumberCompanion width in pixels
• heightnumberCompanion height in pixels

Delete a VAST companion

• idnumberrequiredVAST companion ID

List all VAST media (linear and non-linear)

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

List all VAST linear media

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST linear media

• idnumberrequiredVAST linear media ID

Create a new VAST linear media

• namestringrequiredLinear media name
• durationnumberDuration in seconds
• bitratenumberBitrate in kbps
• mime_typestringMIME type (e.g. video/mp4)

Update an existing VAST linear media

• idnumberrequiredVAST linear media ID
• namestringLinear media name
• durationnumberDuration in seconds
• bitratenumberBitrate in kbps
• mime_typestringMIME type (e.g. video/mp4)

Delete a VAST linear media

• idnumberrequiredVAST linear media ID

List all VAST non-linear media

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST non-linear media

• idnumberrequiredVAST non-linear media ID

Create a new VAST non-linear media

• namestringrequiredNon-linear media name
• widthnumberWidth in pixels
• heightnumberHeight in pixels
• mime_typestringMIME type

Update an existing VAST non-linear media

• idnumberrequiredVAST non-linear media ID
• namestringNon-linear media name
• widthnumberWidth in pixels
• heightnumberHeight in pixels
• mime_typestringMIME type

Delete a VAST non-linear media

• idnumberrequiredVAST non-linear media ID

List all VAST tracking entries

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific VAST tracking entry

• idnumberrequiredVAST tracking ID

Create a new VAST tracking entry

• namestringrequiredTracking name
• eventstringTracking event type (e.g. start, firstQuartile, midpoint, thirdQuartile, complete)
• urlstringTracking URL

Update an existing VAST tracking entry

• idnumberrequiredVAST tracking ID
• namestringTracking name
• eventstringTracking event type
• urlstringTracking URL

Delete a VAST tracking entry

• idnumberrequiredVAST tracking ID

Get VAST zone serving tags

• idnumberrequiredVAST zone ID

Get VAST zone conversion tracking tag

• idnumberrequiredVAST zone ID

Get conversion tracking tag for a VAST ad item

• idnumberrequiredVAST ad item ID

Get conversion tracking tag for a VAST campaign

• idnumberrequiredVAST campaign ID

Get conversion tracking tag for a VAST placement

• idnumberrequiredVAST placement ID

List all contracts

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific contract

• idnumberrequiredContract ID

Create a new contract

• namestringrequiredContract name
• advertisernumberrequiredAdvertiser ID
• descriptionstringContract description
• ratenumberContract rate (in account currency)
• payment_due_datestringPayment due date (YYYY-MM-DD)
• start_atstringContract start date (YYYY-MM-DD)
• end_atstringContract end date (YYYY-MM-DD)
• statusstringContract status

Update an existing contract

• idnumberrequiredContract ID
• namestringContract name
• advertisernumberAdvertiser ID
• descriptionstringContract description
• ratenumberContract rate
• payment_due_datestringPayment due date (YYYY-MM-DD)
• start_atstringContract start date (YYYY-MM-DD)
• end_atstringContract end date (YYYY-MM-DD)
• statusstringContract status

Delete a contract

• idnumberrequiredContract ID

List all archived contracts

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific archived contract

• idnumberrequiredArchived contract ID

Permanently delete an archived contract

• idnumberrequiredArchived contract ID

List all contract templates

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific contract template

• idnumberrequiredContract template ID

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

• namestringrequiredTemplate name
• filestringrequiredURL or path to the contract template file
• attributesstringrequiredJSON-encoded object containing name, email_subject, email_body, and optionally signing_service, basic_inputs, contract_column_inputs, signers
• email_subjectstringrequiredEmail subject line when sending for signature
• email_bodystringrequiredEmail body text when sending for signature

Update an existing contract template

• idnumberrequiredContract template ID
• namestringTemplate name

Delete a contract template

• idnumberrequiredContract template ID

List all documents for a contract

• contract_idnumberrequiredContract ID
• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific contract document

• contract_idnumberrequiredContract ID
• idnumberrequiredDocument ID

Create a new document for a contract

• contract_idnumberrequiredContract ID
• attributesstringJSON-encoded object with name, admin_executed, vendor_executed fields

Update an existing contract document

• contract_idnumberrequiredContract ID
• idnumberrequiredDocument ID
• namestringDocument name

Delete a contract document

• contract_idnumberrequiredContract ID
• idnumberrequiredDocument ID

List all payments for a contract

• contract_idnumberrequiredContract ID
• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific contract payment

• contract_idnumberrequiredContract ID
• idnumberrequiredPayment ID

Create a new payment for a contract

• contract_idnumberrequiredContract ID
• amountnumberrequiredAmount paid (can be negative for refunds)
• notestringPayment note or description

Delete a contract payment

• contract_idnumberrequiredContract ID
• idnumberrequiredPayment ID

List all signature requests for a contract

• contract_idnumberrequiredContract ID
• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific signature request

• contract_idnumberrequiredContract ID
• idnumberrequiredSignature request ID

Create a new signature request for a contract

• contract_idnumberrequiredContract ID

Update an existing signature request

• contract_idnumberrequiredContract ID
• idnumberrequiredSignature request ID

Delete a signature request

• contract_idnumberrequiredContract ID
• idnumberrequiredSignature request ID

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

• idnumberrequiredContract ID

Unarchive a contract (restore from archive)

• idnumberrequiredArchived contract ID

Get campaigns assigned to a contract

• idnumberrequiredContract ID

Get the active signature request for a contract

• idnumberrequiredContract ID

Create a contract document from a template

• contract_idnumberrequiredContract ID
• template_idnumberTemplate ID

Replace the file on a contract document

• contract_idnumberrequiredContract ID
• document_idnumberrequiredDocument ID

Replace a contract document file from a template

• contract_idnumberrequiredContract ID
• document_idnumberrequiredDocument ID

List file revisions for a contract document

• contract_idnumberrequiredContract ID
• document_idnumberrequiredDocument ID

Get a specific file revision for a contract document

• contract_idnumberrequiredContract ID
• document_idnumberrequiredDocument ID
• revision_idnumberrequiredFile revision ID

Download a file revision for a contract document

• contract_idnumberrequiredContract ID
• document_idnumberrequiredDocument ID
• revision_idnumberrequiredFile revision ID

List all recipients for a signature request

• contract_idnumberrequiredContract ID
• request_idnumberrequiredSignature request ID

Get a specific recipient for a signature request

• contract_idnumberrequiredContract ID
• request_idnumberrequiredSignature request ID
• recipient_idnumberrequiredRecipient ID

Update a recipient for a signature request

• contract_idnumberrequiredContract ID
• request_idnumberrequiredSignature request ID
• recipient_idnumberrequiredRecipient ID
• namestringRecipient name
• emailstringRecipient email

Delete a recipient from a signature request

• contract_idnumberrequiredContract ID
• request_idnumberrequiredSignature request ID
• recipient_idnumberrequiredRecipient ID

Cancel a signature request

• contract_idnumberrequiredContract ID
• request_idnumberrequiredSignature request ID

Resend a signature request

• contract_idnumberrequiredContract ID
• request_idnumberrequiredSignature request ID

List all managers in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific manager by ID

• idnumberrequiredManager ID

Create a new manager

• namestringrequiredManager name
• emailstringrequiredManager email address
• passwordstringLogin password (min 8 chars with upper, lower, number). Random if blank.
• notesstringNotes about the manager
• positionstringManager position in organization
• is_enabledbooleanWhether the manager account is enabled
• can_manage_linksbooleanCan create/edit/delete active tracking links
• can_manage_mediabooleanCan manage creatives and media groups
• can_manage_targetsbooleanCan assign/remove targets from placements
• can_manage_usersbooleanCan manage user accounts and permissions
• can_manage_biddersbooleanCan manage bidders
• can_manage_programmaticbooleanCan manage demand sources and PMP deals
• can_manage_contractsbooleanCan manage contracts and templates
• can_manage_self_servebooleanCan manage Self-Serve portals
• can_assign_campaigns_directlybooleanCan assign campaigns directly to zones
• can_manage_ticketsbooleanCan create/view support tickets
• can_manage_admin_api_accessbooleanCan manage API keys
• can_manage_billingbooleanCan view invoices and billing
• can_manage_data_keysbooleanCan manage data keys
• can_manage_product_dbbooleanCan manage product catalogs
• can_manage_native_ad_templatesbooleanCan manage native templates
• publisher_accessstringPublisher access level
• publisher_access_listarrayPublisher IDs accessible when publisher_access is "specific"
• statistics_accessstringStatistics access level

Update an existing manager

• idnumberrequiredManager ID
• namestringManager name
• emailstringManager email address
• passwordstringLogin password
• notesstringNotes about the manager
• positionstringManager position
• is_enabledbooleanWhether the manager account is enabled
• can_manage_linksbooleanCan manage tracking links
• can_manage_mediabooleanCan manage creatives and media groups
• can_manage_targetsbooleanCan manage targets
• can_manage_usersbooleanCan manage users
• can_manage_biddersbooleanCan manage bidders
• can_manage_programmaticbooleanCan manage programmatic
• can_manage_contractsbooleanCan manage contracts
• can_manage_self_servebooleanCan manage Self-Serve
• can_assign_campaigns_directlybooleanCan assign campaigns directly
• can_manage_ticketsbooleanCan manage tickets
• can_manage_admin_api_accessbooleanCan manage API keys
• can_manage_billingbooleanCan manage billing
• can_manage_data_keysbooleanCan manage data keys
• can_manage_product_dbbooleanCan manage product catalogs
• can_manage_native_ad_templatesbooleanCan manage native templates
• publisher_accessstringPublisher access level
• publisher_access_listarrayPublisher IDs for specific access
• statistics_accessstringStatistics access level

Delete a manager

• idnumberrequiredManager ID

List all roles in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific role by ID

• idnumberrequiredRole ID

Create a new role with permission settings

• namestringrequiredRole name
• is_default_rolebooleanAuto-assign this role to new users
• can_manage_linksbooleanCan manage tracking links
• can_manage_mediabooleanCan manage creatives and media groups
• can_manage_targetsbooleanCan manage targets
• can_manage_usersbooleanCan manage users
• can_manage_biddersbooleanCan manage bidders
• can_manage_programmaticbooleanCan manage programmatic
• can_manage_contractsbooleanCan manage contracts
• can_manage_self_servebooleanCan manage Self-Serve
• can_assign_campaigns_directlybooleanCan assign campaigns directly
• can_manage_ticketsbooleanCan manage tickets
• can_manage_admin_api_accessbooleanCan manage API keys
• can_manage_billingbooleanCan manage billing
• can_manage_data_keysbooleanCan manage data keys
• can_manage_product_dbbooleanCan manage product catalogs
• can_manage_native_ad_templatesbooleanCan manage native templates
• publisher_accessstringPublisher access level
• publisher_access_listarrayPublisher IDs for specific access
• statistics_accessstringStatistics access level

Update an existing role

• idnumberrequiredRole ID
• namestringRole name
• is_default_rolebooleanAuto-assign to new users
• can_manage_linksbooleanCan manage tracking links
• can_manage_mediabooleanCan manage creatives
• can_manage_targetsbooleanCan manage targets
• can_manage_usersbooleanCan manage users
• can_manage_biddersbooleanCan manage bidders
• can_manage_programmaticbooleanCan manage programmatic
• can_manage_contractsbooleanCan manage contracts
• can_manage_self_servebooleanCan manage Self-Serve
• can_assign_campaigns_directlybooleanCan assign campaigns directly
• can_manage_ticketsbooleanCan manage tickets
• can_manage_admin_api_accessbooleanCan manage API keys
• can_manage_billingbooleanCan manage billing
• can_manage_data_keysbooleanCan manage data keys
• can_manage_product_dbbooleanCan manage product catalogs
• can_manage_native_ad_templatesbooleanCan manage native templates
• publisher_accessstringPublisher access level
• publisher_access_listarrayPublisher IDs for specific access
• statistics_accessstringStatistics access level

Delete a role

• idnumberrequiredRole ID

List all contacts in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific contact by ID

• idnumberrequiredContact ID

Create a new contact

• namestringrequiredContact name (full name recommended)
• emailstringrequiredContact email address (must be unique)
• notesstringAdditional notes about the contact

Update an existing contact

• idnumberrequiredContact ID
• namestringContact name
• emailstringContact email address
• notesstringAdditional notes

Delete a contact

• idnumberrequiredContact ID

List report schedules for a contact

• idnumberrequiredContact ID

List all demand sources in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific demand source by ID

• idnumberrequiredDemand source ID

Create a new demand source

• namestringrequiredDemand source name
• networkstringrequiredNetwork type: 'adview', 'aerserv', 'inmobi', 'inneractive', 'loopme', 'mobilefuse', 'onebyaol', 'pubmatic', 'pubnative', 'smaato', 'startapp', 'tappx', 'consumable', 'bidphysics', or 'openrtb'
• statusstringWhether to send bid requests (default: active)
• spend_limitnumberSpend limit amount
• spend_limit_periodstringSpend limit reset interval
• spend_limit_startstringSpend limit start date (ISO-8601)
• spend_limit_endstringSpend limit end date (ISO-8601)

Update an existing demand source

• idnumberrequiredDemand source ID
• namestringDemand source name
• statusstringWhether to send bid requests
• spend_limitnumberSpend limit amount
• spend_limit_periodstringSpend limit reset interval
• spend_limit_startstringSpend limit start date (ISO-8601)
• spend_limit_endstringSpend limit end date (ISO-8601)

Delete a demand source

• idnumberrequiredDemand source ID

List all demand endpoints in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific demand endpoint by ID

• idnumberrequiredDemand endpoint ID

Create a new demand endpoint

• namestringrequiredDemand endpoint name
• demand_sourcenumberrequiredDemand Source ID this endpoint belongs to
• default_parametersobjectrequiredDefault parameters for the endpoint (e.g. { url: "https://..." })
• supported_formatsarrayrequiredSupported ad formats: "display", "native", "video"
• statusstringWhether to send bid requests (default: active)
• bid_floornumberDefault CPM bid floor
• revenue_sharenumberRevenue share percentage paid to publisher
• markup_percentnumberMarkup percent applied to zone bid floor
• allowed_sizesarrayAllowed zone sizes (e.g. ["300x250", "728x90"])
• prioritystringServing priority
• geo_targetnumberGeo target ID for geographic targeting
• filter_typestringZone filtering type
• filtered_zonesarrayZone IDs for the filter list
• filtered_vast_zonesarrayVAST zone IDs for the filter list
• native_json_encodedbooleanWhether native JSON should be encoded

Update an existing demand endpoint

• idnumberrequiredDemand endpoint ID
• namestringDemand endpoint name
• demand_sourcenumberDemand Source ID
• default_parametersobjectDefault parameters
• supported_formatsarraySupported ad formats
• statusstringWhether to send bid requests
• bid_floornumberDefault CPM bid floor
• revenue_sharenumberRevenue share percentage
• markup_percentnumberMarkup percent
• allowed_sizesarrayAllowed zone sizes
• prioritystringServing priority
• geo_targetnumberGeo target ID
• filter_typestringZone filtering type
• filtered_zonesarrayZone IDs for filter list
• filtered_vast_zonesarrayVAST zone IDs for filter list
• native_json_encodedbooleanWhether native JSON should be encoded

Delete a demand endpoint

• idnumberrequiredDemand endpoint ID

List all PMP deals in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific PMP deal by ID

• idnumberrequiredPMP deal ID

Create a new PMP deal

• namestringPMP deal name
• bid_floornumberBid floor for this deal
• whitelist_seatsarraySeat IDs with access to this deal
• geo_targetnumberGeo target ID (0 = no targeting)
• audience_targetnumberAudience target ID (null = no targeting)

Update an existing PMP deal

• idnumberrequiredPMP deal ID
• namestringPMP deal name
• bid_floornumberBid floor
• whitelist_seatsarraySeat IDs with access
• geo_targetnumberGeo target ID
• audience_targetnumberAudience target ID

Delete a PMP deal

• idnumberrequiredPMP deal ID

List all OpenRTB native templates in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific OpenRTB native template by ID

• idnumberrequiredORTB native template ID

Create a new OpenRTB native template

• namestringORTB native template name
• html_templatestringHTML template for rendering the native ad (e.g. "<div>{{title}}</div>")

Update an existing OpenRTB native template

• idnumberrequiredORTB native template ID
• namestringORTB native template name
• html_templatestringHTML template for rendering the native ad

Delete an OpenRTB native template

• idnumberrequiredORTB native template ID

List all user databases in your AdButler account

• limitnumberMax results to return (default 100, max 100)
• offsetnumberPagination offset

Get details of a specific user database by ID

• idnumberrequiredUser database ID

Create a new user database

• namestringUser database name
• id_field_namestringName of the field to use as primary user identifier