Google Search Console integration for Model Context Protocol (MCP)
Nothing to run from here
AdButler is installed from its publisher's own source and answers where it runs, so this marketplace is not in the path of a single call. There is no address here to send one to, and a panel that pretended otherwise would be showing you an answer we made up. Install it and call it from your own client — the Installation tab has the entry for each one.
500
tools declared
—
trust score
remote
at its publisher
—
calls last 7d
What it does
Manage AdButler campaigns, zones, ad items, VAST, and reports from Claude, ChatGPT, and Cursor.
Quickstart
# 1 — add it to Claude Code
claude mcp add --scope user --transport http mcp-adbutler-com-adbutler-mcp https://mcp.adbutler.com/mcp
# 2 — ask your agent for something these tools do
# list_advertisers, get_advertiser, create_advertiser and 497 more
AdButler costs nothing on mcprush: there is no plan to choose here, no cap to set and nothing mcprush can bill you for.
Publishernot claimed
MAAll 1 server
mcp.adbutler.com1 server
1 category
Collected from a public index. Nobody has claimed this account, so nothing here was written by its author — claim it if it is yours.
Installation
Where are you running it?
Every route below installs the same thing and ends at the same approval screen. Nothing here runs on your machine and nothing runs on ours: this server answers at its publisher’s own address, and what you install is the connection straight to it.
Claude Codedeclared by this listing
This is a public server: it answers at its publisher’s own address and this marketplace is not in the path. Claude Code registers it in one command; --scope user makes it available in every project. The transport below is http, read from the address; if the publisher says otherwise, swap that one word.
claude mcp add --scope user --transport http mcp-adbutler-com-adbutler-mcp https://mcp.adbutler.com/mcpReconnect, or start a new session, and the tools appear in the model’s tool list.
Free on mcprush, and it answers at its publisher’s own address: this marketplace is not in the path, so there is no key of ours to hold and no card to add.
What it writes
One config entry pointing straight at the publisher’s own address — this marketplace is not in the path, and nothing from this listing executes on your machine.
What you approve
500 tools, with what each one reads, writes and reaches shown before you agree — the same list on every route above. Read the tool surface.
Tool surface
What the model actually sees. Descriptions are diffed on every release — see version history.
List all advertisers in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific advertiser by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Advertiser ID |
Create a new advertiser
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Advertiser name |
| string | no | Contact email | |
| can_change_password | boolean | no | Whether advertiser can change password |
| can_add_ad_items | boolean | no | Whether advertiser can submit advertisements for scheduling |
| metadata | object | no | Custom metadata key-value pairs |
| password | string | no | Password for advertiser portal (min 8 chars, must include upper, lower, number) |
Update an existing advertiser
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Advertiser ID |
| name | string | no | Advertiser name |
| string | no | Contact email | |
| can_change_password | boolean | no | Whether advertiser can change password |
| can_add_ad_items | boolean | no | Whether advertiser can submit advertisements for scheduling |
| metadata | object | no | Custom metadata key-value pairs |
| password | string | no | Password for advertiser portal (min 8 chars, must include upper, lower, number) |
Delete an advertiser
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Advertiser ID |
Archive an advertiser (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Advertiser ID |
List all archived advertisers
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived advertiser
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived advertiser ID |
Restore an archived advertiser back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived advertiser ID |
List all campaigns across all types
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
List all standard campaigns
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign ID |
Create a new standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Campaign name |
| advertiser | number | no | Advertiser ID |
| contract | number | no | Contract ID (requires Contract Management add-on) |
| roadblock_tags | string | no | Tag to link campaign to a roadblock |
| targeting_source | string | no | Whether targeting is set at campaign or ad item level |
| scheduling_source | string | no | Whether scheduling is set at campaign or ad item level |
| metadata | object | no | Custom metadata key-value pairs |
| budget | object | no | Budget limits (daily/weekly/monthly/lifetime) |
| trusted_redirect_domains | array | no | Array of trusted redirect domains |
Update an existing standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign ID |
| name | string | no | Campaign name |
| advertiser | number | no | Advertiser ID |
| contract | number | no | Contract ID |
| roadblock_tags | string | no | Roadblock tag |
| targeting_source | string | no | Targeting level |
| scheduling_source | string | no | Scheduling level |
| metadata | object | no | Custom metadata key-value pairs |
| budget | object | no | Budget limits |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Delete a standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign ID |
Archive a standard campaign (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign ID |
List all archived standard campaigns
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived campaign ID |
Permanently delete an archived standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived campaign ID |
Restore an archived standard campaign back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived campaign ID |
Get conversion tag for a campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign ID |
Get eligible zones for a campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign ID |
Bulk create catalog ad items in a campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_id | number | yes | Campaign ID |
| items | array | yes | Array of catalog ad item objects to create |
Bulk delete catalog ad items from a campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_id | number | yes | Campaign ID |
| items | array | yes | Array of catalog ad item IDs to delete |
List all campaign assignments (ad items assigned to campaigns)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign assignment ID |
Create a new campaign assignment (assign an ad item to a campaign)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| advertisement | object | yes | Advertisement object with id and type |
| campaign | object | yes | Campaign object with id and type |
| active | boolean | no | Whether assignment is active (defaults to true) |
| weight | number | no | Relative delivery weight (defaults to 1) |
| schedule | number | no | Schedule ID (only if campaign scheduling_source is "AD_ITEM") |
| geo_target | number | no | Geo Target ID (only if campaign targeting_source is "AD_ITEM") |
| platform_target | number | no | Platform Target ID |
| keywords | string | no | Comma-separated keywords for targeting |
| keywords_match_method | string | no | Keyword matching method |
| data_key_target | number | no | Data Key Target ID |
| list_target | number | no | List Target ID |
Update an existing campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign assignment ID |
| active | boolean | no | Whether assignment is active |
| weight | number | no | Relative delivery weight |
| schedule | number | no | Schedule ID |
| geo_target | number | no | Geo Target ID |
| platform_target | number | no | Platform Target ID |
| keywords | string | no | Comma-separated keywords |
| keywords_match_method | string | no | Keyword matching method |
| data_key_target | number | no | Data Key Target ID |
| list_target | number | no | List Target ID |
Delete a campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Campaign assignment ID |
List all channels
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Channel ID |
Create a new channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Channel name |
| priority | string | no | Serving priority (default: standard) |
| use_share_of_voice | boolean | no | Whether to use share of voice as serving strategy (false = use weight) |
Update an existing channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Channel ID |
| name | string | no | Channel name |
| priority | string | no | Serving priority |
Delete a channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Channel ID |
Archive a channel (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Channel ID |
List all archived channels
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived channel ID |
Permanently delete an archived channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived channel ID |
Restore an archived channel back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived channel ID |
List all channel zone assignments
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific channel zone assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Channel zone assignment ID |
Assign a zone to a channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| channel | number | yes | Channel ID |
| zone | object | yes | Zone object with id and type |
Remove a zone from a channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Channel zone assignment ID |
List all zones across all types (standard, email, catalog)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
List all standard zones
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific standard zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Zone 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.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Zone name |
| publisher | number | no | Publisher ID |
| width | number | no | Zone width in pixels (must be 0 if dimensions is "dynamic") |
| height | number | no | Zone height in pixels (must be 0 if dimensions is "dynamic") |
| dimensions | string | no | Zone dimensions type: "fixed" (default) or "dynamic" |
| use_share_of_voice | boolean | no | Use "share of voice" as serving strategy |
| refresh_frequency | number | no | Interval in seconds for serving new ads |
| refresh_limit | number | no | Total times zone will refresh |
| responsive | string | no | Size behavior |
| unique_delivery | boolean | no | Serve unique ads on each zone |
| iab_categories | array | no | IAB category descriptors |
| allow_demand_sources | boolean | no | Allow requests to demand endpoints |
| bid_floor | number | no | Default bid floor for programmatic |
| min_payout | number | no | Minimum payout per impression (CPM) |
| serve_priority_order | string | no | Priority order: "weight" or "auction" |
| pmp_deals | array | no | Allowed PMP Deal IDs |
| private_auction | boolean | no | Whether auction ignores non-deal bids |
| optimization_strategy | string | no | Zone optimization strategy |
| burn_in_impressions | number | no | Impressions before eCPM confidence |
| burn_in_hours | number | no | Hours before eCPM confidence |
Update an existing standard zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Zone ID |
| name | string | no | Zone name |
| publisher | number | no | Publisher ID |
| width | number | no | Zone width in pixels |
| height | number | no | Zone height in pixels |
| dimensions | string | no | Zone dimensions type |
| refresh_frequency | number | no | Interval in seconds for serving new ads |
| refresh_limit | number | no | Total times zone will refresh |
| responsive | string | no | Size behavior |
| unique_delivery | boolean | no | Serve unique ads on each zone |
| iab_categories | array | no | IAB category descriptors |
| allow_demand_sources | boolean | no | Allow requests to demand endpoints |
| bid_floor | number | no | Default bid floor |
| min_payout | number | no | Minimum payout per impression (CPM) |
| serve_priority_order | string | no | Priority order |
| pmp_deals | array | no | Allowed PMP Deal IDs |
| private_auction | boolean | no | Ignore non-deal bids in auction |
| optimization_strategy | string | no | Zone optimization strategy |
| burn_in_impressions | number | no | Impressions before eCPM confidence |
| burn_in_hours | number | no | Hours before eCPM confidence |
Delete a standard zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Zone ID |
Get the ad serving tag (embed code) for a zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Zone ID |
Get the conversion tracking tag for a standard zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Zone ID |
Generate ad serving tags for multiple zones at once
| Parameter | Type | Required | Notes |
|---|---|---|---|
| zone_ids | array | yes | Array of zone IDs to generate tags for |
Archive a standard zone (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Zone ID |
List all archived standard zones
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived standard zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived zone ID |
Restore an archived standard zone back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived zone ID |
List all email zones
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific email zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Email zone ID |
Create a new email zone for serving ads in email newsletters
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Zone name |
| width | number | yes | Zone width in pixels |
| height | number | yes | Zone height in pixels |
| publisher | number | no | Publisher ID |
| metadata | object | no | Custom metadata key-value pairs |
| uid_rotate | boolean | no | Serve different ads per user |
| rotate_timer | object | no | Period after which user sees a new ad |
| auction_tie_break | string | no | Tie-breaking method for auctions |
Update an existing email zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Email zone ID |
| name | string | no | Zone name |
| width | number | no | Zone width in pixels |
| height | number | no | Zone height in pixels |
| publisher | number | no | Publisher ID |
| metadata | object | no | Custom metadata key-value pairs |
| uid_rotate | boolean | no | Serve different ads per user |
| rotate_timer | object | no | Period after which user sees a new ad |
| auction_tie_break | string | no | Tie-breaking method |
Delete an email zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Email zone ID |
Get the ad serving tag for an email zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Email zone ID |
Get the conversion tracking tag for an email zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Email zone ID |
Archive an email zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Email zone ID |
List all archived email zones
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived email zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived email zone ID |
Restore an archived email zone back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived email zone ID |
List all catalog zones (for product/retail ad serving)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific catalog zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Catalog zone ID |
Create a new catalog zone for product/retail ad serving
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Zone name |
| catalog_id | number | yes | Catalog ID |
| publisher | number | no | Publisher ID |
| bid_floor | number | no | Default bid floor |
| bid_floor_cpm | number | no | CPM bid floor |
| bid_floor_cpc | number | no | CPC bid floor |
| advertiser_cost_type | string | no | Billing model |
| auction_type | string | no | Auction type |
| click_cooldown_period | number | no | Click cooldown period in seconds (1-86400) |
| conversion_lookback_period | number | no | Conversion lookback period in seconds (1-7776000) |
Update an existing catalog zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Catalog zone ID |
| name | string | no | Zone name |
| bid_floor_cpm | number | no | CPM bid floor |
| bid_floor_cpc | number | no | CPC bid floor |
| advertiser_cost_type | string | no | Billing model |
| auction_type | string | no | Auction type |
| click_cooldown_period | number | no | Click cooldown period in seconds |
| conversion_lookback_period | number | no | Conversion lookback period in seconds |
Delete a catalog zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Catalog zone ID |
Get the ad serving tag for a catalog zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Catalog zone ID |
List all publishers in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Publisher ID |
Create a new publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Publisher name |
| timezone | string | no | Timezone (e.g., "America/New_York") |
| string | no | Contact email (allows publisher to log in) | |
| can_change_password | boolean | no | Whether publisher can change password |
| can_admin_account | boolean | no | Grant administrator privileges |
| can_approve_ads | boolean | no | Allow publisher to approve/deny ad items |
| can_view_wordpress_key | boolean | no | Allow publisher to view WordPress key |
| domain | string | no | Publisher domain (top-level domains only) |
| seller_type | string | no | Seller type for ads.txt |
| default_payout | object | no | Default payout configuration |
| metadata | object | no | Custom metadata key-value pairs |
Update an existing publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Publisher ID |
| name | string | no | Publisher name |
| timezone | string | no | Timezone |
| string | no | Contact email | |
| can_change_password | boolean | no | Whether publisher can change password |
| can_admin_account | boolean | no | Grant administrator privileges |
| can_approve_ads | boolean | no | Allow publisher to approve/deny ad items |
| can_view_wordpress_key | boolean | no | Allow publisher to view WordPress key |
| domain | string | no | Publisher domain |
| seller_type | string | no | Seller type |
| default_payout | object | no | Default payout configuration |
| metadata | object | no | Custom metadata key-value pairs |
Delete a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Publisher ID |
Archive a publisher (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Publisher ID |
List all archived publishers
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived publisher ID |
Restore an archived publisher back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived publisher ID |
List all ad items (banners) across all types (image, custom HTML, rich media, native, catalog)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
List all image ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Create a new image ad item (banner)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Ad item name |
| creative | number | no | Image creative ID (mutually exclusive with creative_url) |
| creative_url | string | no | URL to image file — PNG, JPEG, or GIF (mutually exclusive with creative) |
| location | string | no | Click-through URL |
| width | number | no | Ad width in pixels (defaults to 0) |
| height | number | no | Ad height in pixels (defaults to 0) |
| html_alt_text | string | no | Alt text for the image |
| html_target | string | no | Window/frame for destination URL (e.g. "_blank") |
| html_content_below | string | no | HTML content below the ad item |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Update an existing image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
| name | string | no | Ad item name |
| creative | number | no | Image creative ID |
| creative_url | string | no | URL to image file |
| location | string | no | Click-through URL |
| width | number | no | Ad width in pixels |
| height | number | no | Ad height in pixels |
| html_alt_text | string | no | Alt text for the image |
| html_target | string | no | Window/frame for destination URL |
| html_content_below | string | no | HTML content below the ad item |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Delete an image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Get conversion tracking tag for an image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
List all custom HTML ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Create a new custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Ad item name |
| custom_html | string | yes | The HTML content of the ad item |
| location | string | no | Click-through URL |
| width | number | no | Ad width in pixels (0 for flexible) |
| height | number | no | Ad height in pixels (0 for flexible) |
| html_content_below | string | no | HTML content below the ad item |
| expand_horizontal_direction | string | no | Horizontal expand direction |
| expand_vertical_direction | string | no | Vertical expand direction |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Update an existing custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
| name | string | no | Ad item name |
| custom_html | string | no | The HTML content |
| location | string | no | Click-through URL |
| width | number | no | Ad width in pixels |
| height | number | no | Ad height in pixels |
| html_content_below | string | no | HTML content below the ad item |
| expand_horizontal_direction | string | no | Horizontal expand direction |
| expand_vertical_direction | string | no | Vertical expand direction |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Delete a custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Get conversion tracking tag for a custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
List all rich media ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Create a new rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Ad item name |
| creative | number | yes | Rich media creative ID |
| location | string | no | Click-through URL |
| width | number | no | Ad width in pixels |
| height | number | no | Ad height in pixels |
| html_content_below | string | no | HTML content below the ad item |
| expand_horizontal_direction | string | no | Horizontal expand direction |
| expand_vertical_direction | string | no | Vertical expand direction |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Update an existing rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
| name | string | no | Ad item name |
| creative | number | no | Rich media creative ID |
| location | string | no | Click-through URL |
| html_content_below | string | no | HTML content below the ad item |
| expand_horizontal_direction | string | no | Horizontal expand direction |
| expand_vertical_direction | string | no | Vertical expand direction |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Delete a rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Get conversion tracking tag for a rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
List all native ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Create a new native ad item using a native template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Ad item name |
| template | number | yes | Native template ID |
| variables | object | yes | Template variables as key-value pairs (keys should be integer strings) |
| location | string | no | Click-through URL |
| width | number | no | Ad width in pixels |
| height | number | no | Ad height in pixels |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Update an existing native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
| name | string | no | Ad item name |
| template | number | no | Native template ID |
| variables | object | no | Template variables as key-value pairs |
| location | string | no | Click-through URL |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
| trusted_redirect_domains | array | no | Trusted redirect domains |
Delete a native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Get conversion tracking tag for a native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
List all catalog ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Create a new catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Ad item name |
| catalog_id | number | yes | Catalog ID |
| catalog_item_identifier | string | yes | Unique identifier for the catalog item |
| location | string | no | Click-through URL |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
Update an existing catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
| name | string | no | Ad item name |
| catalog_item_identifier | string | no | Unique identifier for the catalog item |
| location | string | no | Click-through URL |
| tracking_pixel | string | no | Third-party tracking pixel URL |
| tracking_pixels | array | no | Array of tracking pixel URLs |
| metadata | object | no | Custom metadata key-value pairs |
Delete a catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Ad item ID |
Convert a native ad item to an image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Native ad item ID |
List all creatives across all types (image, rich media, video, audio)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
List all image creatives
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific image creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Create a new image creative. The API uses multipart file upload — pass the media group ID and file attributes.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| group | number | yes | Media group ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
Update an existing image creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
Delete an image creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
List all rich media creatives
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific rich media creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Create a new rich media creative. The API uses multipart file upload (ZIP for HTML5).
| Parameter | Type | Required | Notes |
|---|---|---|---|
| group | number | yes | Media group ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
| index_file_path | string | no | Path to index HTML file inside ZIP archive (for HTML5) |
Update an existing rich media creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
Delete a rich media creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
List all video creatives
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific video creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Create a new video creative. The API uses multipart file upload.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| group | number | yes | Media group ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
Update an existing video creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
Delete a video creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
List all audio creatives
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific audio creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Create a new audio creative. The API uses multipart file upload.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| group | number | yes | Media group ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
Update an existing audio creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
| name | string | no | Creative name |
| description | string | no | Creative description |
Delete an audio creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Replace the file on an image creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Replace the file on a rich media creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Replace the file on a video creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
Replace the file on an audio creative
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Creative ID |
List all placements (assignments of ad items to zones)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Placement ID |
Create a new placement (assign an ad item or campaign to a zone or channel)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| advertisement | object | yes | Advertisement object with id and type |
| zone | object | no | Zone object (required if channel not set; mutually exclusive with channel) |
| channel | number | no | Channel ID (required if zone not set; mutually exclusive with zone) |
| schedule | number | yes | Schedule ID |
| active | boolean | no | Whether placement is active (defaults to true) |
| weight | number | no | Relative delivery weight |
| share_of_voice | number | no | Share of voice percentage (required when zone uses share_of_voice) |
| cost | object | no | Pricing model: fixed_cost OR cpm/cpc/cpa |
| payout | object | no | Publisher payout configuration |
| priority | string | no | Serving priority level (defaults to "standard") |
| serve_method | string | no | Serving system: weight-based or auction-based |
| geo_target | number | no | Geotarget ID |
| platform_target | number | no | Platform target ID |
| keywords | string | no | Comma-separated keywords for targeting |
| keywords_match_method | string | no | Keyword matching method |
| data_key_target_id | number | no | Data Key Target ID (Enterprise only) |
| list_target | number | no | List Target ID |
| contextual_segments | array | no | Array of contextual segment IDs |
Update an existing placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Placement ID |
| advertisement | object | no | Advertisement object with id and type |
| zone | object | no | Zone object (mutually exclusive with channel) |
| channel | number | no | Channel ID (mutually exclusive with zone) |
| schedule | number | no | Schedule ID |
| active | boolean | no | Whether placement is active |
| weight | number | no | Relative delivery weight |
| share_of_voice | number | no | Share of voice percentage |
| cost | object | no | Pricing model |
| payout | object | no | Publisher payout configuration |
| priority | string | no | Serving priority level |
| serve_method | string | no | Serving system |
| geo_target | number | no | Geotarget ID |
| platform_target | number | no | Platform target ID |
| keywords | string | no | Comma-separated keywords |
| keywords_match_method | string | no | Keyword matching method |
| data_key_target_id | number | no | Data Key Target ID |
| list_target | number | no | List Target ID |
| contextual_segments | array | no | Array of contextual segment IDs |
Delete a placement (remove an ad item from a zone)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Placement ID |
Get conversion tracking tag for a placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Placement ID |
List all native ad templates
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific native template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Native template ID |
Create a new native ad template with HTML and variable placeholders
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Template name |
| raw_html | string | yes | HTML template content with variable placeholders (e.g. "[%title%]") |
| variables | array | yes | Array of template variables |
Update an existing native template. Variables uses add/remove format for updates.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Native template ID |
| name | string | no | Template name |
| raw_html | string | no | HTML template content with variable placeholders |
| variables | object | no | Variables to add/remove |
Delete a native template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Native template ID |
List all schedules (time-based delivery rules for ad items)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Schedule ID |
Create a new schedule for time-based ad delivery. Schedules are automatically linked to ad items via placements.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| start_date | string | no | Start date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at |
| end_date | string | no | End date (YYYY-MM-DD HH:MM:SS), null for indefinite — deprecated, use end_at |
| start_at | string | no | Start date/time in ISO-8601 format |
| start_at_timezone | string | no | IANA timezone for start_at (e.g. "America/New_York") |
| end_at | string | no | End date/time in ISO-8601 format, null for indefinite |
| end_at_timezone | string | no | IANA timezone for end_at |
| delivery_method | string | no | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
| quota_lifetime | number | no | Total quota amount (views or clicks, not per thousand) |
| quota_type | string | no | Quota measurement type |
| day_cap_limit | number | no | Daily cap limit (number of views or clicks per day) |
| day_cap_type | string | no | Daily cap type |
| per_user_view_limit | number | no | Per-user view frequency cap |
| per_user_view_period | number | no | Days before per-user view counter resets |
| under_delivery_behaviour | string | no | Whether to keep serving until quota met or stop on end date |
| day_parting_id | number | no | Day parting ID for time-of-day targeting |
Update an existing schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Schedule ID |
| start_date | string | no | Start date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at |
| end_date | string | no | End date (YYYY-MM-DD HH:MM:SS) — deprecated, use end_at |
| start_at | string | no | Start date/time in ISO-8601 format |
| start_at_timezone | string | no | IANA timezone for start_at |
| end_at | string | no | End date/time in ISO-8601 format |
| end_at_timezone | string | no | IANA timezone for end_at |
| delivery_method | string | no | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
| quota_lifetime | number | no | Total quota amount (views or clicks, not per thousand) |
| quota_type | string | no | Quota measurement type |
| day_cap_limit | number | no | Daily cap limit |
| day_cap_type | string | no | Daily cap type |
| per_user_view_limit | number | no | Per-user view frequency cap |
| per_user_view_period | number | no | Days before per-user view counter resets |
| under_delivery_behaviour | string | no | Whether to keep serving until quota met or stop on end date |
| day_parting_id | number | no | Day parting ID for time-of-day targeting |
Delete a schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Schedule ID |
List all media groups (collections of creatives)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific media group
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Media group ID |
Create a new media group
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Media group name |
Update an existing media group
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Media group ID |
| name | string | no | Media group name |
Delete a media group
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Media group ID |
List all data keys (custom key-value targeting variables)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific data key
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data key ID |
Create a new data key for custom targeting
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Data key name (max 32 chars, must be unique) |
| type | string | yes | Data key value type |
Update an existing data key
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data key ID |
| name | string | no | Data key name |
| type | string | no | Data key value type |
Delete a data key
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data key ID |
List all data key targets (targeting rules using data key values)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific data key target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data key target ID |
Create a new data key target (targeting rule)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Data key target name |
| target | string | yes | JSON formatted target logic, e.g. ["OR", {"my_number": {"=": "5"}}, {"my_string": {"=": "test"}}] |
Update an existing data key target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data key target ID |
| name | string | no | Data key target name |
| target | string | no | JSON formatted target logic |
Delete a data key target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data key target ID |
List all day parting rules (time-of-day targeting)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific day parting rule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Day 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.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | Day parting name |
| use_member_timezone | boolean | no | If true, use account timezone; if false, use viewer timezone |
| is_template | boolean | no | If true, shown in UI when creating/editing schedules |
| ranges | object | no | Object mapping day names (monday-sunday) to arrays of time ranges like "09:00:00-17:00:00" |
Update an existing day parting rule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Day parting ID |
| name | string | no | Day parting name |
| use_member_timezone | boolean | no | If true, use account timezone; if false, use viewer timezone |
| is_template | boolean | no | If true, shown in UI when creating/editing schedules |
| ranges | object | no | Object mapping day names (monday-sunday) to arrays of time ranges |
Delete a day parting rule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Day parting ID |
List all geo targets (geographic targeting rules)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific geo target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Geo 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.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Geo target name |
| inclusive | boolean | no | If true, target users IN these areas; if false, EXCLUDE these areas |
| areas | array | yes | Array of geographic areas to target |
| range | number | no | Radius range for geo-fencing (only applies when targeting a city) |
| unit | string | no | Distance unit for range |
Update an existing geo target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Geo target ID |
| name | string | no | Geo target name |
| inclusive | boolean | no | If true, target users IN these areas; if false, EXCLUDE |
| areas | array | no | Array of geographic areas |
| range | number | no | Radius range |
| unit | string | no | Distance unit |
Delete a geo target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Geo target ID |
List all postal code targets
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific postal code target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Postal code target ID |
Create a new postal code target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| label | string | yes | Postal code target name |
| inclusive | boolean | no | If true, inclusion target; if false, exclusion target |
| locations | array | yes | Array of locations grouped by country |
Update an existing postal code target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Postal code target ID |
| label | string | no | Postal code target name |
| inclusive | boolean | no | If true, inclusion target; if false, exclusion target |
| locations | array | no | Array of locations grouped by country |
Delete a postal code target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Postal code target ID |
List all list targets (allowlist/blocklist targeting)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific list target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | List target ID |
Create a new list target (inclusion/exclusion using a data list)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| label | string | yes | List target name |
| inclusive | boolean | no | If true, inclusion target; if false, exclusion target |
| data_list | number | no | Data list ID containing the values to target |
Update an existing list target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | List target ID |
| label | string | no | List target name |
| inclusive | boolean | no | If true, inclusion; if false, exclusion |
| data_list | number | no | Data list ID |
Delete a list target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | List target ID |
List all platform targets (device/OS/browser targeting)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific platform target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Platform target ID |
Create a new platform target for device/OS/browser targeting
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Platform target name |
| platform | string | no | Preset platform target (default: any) |
| device_targets | array | no | List of device patterns to target (e.g. "Apple*", "Samsung Galaxy S5") |
Update an existing platform target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Platform target ID |
| name | string | no | Platform target name |
| platform | string | no | Preset platform target |
| device_targets | array | no | List of device patterns to target |
Delete a platform target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Platform target ID |
List all data targets
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Remove all usages of a list target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | List target ID |
Get display advertising report with impressions, clicks, and CTR
| Parameter | Type | Required | Notes |
|---|---|---|---|
| type | string | yes | Report type: overview, advertiser, publisher, zone, campaign, channel, geo-target, ad-item |
| period | string | yes | Data grouping period: day, week, month, year |
| preset | string | no | Date 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-mont |
| timezone | string | no | Timezone for preset (e.g. "America/New_York") |
| summary | boolean | no | Include summary data |
| details | boolean | no | Include detailed breakdown |
| breakdown | boolean | no | Include breakdown data |
| financials | boolean | no | Include financial data |
| publishers | string | no | Filter by publisher IDs (comma-separated) |
| zones | string | no | Filter by zone IDs (comma-separated) |
| advertisers | string | no | Filter by advertiser IDs (comma-separated) |
| campaigns | string | no | Filter by campaign IDs (comma-separated) |
| exclude_publisher_ad_items | boolean | no | Exclude ad items directly in zones |
| exclude_campaign_ad_items | boolean | no | Exclude ad items in campaigns |
| exclude_channel_stats | boolean | no | Exclude stats from channel-served ads |
| require_channel_stats | boolean | no | Only include stats from channel-served ads |
Get VAST video advertising report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| type | string | yes | Report type: overview, advertiser, publisher, zone, campaign, ad-item |
| period | string | yes | Data grouping period: day, week, month, year |
| preset | string | no | Date preset (same options as display report) |
| timezone | string | no | Timezone for preset |
| summary | boolean | no | Include summary data |
| details | boolean | no | Include detailed breakdown |
| breakdown | boolean | no | Include breakdown data |
| financials | boolean | no | Include financial data |
| publishers | string | no | Filter by publisher IDs (comma-separated) |
| zones | string | no | Filter by zone IDs (comma-separated) |
| advertisers | string | no | Filter by advertiser IDs (comma-separated) |
| campaigns | string | no | Filter by campaign IDs (comma-separated) |
Get event logs for account activity (changes, logins, etc.)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| log_type | string | yes | Type of event log to retrieve |
| from | string | no | Start date filter |
| to | string | no | End date filter |
Get click details report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
| publishers | string | no | Filter by publisher IDs (comma-separated) |
| zones | string | no | Filter by zone IDs (comma-separated) |
| advertisers | string | no | Filter by advertiser IDs (comma-separated) |
| campaigns | string | no | Filter by campaign IDs (comma-separated) |
Get conversion details report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
| publishers | string | no | Filter by publisher IDs (comma-separated) |
| zones | string | no | Filter by zone IDs (comma-separated) |
| advertisers | string | no | Filter by advertiser IDs (comma-separated) |
| campaigns | string | no | Filter by campaign IDs (comma-separated) |
Get demand source statistics report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get display platform estimate statistics
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get VAST platform estimate statistics
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get geographic summary report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
| publishers | string | no | Filter by publisher IDs (comma-separated) |
| zones | string | no | Filter by zone IDs (comma-separated) |
| advertisers | string | no | Filter by advertiser IDs (comma-separated) |
| campaigns | string | no | Filter by campaign IDs (comma-separated) |
Get auction placement statistics report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get placement forecast report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get display forecast report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get display channel forecast report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get VAST forecast report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get VAST channel forecast report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get VAST auction placements report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
Get VAST geographic summary report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| preset | string | no | Date preset |
| timezone | string | no | Timezone |
| publishers | string | no | Filter by publisher IDs (comma-separated) |
| zones | string | no | Filter by zone IDs (comma-separated) |
| advertisers | string | no | Filter by advertiser IDs (comma-separated) |
| campaigns | string | no | Filter by campaign IDs (comma-separated) |
Get live website preview URL
| Parameter | Type | Required | Notes |
|---|---|---|---|
| zone_id | number | no | Zone ID to preview |
| url | string | no | Website URL to preview |
Generate manual tracking links for an ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ad_item_id | number | no | Ad item ID |
| type | string | no | Ad item type |
List all saved report configurations
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific report configuration
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Report configuration ID |
Create a new report configuration
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Report name |
| type | string | yes | Report type |
| period | string | yes | Data grouping period |
| date | object | yes | Date configuration (either preset or start+end required) |
| filters | object | no | Filter criteria: { publishers: [...], advertisers: [...], zones: [...], campaigns: [...], ad_items: [...], channels: [...] } |
| columns | array | no | Columns to include: impressions, eligible, viewable, clicks, conversions, ctr, cvr, e_cpm, e_cpc, e_cpa, cost, payout, revenue |
| exclude_publisher_ad_items | boolean | no | Exclude ad items directly in zones |
| exclude_campaign_ad_items | boolean | no | Exclude ad items in campaigns |
| exclude_channel_stats | boolean | no | Exclude stats from channel-served ads |
| require_channel_stats | boolean | no | Only include stats from channel-served ads |
Update an existing report configuration
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Report configuration ID |
| name | string | no | Report name |
| type | string | no | Report type |
| period | string | no | Data grouping period |
| date | object | no | Date configuration |
| filters | object | no | Filter criteria |
| columns | array | no | Columns to include |
| exclude_publisher_ad_items | boolean | no | Exclude ad items directly in zones |
| exclude_campaign_ad_items | boolean | no | Exclude ad items in campaigns |
| exclude_channel_stats | boolean | no | Exclude stats from channel-served ads |
| require_channel_stats | boolean | no | Only include stats from channel-served ads |
Delete a report configuration
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Report configuration ID |
List all VAST report data
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get a specific VAST report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST report ID |
Create a new VAST report configuration
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Report name |
List all generated reports across all configurations
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
List all report schedules across all configurations
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
List generated reports for a specific report configuration
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get a specific generated report
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| generated_id | number | yes | Generated report ID |
List schedules for a specific report configuration
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get a specific report schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| schedule_id | number | yes | Schedule ID |
Create a new report schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| frequency | string | no | Schedule frequency |
| recipients | array | no | Array of recipient objects |
Update a report schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| schedule_id | number | yes | Schedule ID |
| frequency | string | no | Schedule frequency |
| recipients | array | no | Array of recipient objects |
Delete a report schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| schedule_id | number | yes | Schedule ID |
List generated reports for a specific schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| schedule_id | number | yes | Schedule ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get a specific generated report from a schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| schedule_id | number | yes | Schedule ID |
| generated_id | number | yes | Generated report ID |
Revoke historical access for a report schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| report_config_id | number | yes | Report configuration ID |
| schedule_id | number | yes | Schedule ID |
Request ad delivery for a zone. Returns the ad(s) that would be served, useful for verifying ad setup. Uses POST /adserve.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ID | number | yes | Your AdButler account ID |
| setID | number | yes | Zone ID to serve an ad from |
| type | string | yes | Response type: "json" for most eligible ad, "jsonr" for all eligible ads ranked |
| size | string | no | Expected ad size (e.g. "300x250") |
| kw | array | no | Keywords for keyword targeting |
| referrer | string | no | Page URL for URL targeting (required for server-side requests) |
| ip | string | no | IPv4 address for geographic targeting (required for server-side requests) |
| ua | string | no | User agent string for platform targeting |
| sw | number | no | Screen width for platform targeting |
| sh | number | no | Screen height for platform targeting |
| spr | number | no | Screen pixel ratio for platform targeting |
| pid | number | no | Page ID for unique delivery/roadblocks (random number, same for all zones on page) |
| place | number | no | Place counter for unique delivery (0, 1, 2, etc.) |
| _abdk_json | object | no | Data key key-value pairs for data key targeting |
| rf | number | no | Pass 1 to include is_redirectable field in response |
| defer_signing | boolean | no | Defer beacon signing hash generation |
Retrieve an ad via GET request. Same parameters as serve_ad but uses GET instead of POST.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ID | number | yes | Your AdButler account ID |
| setID | number | yes | Zone ID to serve an ad from |
| type | string | yes | Response type: "json" for most eligible ad, "jsonr" for all eligible ads ranked |
| size | string | no | Expected ad size (e.g. "300x250") |
| kw | array | no | Keywords for keyword targeting |
| referrer | string | no | Page URL for URL targeting (required for server-side requests) |
| ip | string | no | IPv4 address for geographic targeting (required for server-side requests) |
| ua | string | no | User agent string for platform targeting |
| sw | number | no | Screen width for platform targeting |
| sh | number | no | Screen height for platform targeting |
| spr | number | no | Screen pixel ratio for platform targeting |
| pid | number | no | Page ID for unique delivery/roadblocks (random number, same for all zones on page) |
| place | number | no | Place counter for unique delivery (0, 1, 2, etc.) |
| _abdk_json | object | no | Data key key-value pairs for data key targeting |
| rf | number | no | Pass 1 to include is_redirectable field in response |
| defer_signing | boolean | no | Defer beacon signing hash generation |
List all VAST ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST ad item ID |
Create a new VAST ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Ad item name |
| location | string | yes | VAST tag URL or media location |
| active | boolean | no | Whether ad item is active |
Update an existing VAST ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST ad item ID |
| name | string | no | Ad item name |
| location | string | no | VAST tag URL or media location |
| active | boolean | no | Whether ad item is active |
Delete a VAST ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST ad item ID |
List all VAST campaigns
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign ID |
Create a new VAST campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Campaign name |
| advertiser | number | yes | Advertiser ID |
| contract | number | no | Contract ID (requires Contract Management add-on) |
Update an existing VAST campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign ID |
| name | string | no | Campaign name |
| advertiser | number | no | Advertiser ID |
| contract | number | no | Contract ID (requires Contract Management add-on) |
Delete a VAST campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign ID |
Archive a VAST campaign (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign ID |
List all archived VAST campaigns
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived VAST campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST campaign ID |
Permanently delete an archived VAST campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST campaign ID |
Restore an archived VAST campaign back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST campaign ID |
List all VAST channels
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST channel ID |
Create a new VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Channel name |
| description | string | no | Channel description |
Update an existing VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST channel ID |
| name | string | no | Channel name |
| description | string | no | Channel description |
Delete a VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST channel ID |
Archive a VAST channel (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST channel ID |
List all archived VAST channels
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST channel ID |
Permanently delete an archived VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST channel ID |
Restore an archived VAST channel back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST channel ID |
List all VAST channel zone assignments
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST channel zone assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST channel zone assignment ID |
Assign a VAST zone to a VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| channel | number | yes | VAST channel ID |
| zone | number | yes | VAST zone ID |
Update a VAST channel zone assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST channel zone assignment ID |
| channel | number | no | VAST channel ID |
| zone | number | no | VAST zone ID |
Remove a VAST zone from a VAST channel
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST channel zone assignment ID |
List all VAST zones
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST zone ID |
Create a new VAST zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Zone name |
| publisher | number | yes | Publisher ID |
| default_vast_ad_item | number | no | Default VAST ad item ID (mutually exclusive with default_vast_campaign) |
| default_vast_campaign | number | no | Default VAST campaign ID (mutually exclusive with default_vast_ad_item) |
| serve_priority_order | string | no | Priority order for serving: "weight" or "auction" |
| metadata | object | no | Custom metadata key-value pairs |
Update an existing VAST zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST zone ID |
| name | string | no | Zone name |
| publisher | number | no | Publisher ID |
| default_vast_ad_item | number | no | Default VAST ad item ID (mutually exclusive with default_vast_campaign) |
| default_vast_campaign | number | no | Default VAST campaign ID (mutually exclusive with default_vast_ad_item) |
| serve_priority_order | string | no | Priority order for serving: "weight" or "auction" |
| metadata | object | no | Custom metadata key-value pairs |
Delete a VAST zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST zone ID |
Archive a VAST zone (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST zone ID |
List all archived VAST zones
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived VAST zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST zone ID |
Permanently delete an archived VAST zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST zone ID |
Restore an archived VAST zone back to active status
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived VAST zone ID |
List all VAST placements (assignments of VAST ad items to VAST zones)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST placement ID |
Create a new VAST placement (assign a VAST ad item or campaign to a VAST zone or channel)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| advertisement | object | yes | Advertisement object with id and type |
| zone | number | no | VAST zone ID (required if channel not set; mutually exclusive with channel) |
| channel | number | no | VAST channel ID (required if zone not set; mutually exclusive with zone) |
| schedule | number | yes | VAST schedule ID |
| active | boolean | no | Whether placement is active (defaults to true) |
| cost | object | no | Pricing model: fixed_cost OR cpm/cpc/cpa |
| payout | object | no | Publisher payout configuration |
| priority | number | no | Priority level (sponsorship, standard, network, bulk, house) |
| max_frequency | number | no | Frequency cap limit |
| max_frequency_period | number | no | Days before frequency counter resets |
| max_frequency_type | string | no | Event type to count for frequency capping |
| serve_method | string | no | Serving system: weight-based or auction-based |
| data_key_target_id | number | no | Data Key Target ID (Enterprise only) |
Update an existing VAST placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST placement ID |
| advertisement | object | no | Advertisement object with id and type |
| zone | number | no | VAST zone ID (mutually exclusive with channel) |
| channel | number | no | VAST channel ID (mutually exclusive with zone) |
| schedule | number | no | VAST schedule ID |
| active | boolean | no | Whether placement is active |
| cost | object | no | Pricing model: fixed_cost OR cpm/cpc/cpa |
| payout | object | no | Publisher payout configuration |
| priority | number | no | Priority level |
| max_frequency | number | no | Frequency cap limit |
| max_frequency_period | number | no | Days before frequency counter resets |
| max_frequency_type | string | no | Event type for frequency capping |
| serve_method | string | no | Serving system: weight-based or auction-based |
| data_key_target_id | number | no | Data Key Target ID (Enterprise only) |
Delete a VAST placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST placement ID |
List all VAST campaign assignments
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign assignment ID |
Create a VAST campaign assignment (assign an ad item to a campaign)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| ad_item | number | yes | VAST ad item ID |
| campaign | number | yes | VAST campaign ID |
| active | boolean | no | Whether to actively serve ads (defaults to true) |
Update a VAST campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign assignment ID |
| ad_item | number | no | VAST ad item ID |
| campaign | number | no | VAST campaign ID |
| active | boolean | no | Whether to actively serve ads |
Delete a VAST campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign assignment ID |
List all VAST schedules
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST schedule ID |
Create a new VAST schedule for time-based ad delivery
| Parameter | Type | Required | Notes |
|---|---|---|---|
| start_date | string | no | Start date (YYYY-MM-DD HH:MM:SS) |
| end_date | string | no | End date (YYYY-MM-DD HH:MM:SS), null for indefinite |
| delivery_method | string | no | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
| quota_lifetime | number | no | Total quota amount (views or clicks, not per thousand) |
| quota_type | string | no | Quota measurement type |
| geo_target | number | no | Geotarget ID (0 = no targeting) |
| day_parting_id | number | no | Day parting ID for time-of-day targeting |
Update an existing VAST schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST schedule ID |
| start_date | string | no | Start date (YYYY-MM-DD HH:MM:SS) |
| end_date | string | no | End date (YYYY-MM-DD HH:MM:SS), null for indefinite |
| delivery_method | string | no | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
| quota_lifetime | number | no | Total quota amount (views or clicks, not per thousand) |
| quota_type | string | no | Quota measurement type |
| geo_target | number | no | Geotarget ID (0 = no targeting) |
| day_parting_id | number | no | Day parting ID for time-of-day targeting |
Delete a VAST schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST schedule ID |
List all VAST companions
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST companion
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST companion ID |
Create a new VAST companion
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Companion name |
| width | number | no | Companion width in pixels |
| height | number | no | Companion height in pixels |
Update an existing VAST companion
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST companion ID |
| name | string | no | Companion name |
| width | number | no | Companion width in pixels |
| height | number | no | Companion height in pixels |
Delete a VAST companion
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST companion ID |
List all VAST media (linear and non-linear)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
List all VAST linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST linear media ID |
Create a new VAST linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Linear media name |
| duration | number | no | Duration in seconds |
| bitrate | number | no | Bitrate in kbps |
| mime_type | string | no | MIME type (e.g. video/mp4) |
Update an existing VAST linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST linear media ID |
| name | string | no | Linear media name |
| duration | number | no | Duration in seconds |
| bitrate | number | no | Bitrate in kbps |
| mime_type | string | no | MIME type (e.g. video/mp4) |
Delete a VAST linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST linear media ID |
List all VAST non-linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST non-linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST non-linear media ID |
Create a new VAST non-linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Non-linear media name |
| width | number | no | Width in pixels |
| height | number | no | Height in pixels |
| mime_type | string | no | MIME type |
Update an existing VAST non-linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST non-linear media ID |
| name | string | no | Non-linear media name |
| width | number | no | Width in pixels |
| height | number | no | Height in pixels |
| mime_type | string | no | MIME type |
Delete a VAST non-linear media
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST non-linear media ID |
List all VAST tracking entries
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific VAST tracking entry
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST tracking ID |
Create a new VAST tracking entry
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Tracking name |
| event | string | no | Tracking event type (e.g. start, firstQuartile, midpoint, thirdQuartile, complete) |
| url | string | no | Tracking URL |
Update an existing VAST tracking entry
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST tracking ID |
| name | string | no | Tracking name |
| event | string | no | Tracking event type |
| url | string | no | Tracking URL |
Delete a VAST tracking entry
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST tracking ID |
Get VAST zone serving tags
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST zone ID |
Get VAST zone conversion tracking tag
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST zone ID |
Get conversion tracking tag for a VAST ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST ad item ID |
Get conversion tracking tag for a VAST campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST campaign ID |
Get conversion tracking tag for a VAST placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | VAST placement ID |
List all contracts
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract ID |
Create a new contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Contract name |
| advertiser | number | yes | Advertiser ID |
| description | string | no | Contract description |
| rate | number | no | Contract rate (in account currency) |
| payment_due_date | string | no | Payment due date (YYYY-MM-DD) |
| start_at | string | no | Contract start date (YYYY-MM-DD) |
| end_at | string | no | Contract end date (YYYY-MM-DD) |
| status | string | no | Contract status |
Update an existing contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract ID |
| name | string | no | Contract name |
| advertiser | number | no | Advertiser ID |
| description | string | no | Contract description |
| rate | number | no | Contract rate |
| payment_due_date | string | no | Payment due date (YYYY-MM-DD) |
| start_at | string | no | Contract start date (YYYY-MM-DD) |
| end_at | string | no | Contract end date (YYYY-MM-DD) |
| status | string | no | Contract status |
Delete a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract ID |
List all archived contracts
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific archived contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived contract ID |
Permanently delete an archived contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived contract ID |
List all contract templates
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific contract template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract template ID |
Create a new contract template. Requires name, file, attributes (JSON string), email_subject, and email_body.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Template name |
| file | string | yes | URL or path to the contract template file |
| attributes | string | yes | JSON-encoded object containing name, email_subject, email_body, and optionally signing_service, basic_inputs, contract_column_inputs, signers |
| email_subject | string | yes | Email subject line when sending for signature |
| email_body | string | yes | Email body text when sending for signature |
Update an existing contract template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract template ID |
| name | string | no | Template name |
Delete a contract template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract template ID |
List all documents for a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific contract document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Document ID |
Create a new document for a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| attributes | string | no | JSON-encoded object with name, admin_executed, vendor_executed fields |
Update an existing contract document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Document ID |
| name | string | no | Document name |
Delete a contract document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Document ID |
List all payments for a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific contract payment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Payment ID |
Create a new payment for a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| amount | number | yes | Amount paid (can be negative for refunds) |
| note | string | no | Payment note or description |
Delete a contract payment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Payment ID |
List all signature requests for a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Signature request ID |
Create a new signature request for a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
Update an existing signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Signature request ID |
Delete a signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| id | number | yes | Signature request ID |
Archive a contract (soft-delete, can be restored later)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract ID |
Unarchive a contract (restore from archive)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Archived contract ID |
Get campaigns assigned to a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract ID |
Get the active signature request for a contract
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contract ID |
Create a contract document from a template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| template_id | number | no | Template ID |
Replace the file on a contract document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| document_id | number | yes | Document ID |
Replace a contract document file from a template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| document_id | number | yes | Document ID |
List file revisions for a contract document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| document_id | number | yes | Document ID |
Get a specific file revision for a contract document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| document_id | number | yes | Document ID |
| revision_id | number | yes | File revision ID |
Download a file revision for a contract document
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| document_id | number | yes | Document ID |
| revision_id | number | yes | File revision ID |
List all recipients for a signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| request_id | number | yes | Signature request ID |
Get a specific recipient for a signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| request_id | number | yes | Signature request ID |
| recipient_id | number | yes | Recipient ID |
Update a recipient for a signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| request_id | number | yes | Signature request ID |
| recipient_id | number | yes | Recipient ID |
| name | string | no | Recipient name |
| string | no | Recipient email |
Delete a recipient from a signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| request_id | number | yes | Signature request ID |
| recipient_id | number | yes | Recipient ID |
Cancel a signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| request_id | number | yes | Signature request ID |
Resend a signature request
| Parameter | Type | Required | Notes |
|---|---|---|---|
| contract_id | number | yes | Contract ID |
| request_id | number | yes | Signature request ID |
List all managers in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific manager by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Manager ID |
Create a new manager
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Manager name |
| string | yes | Manager email address | |
| password | string | no | Login password (min 8 chars with upper, lower, number). Random if blank. |
| notes | string | no | Notes about the manager |
| position | string | no | Manager position in organization |
| is_enabled | boolean | no | Whether the manager account is enabled |
| can_manage_links | boolean | no | Can create/edit/delete active tracking links |
| can_manage_media | boolean | no | Can manage creatives and media groups |
| can_manage_targets | boolean | no | Can assign/remove targets from placements |
| can_manage_users | boolean | no | Can manage user accounts and permissions |
| can_manage_bidders | boolean | no | Can manage bidders |
| can_manage_programmatic | boolean | no | Can manage demand sources and PMP deals |
| can_manage_contracts | boolean | no | Can manage contracts and templates |
| can_manage_self_serve | boolean | no | Can manage Self-Serve portals |
| can_assign_campaigns_directly | boolean | no | Can assign campaigns directly to zones |
| can_manage_tickets | boolean | no | Can create/view support tickets |
| can_manage_admin_api_access | boolean | no | Can manage API keys |
| can_manage_billing | boolean | no | Can view invoices and billing |
| can_manage_data_keys | boolean | no | Can manage data keys |
| can_manage_product_db | boolean | no | Can manage product catalogs |
Update an existing manager
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Manager ID |
| name | string | no | Manager name |
| string | no | Manager email address | |
| password | string | no | Login password |
| notes | string | no | Notes about the manager |
| position | string | no | Manager position |
| is_enabled | boolean | no | Whether the manager account is enabled |
| can_manage_links | boolean | no | Can manage tracking links |
| can_manage_media | boolean | no | Can manage creatives and media groups |
| can_manage_targets | boolean | no | Can manage targets |
| can_manage_users | boolean | no | Can manage users |
| can_manage_bidders | boolean | no | Can manage bidders |
| can_manage_programmatic | boolean | no | Can manage programmatic |
| can_manage_contracts | boolean | no | Can manage contracts |
| can_manage_self_serve | boolean | no | Can manage Self-Serve |
| can_assign_campaigns_directly | boolean | no | Can assign campaigns directly |
| can_manage_tickets | boolean | no | Can manage tickets |
| can_manage_admin_api_access | boolean | no | Can manage API keys |
| can_manage_billing | boolean | no | Can manage billing |
| can_manage_data_keys | boolean | no | Can manage data keys |
Delete a manager
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Manager ID |
List all roles in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific role by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Role ID |
Create a new role with permission settings
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Role name |
| is_default_role | boolean | no | Auto-assign this role to new users |
| can_manage_links | boolean | no | Can manage tracking links |
| can_manage_media | boolean | no | Can manage creatives and media groups |
| can_manage_targets | boolean | no | Can manage targets |
| can_manage_users | boolean | no | Can manage users |
| can_manage_bidders | boolean | no | Can manage bidders |
| can_manage_programmatic | boolean | no | Can manage programmatic |
| can_manage_contracts | boolean | no | Can manage contracts |
| can_manage_self_serve | boolean | no | Can manage Self-Serve |
| can_assign_campaigns_directly | boolean | no | Can assign campaigns directly |
| can_manage_tickets | boolean | no | Can manage tickets |
| can_manage_admin_api_access | boolean | no | Can manage API keys |
| can_manage_billing | boolean | no | Can manage billing |
| can_manage_data_keys | boolean | no | Can manage data keys |
| can_manage_product_db | boolean | no | Can manage product catalogs |
| can_manage_native_ad_templates | boolean | no | Can manage native templates |
| publisher_access | string | no | Publisher access level |
| publisher_access_list | array | no | Publisher IDs for specific access |
| statistics_access | string | no | Statistics access level |
Update an existing role
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Role ID |
| name | string | no | Role name |
| is_default_role | boolean | no | Auto-assign to new users |
| can_manage_links | boolean | no | Can manage tracking links |
| can_manage_media | boolean | no | Can manage creatives |
| can_manage_targets | boolean | no | Can manage targets |
| can_manage_users | boolean | no | Can manage users |
| can_manage_bidders | boolean | no | Can manage bidders |
| can_manage_programmatic | boolean | no | Can manage programmatic |
| can_manage_contracts | boolean | no | Can manage contracts |
| can_manage_self_serve | boolean | no | Can manage Self-Serve |
| can_assign_campaigns_directly | boolean | no | Can assign campaigns directly |
| can_manage_tickets | boolean | no | Can manage tickets |
| can_manage_admin_api_access | boolean | no | Can manage API keys |
| can_manage_billing | boolean | no | Can manage billing |
| can_manage_data_keys | boolean | no | Can manage data keys |
| can_manage_product_db | boolean | no | Can manage product catalogs |
| can_manage_native_ad_templates | boolean | no | Can manage native templates |
| publisher_access | string | no | Publisher access level |
| publisher_access_list | array | no | Publisher IDs for specific access |
Delete a role
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Role ID |
List all contacts in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific contact by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contact ID |
Create a new contact
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Contact name (full name recommended) |
| string | yes | Contact email address (must be unique) | |
| notes | string | no | Additional notes about the contact |
Update an existing contact
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contact ID |
| name | string | no | Contact name |
| string | no | Contact email address | |
| notes | string | no | Additional notes |
Delete a contact
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contact ID |
List report schedules for a contact
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Contact ID |
List all demand sources in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific demand source by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Demand source ID |
Create a new demand source
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Demand source name |
| network | string | yes | Network type: 'adview', 'aerserv', 'inmobi', 'inneractive', 'loopme', 'mobilefuse', 'onebyaol', 'pubmatic', 'pubnative', 'smaato', 'startapp', 'tappx', 'consumable', 'bidphysics', or 'openrtb' |
| status | string | no | Whether to send bid requests (default: active) |
| spend_limit | number | no | Spend limit amount |
| spend_limit_period | string | no | Spend limit reset interval |
| spend_limit_start | string | no | Spend limit start date (ISO-8601) |
| spend_limit_end | string | no | Spend limit end date (ISO-8601) |
Update an existing demand source
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Demand source ID |
| name | string | no | Demand source name |
| status | string | no | Whether to send bid requests |
| spend_limit | number | no | Spend limit amount |
| spend_limit_period | string | no | Spend limit reset interval |
| spend_limit_start | string | no | Spend limit start date (ISO-8601) |
| spend_limit_end | string | no | Spend limit end date (ISO-8601) |
Delete a demand source
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Demand source ID |
List all demand endpoints in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific demand endpoint by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Demand endpoint ID |
Create a new demand endpoint
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | yes | Demand endpoint name |
| demand_source | number | yes | Demand Source ID this endpoint belongs to |
| default_parameters | object | yes | Default parameters for the endpoint (e.g. { url: "https://..." }) |
| supported_formats | array | yes | Supported ad formats: "display", "native", "video" |
| status | string | no | Whether to send bid requests (default: active) |
| bid_floor | number | no | Default CPM bid floor |
| revenue_share | number | no | Revenue share percentage paid to publisher |
| markup_percent | number | no | Markup percent applied to zone bid floor |
| allowed_sizes | array | no | Allowed zone sizes (e.g. ["300x250", "728x90"]) |
| priority | string | no | Serving priority |
| geo_target | number | no | Geo target ID for geographic targeting |
| filter_type | string | no | Zone filtering type |
| filtered_zones | array | no | Zone IDs for the filter list |
| filtered_vast_zones | array | no | VAST zone IDs for the filter list |
| native_json_encoded | boolean | no | Whether native JSON should be encoded |
Update an existing demand endpoint
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Demand endpoint ID |
| name | string | no | Demand endpoint name |
| demand_source | number | no | Demand Source ID |
| default_parameters | object | no | Default parameters |
| supported_formats | array | no | Supported ad formats |
| status | string | no | Whether to send bid requests |
| bid_floor | number | no | Default CPM bid floor |
| revenue_share | number | no | Revenue share percentage |
| markup_percent | number | no | Markup percent |
| allowed_sizes | array | no | Allowed zone sizes |
| priority | string | no | Serving priority |
| geo_target | number | no | Geo target ID |
| filter_type | string | no | Zone filtering type |
| filtered_zones | array | no | Zone IDs for filter list |
| filtered_vast_zones | array | no | VAST zone IDs for filter list |
| native_json_encoded | boolean | no | Whether native JSON should be encoded |
Delete a demand endpoint
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Demand endpoint ID |
List all PMP deals in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific PMP deal by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | PMP deal ID |
Create a new PMP deal
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | PMP deal name |
| bid_floor | number | no | Bid floor for this deal |
| whitelist_seats | array | no | Seat IDs with access to this deal |
| geo_target | number | no | Geo target ID (0 = no targeting) |
| audience_target | number | no | Audience target ID (null = no targeting) |
Update an existing PMP deal
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | PMP deal ID |
| name | string | no | PMP deal name |
| bid_floor | number | no | Bid floor |
| whitelist_seats | array | no | Seat IDs with access |
| geo_target | number | no | Geo target ID |
| audience_target | number | no | Audience target ID |
Delete a PMP deal
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | PMP deal ID |
List all OpenRTB native templates in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific OpenRTB native template by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | ORTB native template ID |
Create a new OpenRTB native template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | ORTB native template name |
| html_template | string | no | HTML template for rendering the native ad (e.g. "<div>{{title}}</div>") |
Update an existing OpenRTB native template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | ORTB native template ID |
| name | string | no | ORTB native template name |
| html_template | string | no | HTML template for rendering the native ad |
Delete an OpenRTB native template
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | ORTB native template ID |
List all user databases in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific user database by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | User database ID |
Create a new user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| name | string | no | User database name |
| id_field_name | string | no | Name of the field to use as primary user identifier |
List all user attributes in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific user attribute in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| id | number | yes | User attribute ID |
Create a new user attribute in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| id | string | no | Field name in the user data (e.g. "signup_datetime") |
| label | string | no | Descriptive label for the field |
| type | string | no | Data type of the field |
Update an existing user attribute in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| id | number | yes | User attribute ID |
| label | string | no | Descriptive label for the field |
| type | string | no | Data type of the field |
Delete a user attribute from a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| id | number | yes | User attribute ID |
List all audiences in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific audience in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| id | number | yes | Audience ID |
Create a new audience in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| name | string | no | Audience name |
| attributes | object | no | Attribute targets defining the audience (e.g. { "gender": { "operator": "=", "operand": "male" } }) |
Update an existing audience in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| id | number | yes | Audience ID |
| name | string | no | Audience name |
| attributes | object | no | Attribute targets defining the audience |
Delete an audience from a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| id | number | yes | Audience ID |
Get a single user from a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| user_id | string | yes | User ID |
Create a new user in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| user_id | string | no | User ID |
| attributes | object | no | User attribute values |
Bulk upload to replace all user data in a user database
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | User database ID |
Add values to a list attribute for a user
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| user_id | string | yes | User ID |
| list_attribute_name | string | yes | List attribute name |
| values | array | no | Values to add |
Remove values from a list attribute for a user
| Parameter | Type | Required | Notes |
|---|---|---|---|
| user_db_id | number | yes | User database ID |
| user_id | string | yes | User ID |
| list_attribute_name | string | yes | List attribute name |
| values | array | no | Values to remove |
List all data lists in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific data list by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data list ID |
Create a new data list
| Parameter | Type | Required | Notes |
|---|---|---|---|
| label | string | yes | Data list label/name |
Update an existing data list
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data list ID |
| label | string | no | Data list label/name |
Delete a data list
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data list ID |
Bulk add entries to a data list
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data list ID |
| data | string | no | CSV data to add |
Bulk remove entries from a data list
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data list ID |
| data | string | no | CSV data to remove |
Bulk replace all entries in a data list
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Data list ID |
| data | string | no | CSV data to replace list with |
List all beacon signing keys in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific beacon signing key by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Beacon signing key ID |
Create a new beacon signing key
| Parameter | Type | Required | Notes |
|---|---|---|---|
| key_name | string | yes | Beacon signing key name |
Update an existing beacon signing key
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Beacon signing key ID |
| key_name | string | no | Beacon signing key name |
Delete a beacon signing key
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Beacon signing key ID |
List all trusted redirect domains in your AdButler account
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific trusted redirect domain by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Trusted redirect domain ID |
Create a new trusted redirect domain
| Parameter | Type | Required | Notes |
|---|---|---|---|
| domain | string | yes | Trusted redirect domain (e.g. example.com) |
Update an existing trusted redirect domain
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Trusted redirect domain ID |
| domain | string | no | Trusted redirect domain (e.g. example.com) |
Delete a trusted redirect domain
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Trusted redirect domain ID |
Validate a beacon signing key
| Parameter | Type | Required | Notes |
|---|---|---|---|
| key | string | no | Beacon signing key to validate |
List all draft standard campaigns
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft campaign ID |
Create a new draft standard campaign. Fields go inside a "draft" object wrapper.
| Parameter | Type | Required | Notes |
|---|---|---|---|
| draft | object | yes | Object containing standard campaign fields (name, advertiser, etc.) |
Update an existing draft standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft campaign ID |
| draft | object | no | Object containing standard campaign fields to update |
Delete a draft standard campaign
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft campaign ID |
List all draft ad items across all types
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get a draft ad item of any type by ID
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
List all draft image ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
Create a new draft image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this ad item belongs to |
| draft | object | yes | Object containing image ad item fields (name required) |
Update an existing draft image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
| draft | object | no | Object containing image ad item fields to update |
Delete a draft image ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
List all draft rich media ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
Create a new draft rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this ad item belongs to |
| draft | object | yes | Object containing rich media ad item fields (name required) |
Update an existing draft rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
| draft | object | no | Object containing rich media ad item fields to update |
Delete a draft rich media ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
List all draft custom HTML ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
Create a new draft custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this ad item belongs to |
| draft | object | yes | Object containing custom HTML ad item fields (name, custom_html required) |
Update an existing draft custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
| draft | object | no | Object containing custom HTML ad item fields to update |
Delete a draft custom HTML ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
List all draft native ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
Create a new draft native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this ad item belongs to |
| draft | object | yes | Object containing native ad item fields (name required, plus template, variables, etc.) |
Update an existing draft native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
| draft | object | no | Object containing native ad item fields to update |
Delete a draft native ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
List all draft catalog ad items
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
Create a new draft catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this ad item belongs to |
| draft | object | yes | Object containing catalog ad item fields (name required) |
Update an existing draft catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
| draft | object | no | Object containing catalog ad item fields to update |
Delete a draft catalog ad item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft ad item ID |
List all draft campaign assignments
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft campaign assignment ID |
Create a new draft campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this assignment belongs to |
| ad_item_draft_id | number | yes | Draft ad item ID this assignment references |
| draft | object | no | Object containing campaign assignment fields (campaign and advertisement auto-resolved) |
Update an existing draft campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft campaign assignment ID |
| draft | object | no | Object containing campaign assignment fields to update |
Delete a draft campaign assignment
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft campaign assignment ID |
List all draft placements
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft placement ID |
Create a new draft placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this placement belongs to |
| draft | object | yes | Object containing placement fields (zone, advertisement, etc.) |
Update an existing draft placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft placement ID |
| draft | object | no | Object containing placement fields to update |
Delete a draft placement
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft placement ID |
List all draft schedules
| Parameter | Type | Required | Notes |
|---|---|---|---|
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific draft schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft schedule ID |
Create a new draft schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| campaign_draft_id | number | yes | Draft campaign ID this schedule belongs to |
| draft | object | yes | Object containing schedule fields |
Update an existing draft schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft schedule ID |
| draft | object | no | Object containing schedule fields to update |
Delete a draft schedule
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft schedule ID |
Save/publish a draft campaign (converts draft to live campaign)
| Parameter | Type | Required | Notes |
|---|---|---|---|
| id | number | yes | Draft campaign ID |
List all product catalogs for a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific product catalog
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| catalog_id | number | yes | Catalog ID |
Create a new product catalog for a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| name | string | no | Catalog name |
Update an existing product catalog
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| catalog_id | number | yes | Catalog ID |
| name | string | no | Catalog name |
Search for items in a product catalog
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| catalog_id | number | yes | Catalog ID |
| query | string | no | Search query string |
Get details of a specific product catalog item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| catalog_id | number | yes | Catalog ID |
| identifier | string | yes | Unique identifier for the catalog item |
Create a new item in a product catalog
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| catalog_id | number | yes | Catalog ID |
| name | string | no | Item name |
| identifier | string | no | Unique identifier for the catalog item |
| description | string | no | Item description |
| url | string | no | Item URL |
| image_url | string | no | Item image URL |
| price | string | no | Item price |
| category | string | no | Item category |
Update an existing product catalog item
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| catalog_id | number | yes | Catalog ID |
| identifier | string | yes | Unique identifier for the catalog item |
| name | string | no | Item name |
| description | string | no | Item description |
| url | string | no | Item URL |
| image_url | string | no | Item image URL |
| price | string | no | Item price |
| category | string | no | Item category |
Bulk upload items to a product catalog
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| catalog_id | number | yes | Catalog ID |
List all product sources for a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific product source
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| source_id | number | yes | Source ID |
Create a new product source for a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| name | string | no | Source name |
| url | string | no | Source URL |
| type | string | no | Source type |
Update an existing product source
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| source_id | number | yes | Source ID |
| name | string | no | Source name |
| url | string | no | Source URL |
| type | string | no | Source type |
Delete a product source
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| source_id | number | yes | Source ID |
Bulk create product sources for a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| sources | array | no | Array of source objects to create |
List all product source targets for a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| limit | number | no | Max results to return (default 100, max 100) |
| offset | number | no | Pagination offset |
Get details of a specific product source target
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| source_target_id | number | yes | Source target ID |
Create a new product source target for a publisher
| Parameter | Type | Required | Notes |
|---|---|---|---|
| publisher_id | number | yes | Publisher ID |
| name | string | no | Source target name |
| source_id | number | no | Source ID to target |
Free
$0 forever
- Every tool — any call limit is its publisher’s, not ours
- No card, and mcprush charges nothing for it
- Runs at its publisher’s own address — this marketplace is not in the path
- Nothing to cap, because mcprush bills nothing
What counts against your monthly calls
| Tool | Unit | Calls used | Out of the allowance |
|---|
Nothing here is billable: mcprush charges nothing to install AdButler or to call it, at any volume.
Call allowance · this installenforced at the gateway
Monthly allowance, in calls
—
—
Alert at 80% · then the tool returns a normal MCP error
Used this month: —
—Grade not published
No rule-by-rule report on file for this release
Two independent axes, because powerful and malicious are different questions. The grade is threat only. The capability level is blast radius, and it is never a penalty on the grade — it is priced as one subtract-only term in the score, where you can see it.
This listing is an address its publisher runs, and you connect to it directly — this marketplace is not in the path. The scanner reads packages and public source, and an address is neither. So there is no grade — not a withheld one, an unmeasured one.
Release history
This is an address its publisher runs: which release it serves is theirs to choose, so there is nothing here to pin. The history below is for reading; the current release on file is 2.6.2.
2.6.2
undated
latestNo release note was published with this version.
—
no reviews yet
Who can review
One review per account, from a signed-in account that does not publish this listing. Nothing else is asked — you can say what you think before you install it. Publishers can reply once per review, and a review can be edited or deleted by whoever wrote it.
Sign in to write one
Any signed-in account that does not publish AdButler can review it, once — before installing it or after. A review from an account that has installed it is marked as one.
No reviews yet
Nobody has reviewed this listing. The rating on the card is the mean of the reviews written here and nothing else, so there is no rating until somebody writes the first — which takes a signed-in account that does not publish it, and nothing else.