mcpserver.lol
registry/adbutler-mcp-server
Connection check verified live · 20h ago

adbutler-mcp-server

Manage AdButler campaigns, zones, ad items, VAST, and reports from Claude, ChatGPT, and Cursor.

Tools 627
GitHub stars
Installs / wk
Licence
Transport streamable-http, sse, stdio
Last checked 20h ago

Tools & capabilities

627 tools

Read from the running server on 20h ago.

add_user_list_attribute_values valuesuser_id*user_db_id*list_attribute_name*
Add values to a list attribute for a user
archive_advertiser id*
Archive an advertiser (soft-delete, can be restored later)
archive_campaign id*
Archive a standard campaign (soft-delete, can be restored later)
archive_channel id*
Archive a channel (soft-delete, can be restored later)
archive_contract id*
Archive a contract (soft-delete, can be restored later)
archive_email_zone id*
Archive an email zone
archive_publisher id*
Archive a publisher (soft-delete, can be restored later)
archive_zone id*
Archive a standard zone (soft-delete, can be restored later)
bulk_create_product_sources sourcespublisher_id*
Bulk create product sources for a publisher
bulk_upload_add_data_list id*data
Bulk add entries to a data list
bulk_upload_product_catalog catalog_id*publisher_id*
Bulk upload items to a product catalog
bulk_upload_remove_data_list id*data
Bulk remove entries from a data list
bulk_upload_replace_data_list id*data
Bulk replace all entries in a data list
bulk_upload_replace_user_db id*
Bulk upload to replace all user data in a user database
call_adbutler_api bodypath*method*path_paramsquery_params
Call any AdButler API endpoint directly. Use this only when no specific tool wraps the endpoint you need. The session's configured API key is used automatically — do NOT pass an ap…
campaign_bulk_create_catalog_ad_items items*campaign_id*
Bulk create catalog ad items in a campaign
campaign_bulk_delete_catalog_ad_items items*campaign_id*
Bulk delete catalog ad items from a campaign
cancel_signature_request request_id*contract_id*
Cancel a signature request
convert_native_to_image id*
Convert a native ad item to an image ad item
create_advertiser name*emailmetadatapasswordcan_add_ad_itemscan_change_password
Create a new advertiser
create_audience nameattributesuser_db_id*
Create a new audience in a user database
create_audio_creative namegroup*description
Create a new audio creative. The API uses multipart file upload.
create_beacon_signing_key key_name*
Create a new beacon signing key
create_bidder name*statusbid_url
Create a new bidder
create_campaign name*budgetcontractmetadataadvertiserroadblock_tags +3
Create a new standard campaign
create_campaign_assignment activeweightcampaign*keywordsschedulegeo_target +5
Create a new campaign assignment (assign an ad item to a campaign)
create_catalog_ad_item name*locationmetadatacatalog_id*tracking_pixeltracking_pixels +1
Create a new catalog ad item
create_catalog_zone name*bid_floorpublishercatalog_id*auction_typebid_floor_cpc +4
Create a new catalog zone for product/retail ad serving
create_channel name*priorityuse_share_of_voice
Create a new channel
create_channel_zone_assignment zone*channel*
Assign a zone to a channel
create_contact name*email*notes
Create a new contact
create_contract name*rateend_atstatusstart_atadvertiser* +2
Create a new contract
create_contract_document attributescontract_id*
Create a new document for a contract
create_contract_document_from_template contract_id*template_id
Create a contract document from a template
create_contract_payment noteamount*contract_id*
Create a new payment for a contract
create_contract_template file*name*attributes*email_body*email_subject*
Create a new contract template. Requires name, file, attributes (JSON string), email_subject, and email_body.
create_creative namegroup*description
Create a new image creative. The API uses multipart file upload — pass the media group ID and file attributes.
create_custom_html_ad_item name*widthheightlocationmetadatacustom_html* +6
Create a new custom HTML ad item
create_custom_report date*name*type*period*columnsfilters +4
Create a new report configuration
create_data_key name*type*
Create a new data key for custom targeting
create_data_key_target name*target*
Create a new data key target (targeting rule)
create_data_list label*
Create a new data list
create_day_parting namerangesis_templateuse_member_timezone
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_demand_endpoint name*statusprioritybid_floorgeo_targetfilter_type +9
Create a new demand endpoint
create_demand_source name*statusnetwork*spend_limitspend_limit_endspend_limit_start +1
Create a new demand source
create_email_zone name*width*height*metadatapublisheruid_rotate +2
Create a new email zone for serving ads in email newsletters
create_event_log_upload_config nameformatenabledfrequencyconnection_id
Create a new event log upload configuration
create_geo_target name*unitareas*rangeinclusive
Create a new geo target for geographic targeting. Areas is an array of objects with continent, country (2-letter code), region, city fields.
create_image_ad_item name*widthheightcreativelocationmetadata +7
Create a new image ad item (banner)
create_list_target label*data_listinclusive
Create a new list target (inclusion/exclusion using a data list)
create_manager name*email*notespasswordpositionis_enabled +18
Create a new manager
create_media_group name*
Create a new media group
create_native_ad_item name*widthheightlocationmetadatatemplate* +4
Create a new native ad item using a native template
create_native_template name*raw_html*variables*
Create a new native ad template with HTML and variable placeholders
create_ortb_native_data_asset lentypetemplate_id*
Create a new data asset for an ORTB native template
create_ortb_native_image_asset hwhmintypewmintemplate_id*
Create a new image asset for an ORTB native template
create_ortb_native_template namehtml_template
Create a new OpenRTB native template
create_ortb_native_title_asset lentemplate_id*
Create a new title asset for an ORTB native template
create_placement costzoneactivepayoutweightchannel +12
Create a new placement (assign an ad item or campaign to a zone or channel)
create_platform_target name*platformdevice_targets
Create a new platform target for device/OS/browser targeting
create_pmp_deal namebid_floorgeo_targetaudience_targetwhitelist_seats
Create a new PMP deal
create_postal_code_target label*inclusivelocations*
Create a new postal code target
create_product_catalog namepublisher_id*
Create a new product catalog for a publisher
create_product_catalog_item urlnamepricecategoryimage_urlcatalog_id* +3
Create a new item in a product catalog
create_product_source urlnametypepublisher_id*
Create a new product source for a publisher
create_product_source_target namesource_idpublisher_id*
Create a new product source target for a publisher
create_publisher name*emaildomainmetadatatimezoneseller_type +5
Create a new publisher
create_report_schedule frequencyrecipientsreport_config_id*
Create a new report schedule
create_rich_media_ad_item name*widthheightcreative*locationmetadata +6
Create a new rich media ad item
create_rich_media_creative namegroup*descriptionindex_file_path
Create a new rich media creative. The API uses multipart file upload (ZIP for HTML5).
create_role name*is_default_rolecan_manage_linkscan_manage_mediacan_manage_userspublisher_access +14
Create a new role with permission settings
create_schedule end_atend_datestart_atquota_typestart_dateday_cap_type +9
Create a new schedule for time-based ad delivery. Schedules are automatically linked to ad items via placements.
create_sftp_connection hostnamepathportpasswordusername
Create a new SFTP connection
create_signature_request contract_id*
Create a new signature request for a contract
create_trial_account name*email*phonecompany*website
Create a free AdButler trial account. Use this when the user does NOT have an AdButler account yet. Collects their info and creates the account. After calling this, the user must c…
create_trusted_redirect_domain domain*
Create a new trusted redirect domain
create_user user_idattributesuser_db_id*
Create a new user in a user database
create_user_attribute idtypelabeluser_db_id*
Create a new user attribute in a user database
create_user_db nameid_field_name
Create a new user database
create_vast_custom_report name*
Create a new VAST report configuration
create_video_creative namegroup*description
Create a new video creative. The API uses multipart file upload.
create_zone name*widthheightmetadatabid_floorpmp_deals +21
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.
create_zone_ortb_native_ad namezone_id*template_id
Create a new ORTB native ad for a standard zone
delete_advertiser id*
Delete an advertiser
delete_archived_campaign id*
Permanently delete an archived standard campaign
delete_archived_channel id*
Permanently delete an archived channel
delete_archived_contract id*
Permanently delete an archived contract
delete_audience id*user_db_id*
Delete an audience from a user database
delete_audio_creative id*
Delete an audio creative
delete_beacon_signing_key id*
Delete a beacon signing key
delete_bidder id*
Delete a bidder
delete_campaign id*
Delete a standard campaign
delete_campaign_assignment id*
Delete a campaign assignment
delete_catalog_ad_item id*
Delete a catalog ad item
delete_catalog_zone id*
Delete a catalog zone
delete_channel id*
Delete a channel
delete_channel_zone_assignment id*
Remove a zone from a channel
delete_contact id*
Delete a contact
delete_contract id*
Delete a contract
delete_contract_document id*contract_id*
Delete a contract document
delete_contract_payment id*contract_id*
Delete a contract payment
delete_contract_template id*
Delete a contract template
delete_creative id*
Delete an image creative
delete_custom_html_ad_item id*
Delete a custom HTML ad item
delete_custom_report id*
Delete a report configuration
delete_data_key id*
Delete a data key
delete_data_key_target id*
Delete a data key target
delete_data_list id*
Delete a data list
delete_day_parting id*
Delete a day parting rule
delete_demand_endpoint id*
Delete a demand endpoint
delete_demand_source id*
Delete a demand source
delete_email_zone id*
Delete an email zone
delete_event_log_upload_config id*
Delete an event log upload configuration
delete_geo_target id*
Delete a geo target
delete_image_ad_item id*
Delete an image ad item
delete_list_target id*
Delete a list target
delete_manager id*
Delete a manager
delete_media_group id*
Delete a media group
delete_native_ad_item id*
Delete a native ad item
delete_native_template id*
Delete a native template
delete_ortb_native_data_asset id*template_id*
Delete a data asset from an ORTB native template
delete_ortb_native_image_asset id*template_id*
Delete an image asset from an ORTB native template
delete_ortb_native_template id*
Delete an OpenRTB native template
delete_ortb_native_title_asset id*template_id*
Delete a title asset from an ORTB native template
delete_placement id*
Delete a placement (remove an ad item from a zone)
delete_platform_target id*
Delete a platform target
delete_pmp_deal id*
Delete a PMP deal
delete_postal_code_target id*
Delete a postal code target
delete_product_source source_id*publisher_id*
Delete a product source
delete_product_source_target publisher_id*source_target_id*
Delete a product source target
delete_publisher id*
Delete a publisher
delete_report_schedule schedule_id*report_config_id*
Delete a report schedule
delete_rich_media_ad_item id*
Delete a rich media ad item
delete_rich_media_creative id*
Delete a rich media creative
delete_role id*
Delete a role
delete_schedule id*
Delete a schedule
delete_sftp_connection id*
Delete an SFTP connection
delete_signature_request id*contract_id*
Delete a signature request
delete_signature_request_recipient request_id*contract_id*recipient_id*
Delete a recipient from a signature request
delete_trusted_redirect_domain id*
Delete a trusted redirect domain
delete_user_attribute id*user_db_id*
Delete a user attribute from a user database
delete_video_creative id*
Delete a video creative
delete_zone id*
Delete a standard zone
delete_zone_ortb_native_ad id*zone_id*
Delete an ORTB native ad from a standard zone
describe_adbutler_api path*method*
Get the full schema (parameters, request body shape, response shape) for one AdButler API endpoint. Use after search_adbutler_api to understand exactly what to send when you call i…
download_contract_document_file_revision contract_id*document_id*revision_id*
Download a file revision for a contract document
draft_create_campaign draft*
Create a new draft standard campaign. Fields go inside a "draft" object wrapper.
draft_create_campaign_assignment draftad_item_draft_id*campaign_draft_id*
Create a new draft campaign assignment
draft_create_catalog_ad_item draft*campaign_draft_id*
Create a new draft catalog ad item
draft_create_custom_html_ad_item draft*campaign_draft_id*
Create a new draft custom HTML ad item
draft_create_image_ad_item draft*campaign_draft_id*
Create a new draft image ad item
draft_create_native_ad_item draft*campaign_draft_id*
Create a new draft native ad item
draft_create_placement draft*campaign_draft_id*
Create a new draft placement
draft_create_rich_media_ad_item draft*campaign_draft_id*
Create a new draft rich media ad item
draft_create_schedule draft*campaign_draft_id*
Create a new draft schedule
draft_delete_campaign id*
Delete a draft standard campaign
draft_delete_campaign_assignment id*
Delete a draft campaign assignment
draft_delete_catalog_ad_item id*
Delete a draft catalog ad item
draft_delete_custom_html_ad_item id*
Delete a draft custom HTML ad item
draft_delete_image_ad_item id*
Delete a draft image ad item
draft_delete_native_ad_item id*
Delete a draft native ad item
draft_delete_placement id*
Delete a draft placement
draft_delete_rich_media_ad_item id*
Delete a draft rich media ad item
draft_delete_schedule id*
Delete a draft schedule
draft_get_ad_item id*
Get a draft ad item of any type by ID
draft_get_campaign id*
Get details of a specific draft standard campaign
draft_get_campaign_assignment id*
Get details of a specific draft campaign assignment
draft_get_catalog_ad_item id*
Get details of a specific draft catalog ad item
draft_get_custom_html_ad_item id*
Get details of a specific draft custom HTML ad item
draft_get_image_ad_item id*
Get details of a specific draft image ad item
draft_get_native_ad_item id*
Get details of a specific draft native ad item
draft_get_placement id*
Get details of a specific draft placement
draft_get_rich_media_ad_item id*
Get details of a specific draft rich media ad item
draft_get_schedule id*
Get details of a specific draft schedule
draft_list_ad_items limitoffset
List all draft ad items across all types
draft_list_campaign_assignments limitoffset
List all draft campaign assignments
draft_list_campaigns limitoffset
List all draft standard campaigns
draft_list_catalog_ad_items limitoffset
List all draft catalog ad items
draft_list_custom_html_ad_items limitoffset
List all draft custom HTML ad items
draft_list_image_ad_items limitoffset
List all draft image ad items
draft_list_native_ad_items limitoffset
List all draft native ad items
draft_list_placements limitoffset
List all draft placements
draft_list_rich_media_ad_items limitoffset
List all draft rich media ad items
draft_list_schedules limitoffset
List all draft schedules
draft_save_campaign id*
Save/publish a draft campaign (converts draft to live campaign)
draft_update_campaign id*draft
Update an existing draft standard campaign
draft_update_campaign_assignment id*draft
Update an existing draft campaign assignment
draft_update_catalog_ad_item id*draft
Update an existing draft catalog ad item
draft_update_custom_html_ad_item id*draft
Update an existing draft custom HTML ad item
draft_update_image_ad_item id*draft
Update an existing draft image ad item
draft_update_native_ad_item id*draft
Update an existing draft native ad item
draft_update_placement id*draft
Update an existing draft placement
draft_update_rich_media_ad_item id*draft
Update an existing draft rich media ad item
draft_update_schedule id*draft
Update an existing draft schedule
generate_bulk_zone_tags zone_ids*
Generate ad serving tags for multiple zones at once
get_ad ID*ipkwrfshsw +10
Retrieve an ad via GET request. Same parameters as serve_ad but uses GET instead of POST.
get_advertiser id*
Get details of a specific advertiser by ID
get_archived_advertiser id*
Get details of a specific archived advertiser
get_archived_campaign id*
Get details of a specific archived standard campaign
get_archived_channel id*
Get details of a specific archived channel
get_archived_contract id*
Get details of a specific archived contract
get_archived_email_zone id*
Get details of a specific archived email zone
get_archived_publisher id*
Get details of a specific archived publisher
get_archived_zone id*
Get details of a specific archived standard zone
get_auction_placements_report presettimezone
Get auction placement statistics report
get_audience id*user_db_id*
Get details of a specific audience in a user database
get_audio_creative id*
Get details of a specific audio creative
get_beacon_signing_key id*
Get details of a specific beacon signing key by ID
get_bidder id*
Get details of a specific bidder by ID
get_campaign id*
Get details of a specific standard campaign
get_campaign_assignment id*
Get details of a specific campaign assignment
get_campaign_conversion_tag id*
Get conversion tag for a campaign
get_campaign_eligible_zones id*
Get eligible zones for a campaign
get_catalog_ad_item id*
Get details of a specific catalog ad item
get_catalog_zone id*
Get details of a specific catalog zone
get_catalog_zone_tag id*
Get the ad serving tag for a catalog zone
get_channel id*
Get details of a specific channel
get_channel_zone_assignment id*
Get details of a specific channel zone assignment
get_click_details_report zonespresettimezonecampaignspublishersadvertisers
Get click details report
get_contact id*
Get details of a specific contact by ID
get_contact_report_schedules id*
List report schedules for a contact
get_contract id*
Get details of a specific contract
get_contract_active_signature_request id*
Get the active signature request for a contract
get_contract_assigned_campaigns id*
Get campaigns assigned to a contract
get_contract_document id*contract_id*
Get details of a specific contract document
get_contract_document_file_revision contract_id*document_id*revision_id*
Get a specific file revision for a contract document
get_contract_payment id*contract_id*
Get details of a specific contract payment
get_contract_template id*
Get details of a specific contract template
get_conversion_details_report zonespresettimezonecampaignspublishersadvertisers
Get conversion details report
get_creative id*
Get details of a specific image creative
get_custom_html_ad_item id*
Get details of a specific custom HTML ad item
get_custom_html_ad_item_conversion_tag id*
Get conversion tracking tag for a custom HTML ad item
get_custom_report id*
Get details of a specific report configuration
get_data_key id*
Get details of a specific data key
get_data_key_target id*
Get details of a specific data key target
get_data_list id*
Get details of a specific data list by ID
get_day_parting id*
Get details of a specific day parting rule
get_demand_endpoint id*
Get details of a specific demand endpoint by ID
get_demand_source id*
Get details of a specific demand source by ID
get_demand_source_report presettimezone
Get demand source statistics report
get_display_channel_forecast presettimezone
Get display channel forecast report
get_display_forecast presettimezone
Get display forecast report
get_display_platform_estimate presettimezone
Get display platform estimate statistics
get_display_report type*zonesperiod*presetdetailssummary +10
Get display advertising report with impressions, clicks, and CTR
get_email_zone id*
Get details of a specific email zone
get_email_zone_conversion_tag id*
Get the conversion tracking tag for an email zone
get_email_zone_tag id*
Get the ad serving tag for an email zone
get_event_logs tofromlog_type*
Get event logs for account activity (changes, logins, etc.)
get_event_log_upload_config id*
Get details of a specific event log upload configuration
get_event_log_upload_log id*
Get details of a specific event log upload log entry
get_geo_summary_report zonespresettimezonecampaignspublishersadvertisers
Get geographic summary report
get_geo_target id*
Get details of a specific geo target
get_image_ad_item id*
Get details of a specific image ad item
get_image_ad_item_conversion_tag id*
Get conversion tracking tag for an image ad item
get_kogan_dashboard_report tofromtype*period*portalpreset +10
Get the Kogan self-serve dashboard report, including overview and Value Catcher ad item stats. Kogan marketplace accounts only — requires the Kogan self-serve feature; other accoun…
get_kogan_product sku*seller_id*
Get a Kogan marketplace product by seller ID and SKU (title, brand, category, stock, offers, store URLs, images). Kogan marketplace accounts only — requires the Kogan self-serve fe…
get_kogan_report tofromtype*zonesperiod*portal +9
Get a Kogan marketplace advertising report (includes Value Catcher stats merged with display stats). Kogan marketplace accounts only — requires the Kogan self-serve feature; other…
get_list_target id*
Get details of a specific list target
get_live_website_preview urlzone_id
Get live website preview URL
get_manager id*
Get details of a specific manager by ID
get_manual_tracking_links typead_item_id
Generate manual tracking links for an ad item
get_media_group id*
Get details of a specific media group
get_native_ad_item id*
Get details of a specific native ad item
get_native_ad_item_conversion_tag id*
Get conversion tracking tag for a native ad item
get_native_template id*
Get details of a specific native template
get_ortb_native_data_asset id*template_id*
Get details of a specific data asset for an ORTB native template
get_ortb_native_image_asset id*template_id*
Get details of a specific image asset for an ORTB native template
get_ortb_native_template id*
Get details of a specific OpenRTB native template by ID
get_ortb_native_title_asset id*template_id*
Get details of a specific title asset for an ORTB native template
get_placement id*
Get details of a specific placement
get_placement_conversion_tag id*
Get conversion tracking tag for a placement
get_placement_forecast presettimezone
Get placement forecast report
get_platform_target id*
Get details of a specific platform target
get_pmp_deal id*
Get details of a specific PMP deal by ID
get_postal_code_target id*
Get details of a specific postal code target
get_product_catalog catalog_id*publisher_id*
Get details of a specific product catalog
get_product_catalog_item catalog_id*identifier*publisher_id*
Get details of a specific product catalog item
get_product_source source_id*publisher_id*
Get details of a specific product source
get_product_source_target publisher_id*source_target_id*
Get details of a specific product source target
get_publisher id*
Get details of a specific publisher
get_report_generated generated_id*report_config_id*
Get a specific generated report
get_report_schedule schedule_id*report_config_id*
Get a specific report schedule
get_report_schedule_generated schedule_id*generated_id*report_config_id*
Get a specific generated report from a schedule
get_rich_media_ad_item id*
Get details of a specific rich media ad item
get_rich_media_ad_item_conversion_tag id*
Get conversion tracking tag for a rich media ad item
get_rich_media_creative id*
Get details of a specific rich media creative
get_role id*
Get details of a specific role by ID
get_schedule id*
Get details of a specific schedule
get_sftp_connection id*
Get details of a specific SFTP connection by ID
get_signature_request id*contract_id*
Get details of a specific signature request
get_signature_request_recipient request_id*contract_id*recipient_id*
Get a specific recipient for a signature request
get_trusted_redirect_domain id*
Get details of a specific trusted redirect domain by ID
get_user user_id*user_db_id*
Get a single user from a user database
get_user_attribute id*user_db_id*
Get details of a specific user attribute in a user database
get_user_db id*
Get details of a specific user database by ID
get_vast_ad_item_conversion_tag id*
Get conversion tracking tag for a VAST ad item
get_vast_auction_placements_report presettimezone
Get VAST auction placements report
get_vast_campaign_conversion_tag id*
Get conversion tracking tag for a VAST campaign
get_vast_channel_forecast presettimezone
Get VAST channel forecast report
get_vast_custom_report id*
Get a specific VAST report
get_vast_forecast presettimezone
Get VAST forecast report
get_vast_geo_summary_report zonespresettimezonecampaignspublishersadvertisers
Get VAST geographic summary report
get_vast_placement_conversion_tag id*
Get conversion tracking tag for a VAST placement
get_vast_platform_estimate presettimezone
Get VAST platform estimate statistics
get_vast_report type*zonesperiod*presetdetailssummary +6
Get VAST video advertising report
get_vast_zone_conversion_tag id*
Get VAST zone conversion tracking tag
get_vast_zone_tags id*
Get VAST zone serving tags
get_video_creative id*
Get details of a specific video creative
get_zone id*
Get details of a specific standard zone
get_zone_conversion_tag id*
Get the conversion tracking tag for a standard zone
get_zone_ortb_native_ad id*zone_id*
Get details of a specific ORTB native ad for a standard zone
get_zone_tag id*
Get the ad serving tag (embed code) for a zone
list_ad_items limitoffset
List all ad items (banners) across all types (image, custom HTML, rich media, native, catalog)
list_advertisers limitoffset
List all advertisers in your AdButler account
list_all_campaigns limitoffset
List all campaigns across all types
list_all_creatives limitoffset
List all creatives across all types (image, rich media, video, audio)
list_all_generated_reports limitoffset
List all generated reports across all configurations
list_all_report_schedules limitoffset
List all report schedules across all configurations
list_all_zones limitoffset
List all zones across all types (standard, email, catalog)
list_archived_advertisers limitoffset
List all archived advertisers
list_archived_campaigns limitoffset
List all archived standard campaigns
list_archived_channels limitoffset
List all archived channels
list_archived_contracts limitoffset
List all archived contracts
list_archived_email_zones limitoffset
List all archived email zones
list_archived_publishers limitoffset
List all archived publishers
list_archived_zones limitoffset
List all archived standard zones
list_audiences limitoffsetuser_db_id*
List all audiences in a user database
list_audio_creatives limitoffset
List all audio creatives
list_beacon_signing_keys limitoffset
List all beacon signing keys in your AdButler account
list_bidders limitoffset
List all bidders in your AdButler account
list_campaign_assignments limitoffset
List all campaign assignments (ad items assigned to campaigns)
list_campaigns limitoffset
List all standard campaigns
list_catalog_ad_items limitoffset
List all catalog ad items
list_catalog_zones limitoffset
List all catalog zones (for product/retail ad serving)
list_channels limitoffset
List all channels
list_channel_zone_assignments limitoffset
List all channel zone assignments
list_contacts limitoffset
List all contacts in your AdButler account
list_contract_document_file_revisions contract_id*document_id*
List file revisions for a contract document
list_contract_documents limitoffsetcontract_id*
List all documents for a contract
list_contract_payments limitoffsetcontract_id*
List all payments for a contract
list_contracts limitoffset
List all contracts
list_contract_templates limitoffset
List all contract templates
list_creatives limitoffset
List all image creatives
list_custom_html_ad_items limitoffset
List all custom HTML ad items
list_custom_reports limitoffset
List all saved report configurations
list_data_keys limitoffset
List all data keys (custom key-value targeting variables)
list_data_key_targets limitoffset
List all data key targets (targeting rules using data key values)
list_data_lists limitoffset
List all data lists in your AdButler account
list_data_targets limitoffset
List all data targets
list_day_partings limitoffset
List all day parting rules (time-of-day targeting)
list_demand_endpoints limitoffset
List all demand endpoints in your AdButler account
list_demand_sources limitoffset
List all demand sources in your AdButler account
list_email_zones limitoffset
List all email zones
list_event_log_upload_configs limitoffset
List all event log upload configurations
list_event_log_upload_logs limitoffset
List all event log upload logs
list_geo_targets limitoffset
List all geo targets (geographic targeting rules)
list_image_ad_items limitoffset
List all image ad items
list_list_targets limitoffset
List all list targets (allowlist/blocklist targeting)
list_managers limitoffset
List all managers in your AdButler account
list_media_groups limitoffset
List all media groups (collections of creatives)
list_native_ad_items limitoffset
List all native ad items
list_native_templates limitoffset
List all native ad templates
list_ortb_native_data_assets limitoffsettemplate_id*
List all data assets for an ORTB native template
list_ortb_native_image_assets limitoffsettemplate_id*
List all image assets for an ORTB native template
list_ortb_native_templates limitoffset
List all OpenRTB native templates in your AdButler account
list_ortb_native_title_assets limitoffsettemplate_id*
List all title assets for an ORTB native template
list_placements limitoffset
List all placements (assignments of ad items to zones)
list_platform_targets limitoffset
List all platform targets (device/OS/browser targeting)
list_pmp_deals limitoffset
List all PMP deals in your AdButler account
list_postal_code_targets limitoffset
List all postal code targets
list_product_catalogs limitoffsetpublisher_id*
List all product catalogs for a publisher
list_product_sources limitoffsetpublisher_id*
List all product sources for a publisher
list_product_source_targets limitoffsetpublisher_id*
List all product source targets for a publisher
list_publishers limitoffset
List all publishers in your AdButler account
list_report_generated limitoffsetreport_config_id*
List generated reports for a specific report configuration
list_report_schedule_generated limitoffsetschedule_id*report_config_id*
List generated reports for a specific schedule
list_report_schedules limitoffsetreport_config_id*
List schedules for a specific report configuration
list_rich_media_ad_items limitoffset
List all rich media ad items
list_rich_media_creatives limitoffset
List all rich media creatives
list_roles limitoffset
List all roles in your AdButler account
list_schedules limitoffset
List all schedules (time-based delivery rules for ad items)
list_sftp_connections limitoffset
List all SFTP connections in your AdButler account
list_signature_request_recipients request_id*contract_id*
List all recipients for a signature request
list_signature_requests limitoffsetcontract_id*
List all signature requests for a contract
list_trusted_redirect_domains limitoffset
List all trusted redirect domains in your AdButler account
list_user_attributes limitoffsetuser_db_id*
List all user attributes in a user database
list_user_dbs limitoffset
List all user databases in your AdButler account
list_vast_custom_reports limitoffset
List all VAST report data
list_video_creatives limitoffset
List all video creatives
list_zone_ortb_native_ads limitoffsetzone_id*
List all ORTB native ads for a standard zone
list_zones limitoffset
List all standard zones
remove_list_target_usages id*
Remove all usages of a list target
remove_user_list_attribute_values valuesuser_id*user_db_id*list_attribute_name*
Remove values from a list attribute for a user
replace_audio_creative_file id*
Replace the file on an audio creative
replace_contract_document_file contract_id*document_id*
Replace the file on a contract document
replace_contract_document_file_from_template contract_id*document_id*
Replace a contract document file from a template
replace_image_creative_file id*
Replace the file on an image creative
replace_rich_media_creative_file id*
Replace the file on a rich media creative
replace_video_creative_file id*
Replace the file on a video creative
resend_signature_request request_id*contract_id*
Resend a signature request
resend_verification_code email*
Resend the email verification code for a trial account. Use this if the user did not receive the code or it expired.
revoke_report_schedule_historical_access schedule_id*report_config_id*
Revoke historical access for a report schedule
search_adbutler_api limitquery*
Find AdButler API endpoints by keyword when no specific tool matches what you need. Returns matching endpoints with their HTTP method, path, and a brief summary. Use this when the…
search_product_catalog_items querycatalog_id*publisher_id*
Search for items in a product catalog
serve_ad ID*ipkwrfshsw +10
Request ad delivery for a zone. Returns the ad(s) that would be served, useful for verifying ad setup. Uses POST /adserve.
setup_api_key api_key*
Configure AdButler with an existing API key. Use this if the user already has an AdButler account and API key. Note: this configures the key for the current session only. For a per…
sync_kogan_stats data*meta*
Push externally-tracked Kogan stats (impressions, clicks, conversions, quantity sold, sales) into AdButler for a set of ad items over a time window. Kogan marketplace accounts only…
test_sftp_connection hostpathportpasswordusername
Test an SFTP connection with the provided credentials
unarchive_advertiser id*
Restore an archived advertiser back to active status
unarchive_campaign id*
Restore an archived standard campaign back to active status
unarchive_channel id*
Restore an archived channel back to active status
unarchive_contract id*
Unarchive a contract (restore from archive)
unarchive_email_zone id*
Restore an archived email zone back to active status
unarchive_publisher id*
Restore an archived publisher back to active status
unarchive_zone id*
Restore an archived standard zone back to active status
update_advertiser id*nameemailmetadatapasswordcan_add_ad_items +1
Update an existing advertiser
update_audience id*nameattributesuser_db_id*
Update an existing audience in a user database
update_audio_creative id*namedescription
Update an existing audio creative
update_beacon_signing_key id*key_name
Update an existing beacon signing key
update_bidder id*namestatusbid_url
Update an existing bidder
update_campaign id*namebudgetcontractmetadataadvertiser +4
Update an existing standard campaign
update_campaign_assignment id*activeweightkeywordsschedulegeo_target +4
Update an existing campaign assignment
update_catalog_ad_item id*namelocationmetadatatracking_pixeltracking_pixels +1
Update an existing catalog ad item
update_catalog_zone id*nameauction_typebid_floor_cpcbid_floor_cpmadvertiser_cost_type +2
Update an existing catalog zone
update_channel id*namepriority
Update an existing channel
update_contact id*nameemailnotes
Update an existing contact
update_contract id*namerateend_atstatusstart_at +3
Update an existing contract
update_contract_document id*namecontract_id*
Update an existing contract document
update_contract_template id*name
Update an existing contract template
update_creative id*namedescription
Update an existing image creative
update_custom_html_ad_item id*namewidthheightlocationmetadata +7
Update an existing custom HTML ad item
update_custom_report id*datenametypeperiodcolumns +5
Update an existing report configuration
update_data_key id*nametype
Update an existing data key
update_data_key_target id*nametarget
Update an existing data key target
update_data_list id*label
Update an existing data list
update_day_parting id*namerangesis_templateuse_member_timezone
Update an existing day parting rule
update_demand_endpoint id*namestatusprioritybid_floorgeo_target +10
Update an existing demand endpoint
update_demand_source id*namestatusspend_limitspend_limit_endspend_limit_start +1
Update an existing demand source
update_email_zone id*namewidthheightmetadatapublisher +3
Update an existing email zone
update_event_log_upload_config id*nameformatenabledfrequencyconnection_id
Update an existing event log upload configuration
update_geo_target id*nameunitareasrangeinclusive
Update an existing geo target
update_image_ad_item id*namewidthheightcreativelocation +8
Update an existing image ad item
update_kogan_product_category sku*category*seller_id*category_slug*
Update the category and category slug of a Kogan marketplace product. Kogan marketplace accounts only — requires the Kogan self-serve feature; other accounts receive a feature-not-…
update_list_target id*labeldata_listinclusive
Update an existing list target
update_manager id*nameemailnotespasswordposition +19
Update an existing manager
update_media_group id*name
Update an existing media group
update_native_ad_item id*namelocationmetadatatemplatevariables +3
Update an existing native ad item
update_native_template id*nameraw_htmlvariables
Update an existing native template. Variables uses add/remove format for updates.
update_ortb_native_data_asset id*lentypetemplate_id*
Update an existing data asset for an ORTB native template
update_ortb_native_image_asset hwid*hmintypewmin +1
Update an existing image asset for an ORTB native template
update_ortb_native_template id*namehtml_template
Update an existing OpenRTB native template
update_ortb_native_title_asset id*lentemplate_id*
Update an existing title asset for an ORTB native template
update_placement id*costzoneactivepayoutweight +13
Update an existing placement
update_platform_target id*nameplatformdevice_targets
Update an existing platform target
update_pmp_deal id*namebid_floorgeo_targetaudience_targetwhitelist_seats
Update an existing PMP deal
update_postal_code_target id*labelinclusivelocations
Update an existing postal code target
update_product_catalog namecatalog_id*publisher_id*
Update an existing product catalog
update_product_catalog_item urlnamepricecategoryimage_urlcatalog_id* +3
Update an existing product catalog item
update_product_source urlnametypesource_id*publisher_id*
Update an existing product source
update_product_source_target namesource_idpublisher_id*source_target_id*
Update an existing product source target
update_publisher id*nameemaildomainmetadatatimezone +6
Update an existing publisher
update_report_schedule frequencyrecipientsschedule_id*report_config_id*
Update a report schedule
update_rich_media_ad_item id*namecreativelocationmetadatatracking_pixel +5
Update an existing rich media ad item
update_rich_media_creative id*namedescription
Update an existing rich media creative
update_role id*nameis_default_rolecan_manage_linkscan_manage_mediacan_manage_users +15
Update an existing role
update_schedule id*end_atend_datestart_atquota_typestart_date +10
Update an existing schedule
update_sftp_connection id*hostnamepathportpassword +1
Update an existing SFTP connection
update_signature_request id*contract_id*
Update an existing signature request
update_signature_request_recipient nameemailrequest_id*contract_id*recipient_id*
Update a recipient for a signature request
update_trusted_redirect_domain id*domain
Update an existing trusted redirect domain
update_user_attribute id*typelabeluser_db_id*
Update an existing user attribute in a user database
update_video_creative id*namedescription
Update an existing video creative
update_zone id*namewidthheightmetadatabid_floor +21
Update an existing standard zone
update_zone_ortb_native_ad id*namezone_id*template_id
Update an existing ORTB native ad for a standard zone
validate_beacon_signing_key key
Validate a beacon signing key
vast42_create_ad name*activelocation
Create a VAST 4.2 ad item
vast42_create_campaign_assignment activead_itemcampaign
Create a VAST 4.2 campaign assignment
vast42_create_closed_caption_file namelanguage
Create a VAST 4.2 closed caption file
vast42_create_companion name*widthheight
Create a VAST 4.2 companion
vast42_create_creative namedescription
Create a VAST 4.2 creative
vast42_create_icon namewidthheight
Create a VAST 4.2 icon
vast42_create_icon_click_fallback_image namewidthheight
Create a VAST 4.2 icon click fallback image
vast42_create_interactive_creative_file namemime_type
Create a VAST 4.2 interactive creative file
vast42_create_linear name*bitratedurationmime_type
Create a VAST 4.2 linear media
vast42_create_media_file namewidthheightbitratemime_type
Create a VAST 4.2 media file
vast42_create_mezzanine namemime_type
Create a VAST 4.2 mezzanine
vast42_create_non_linear name*widthheightmime_type
Create a VAST 4.2 non-linear media
vast42_create_placement zoneactivechannelpriorityscheduleadvertisement*
Create a VAST 4.2 placement
vast42_create_resource nametype
Create a VAST 4.2 resource
vast42_create_universal_ad_id nameid_valueid_registry
Create a VAST 4.2 universal ad ID
vast42_delete_ad id*
Delete a VAST 4.2 ad item
vast42_delete_campaign_assignment id*
Delete a VAST 4.2 campaign assignment
vast42_delete_closed_caption_file id*
Delete a VAST 4.2 closed caption file
vast42_delete_companion id*
Delete a VAST 4.2 companion
vast42_delete_creative id*
Delete a VAST 4.2 creative
vast42_delete_icon id*
Delete a VAST 4.2 icon
vast42_delete_icon_click_fallback_image id*
Delete a VAST 4.2 icon click fallback image
vast42_delete_interactive_creative_file id*
Delete a VAST 4.2 interactive creative file
vast42_delete_linear id*
Delete a VAST 4.2 linear media
vast42_delete_media_file id*
Delete a VAST 4.2 media file
vast42_delete_mezzanine id*
Delete a VAST 4.2 mezzanine
vast42_delete_non_linear id*
Delete a VAST 4.2 non-linear media
vast42_delete_placement id*
Delete a VAST 4.2 placement
vast42_delete_resource id*
Delete a VAST 4.2 resource
vast42_delete_universal_ad_id id*
Delete a VAST 4.2 universal ad ID
vast42_get_ad id*
Get a single VAST 4.2 ad item
vast42_get_campaign_assignment id*
Get a single VAST 4.2 campaign assignment
vast42_get_closed_caption_file id*
Get a single VAST 4.2 closed caption file
vast42_get_companion id*
Get a single VAST 4.2 companion
vast42_get_creative id*
Get a single VAST 4.2 creative
vast42_get_icon id*
Get a single VAST 4.2 icon
vast42_get_icon_click_fallback_image id*
Get a single VAST 4.2 icon click fallback image
vast42_get_interactive_creative_file id*
Get a single VAST 4.2 interactive creative file
vast42_get_linear id*
Get a single VAST 4.2 linear media
vast42_get_media_file id*
Get a single VAST 4.2 media file
vast42_get_mezzanine id*
Get a single VAST 4.2 mezzanine
vast42_get_non_linear id*
Get a single VAST 4.2 non-linear media
vast42_get_placement id*
Get a single VAST 4.2 placement
vast42_get_resource id*
Get a single VAST 4.2 resource
vast42_get_universal_ad_id id*
Get a single VAST 4.2 universal ad ID
vast42_list_ads limitoffset
List all VAST 4.2 ad items
vast42_list_campaign_assignments limitoffset
List all VAST 4.2 campaign assignments
vast42_list_closed_caption_files limitoffset
List all VAST 4.2 closed caption files
vast42_list_companions limitoffset
List all VAST 4.2 companions
vast42_list_creatives limitoffset
List all VAST 4.2 creatives
vast42_list_icon_click_fallback_images limitoffset
List all VAST 4.2 icon click fallback images
vast42_list_icons limitoffset
List all VAST 4.2 icons
vast42_list_interactive_creative_files limitoffset
List all VAST 4.2 interactive creative files
vast42_list_linears limitoffset
List all VAST 4.2 linear media
vast42_list_media_files limitoffset
List all VAST 4.2 media files
vast42_list_mezzanines limitoffset
List all VAST 4.2 mezzanines
vast42_list_non_linears limitoffset
List all VAST 4.2 non-linear media
vast42_list_placements limitoffset
List all VAST 4.2 placements
vast42_list_resources limitoffset
List all VAST 4.2 resources
vast42_list_universal_ad_ids limitoffset
List all VAST 4.2 universal ad IDs
vast42_update_ad id*nameactivelocation
Update a VAST 4.2 ad item
vast42_update_campaign_assignment id*activead_itemcampaign
Update a VAST 4.2 campaign assignment
vast42_update_closed_caption_file id*namelanguage
Update a VAST 4.2 closed caption file
vast42_update_companion id*namewidthheight
Update a VAST 4.2 companion
vast42_update_creative id*namedescription
Update a VAST 4.2 creative
vast42_update_icon id*namewidthheight
Update a VAST 4.2 icon
vast42_update_icon_click_fallback_image id*namewidthheight
Update a VAST 4.2 icon click fallback image
vast42_update_interactive_creative_file id*namemime_type
Update a VAST 4.2 interactive creative file
vast42_update_linear id*namebitratedurationmime_type
Update a VAST 4.2 linear media
vast42_update_media_file id*namewidthheightbitratemime_type
Update a VAST 4.2 media file
vast42_update_mezzanine id*namemime_type
Update a VAST 4.2 mezzanine
vast42_update_non_linear id*namewidthheightmime_type
Update a VAST 4.2 non-linear media
vast42_update_placement id*zoneactivechannelpriorityschedule +1
Update a VAST 4.2 placement
vast42_update_resource id*nametype
Update a VAST 4.2 resource
vast42_update_universal_ad_id id*nameid_valueid_registry
Update a VAST 4.2 universal ad ID
vast_archive_campaign id*
Archive a VAST campaign (soft-delete, can be restored later)
vast_archive_channel id*
Archive a VAST channel (soft-delete, can be restored later)
vast_archive_zone id*
Archive a VAST zone (soft-delete, can be restored later)
vast_create_ad_item name*activelocation*
Create a new VAST ad item
vast_create_campaign name*contractadvertiser*
Create a new VAST campaign
vast_create_campaign_assignment activead_item*campaign*
Create a VAST campaign assignment (assign an ad item to a campaign)
vast_create_channel name*description
Create a new VAST channel
vast_create_channel_zone_assignment zone*channel*
Assign a VAST zone to a VAST channel
vast_create_companion name*widthheight
Create a new VAST companion
vast_create_linear_media name*bitratedurationmime_type
Create a new VAST linear media
vast_create_non_linear_media name*widthheightmime_type
Create a new VAST non-linear media
vast_create_placement costzoneactivepayoutchannelpriority +7
Create a new VAST placement (assign a VAST ad item or campaign to a VAST zone or channel)
vast_create_schedule end_dategeo_targetquota_typestart_dateday_parting_idquota_lifetime +1
Create a new VAST schedule for time-based ad delivery
vast_create_tracking urlname*event
Create a new VAST tracking entry
vast_create_zone name*metadatapublisher*default_vast_ad_itemserve_priority_orderdefault_vast_campaign
Create a new VAST zone
vast_delete_ad_item id*
Delete a VAST ad item
vast_delete_archived_campaign id*
Permanently delete an archived VAST campaign
vast_delete_archived_channel id*
Permanently delete an archived VAST channel
vast_delete_archived_zone id*
Permanently delete an archived VAST zone
vast_delete_campaign id*
Delete a VAST campaign
vast_delete_campaign_assignment id*
Delete a VAST campaign assignment
vast_delete_channel id*
Delete a VAST channel
vast_delete_channel_zone_assignment id*
Remove a VAST zone from a VAST channel
vast_delete_companion id*
Delete a VAST companion
vast_delete_linear_media id*
Delete a VAST linear media
vast_delete_non_linear_media id*
Delete a VAST non-linear media
vast_delete_placement id*
Delete a VAST placement
vast_delete_schedule id*
Delete a VAST schedule
vast_delete_tracking id*
Delete a VAST tracking entry
vast_delete_zone id*
Delete a VAST zone
vast_get_ad_item id*
Get details of a specific VAST ad item
vast_get_archived_campaign id*
Get details of a specific archived VAST campaign
vast_get_archived_channel id*
Get details of a specific archived VAST channel
vast_get_archived_zone id*
Get details of a specific archived VAST zone
vast_get_campaign id*
Get details of a specific VAST campaign
vast_get_campaign_assignment id*
Get details of a specific VAST campaign assignment
vast_get_channel id*
Get details of a specific VAST channel
vast_get_channel_zone_assignment id*
Get details of a specific VAST channel zone assignment
vast_get_companion id*
Get details of a specific VAST companion
vast_get_linear_media id*
Get details of a specific VAST linear media
vast_get_non_linear_media id*
Get details of a specific VAST non-linear media
vast_get_placement id*
Get details of a specific VAST placement
vast_get_schedule id*
Get details of a specific VAST schedule
vast_get_tracking id*
Get details of a specific VAST tracking entry
vast_get_zone id*
Get details of a specific VAST zone
vast_list_ad_items limitoffset
List all VAST ad items
vast_list_archived_campaigns limitoffset
List all archived VAST campaigns
vast_list_archived_channels limitoffset
List all archived VAST channels
vast_list_archived_zones limitoffset
List all archived VAST zones
vast_list_campaign_assignments limitoffset
List all VAST campaign assignments
vast_list_campaigns limitoffset
List all VAST campaigns
vast_list_channels limitoffset
List all VAST channels
vast_list_channel_zone_assignments limitoffset
List all VAST channel zone assignments
vast_list_companions limitoffset
List all VAST companions
vast_list_linear_media limitoffset
List all VAST linear media
vast_list_media limitoffset
List all VAST media (linear and non-linear)
vast_list_non_linear_media limitoffset
List all VAST non-linear media
vast_list_placements limitoffset
List all VAST placements (assignments of VAST ad items to VAST zones)
vast_list_schedules limitoffset
List all VAST schedules
vast_list_tracking limitoffset
List all VAST tracking entries
vast_list_zones limitoffset
List all VAST zones
vast_unarchive_campaign id*
Restore an archived VAST campaign back to active status
vast_unarchive_channel id*
Restore an archived VAST channel back to active status
vast_unarchive_zone id*
Restore an archived VAST zone back to active status
vast_update_ad_item id*nameactivelocation
Update an existing VAST ad item
vast_update_campaign id*namecontractadvertiser
Update an existing VAST campaign
vast_update_campaign_assignment id*activead_itemcampaign
Update a VAST campaign assignment
vast_update_channel id*namedescription
Update an existing VAST channel
vast_update_channel_zone_assignment id*zonechannel
Update a VAST channel zone assignment
vast_update_companion id*namewidthheight
Update an existing VAST companion
vast_update_linear_media id*namebitratedurationmime_type
Update an existing VAST linear media
vast_update_non_linear_media id*namewidthheightmime_type
Update an existing VAST non-linear media
vast_update_placement id*costzoneactivepayoutchannel +8
Update an existing VAST placement
vast_update_schedule id*end_dategeo_targetquota_typestart_dateday_parting_id +2
Update an existing VAST schedule
vast_update_tracking id*urlnameevent
Update an existing VAST tracking entry
vast_update_zone id*namemetadatapublisherdefault_vast_ad_itemserve_priority_order +1
Update an existing VAST zone
verify_trial_email email*verification_code*
Verify a trial account email with the verification code sent to the user. Call this after create_trial_account. The user must provide the code from their email. On success, the API…