Manage AdButler campaigns, zones, ad items, VAST, and reports from Claude, ChatGPT, and Cursor.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Add values to a list attribute for a user
User ID
User database ID
List attribute name
Values to add
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
Add values to a list attribute for a user
| Argument | Type | Description |
|---|---|---|
| values | array | Values to add |
| user_id* | string | User ID |
| user_db_id* | number | User database ID |
| list_attribute_name* | string | List attribute name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"user_id",
"list_attribute_name"
],
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Values to add"
},
"user_id": {
"type": "string",
"description": "User ID"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
},
"list_attribute_name": {
"type": "string",
"description": "List attribute name"
}
},
"additionalProperties": false
}Archive an advertiser (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | Advertiser ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Advertiser ID"
}
},
"additionalProperties": false
}Archive a standard campaign (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign ID"
}
},
"additionalProperties": false
}Archive a channel (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | Channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Channel ID"
}
},
"additionalProperties": false
}Archive a contract (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Archive an email zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Email zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Email zone ID"
}
},
"additionalProperties": false
}Archive a publisher (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Archive a standard zone (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | Zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
}
},
"additionalProperties": false
}Bulk create product sources for a publisher
| Argument | Type | Description |
|---|---|---|
| sources | array | Array of source objects to create |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id"
],
"properties": {
"sources": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "Array of source objects to create"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Bulk add entries to a data list
| Argument | Type | Description |
|---|---|---|
| id* | number | Data list ID |
| data | string | CSV data to add |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data list ID"
},
"data": {
"type": "string",
"description": "CSV data to add"
}
},
"additionalProperties": false
}Bulk upload items to a product catalog
| Argument | Type | Description |
|---|---|---|
| catalog_id* | number | Catalog ID |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"catalog_id"
],
"properties": {
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Bulk remove entries from a data list
| Argument | Type | Description |
|---|---|---|
| id* | number | Data list ID |
| data | string | CSV data to remove |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data list ID"
},
"data": {
"type": "string",
"description": "CSV data to remove"
}
},
"additionalProperties": false
}Bulk replace all entries in a data list
| Argument | Type | Description |
|---|---|---|
| id* | number | Data list ID |
| data | string | CSV data to replace list with |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data list ID"
},
"data": {
"type": "string",
"description": "CSV data to replace list with"
}
},
"additionalProperties": false
}Bulk upload to replace all user data in a user database
| Argument | Type | Description |
|---|---|---|
| id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Call any AdButler API endpoint directly. Use this only when no specific tool wraps the endpoint you need. The session's configured API key is used automatically — do NOT pass an api_key argument. Substitute path placeholders via path_params: e.g. path="/campaigns/{id}", path_params={ "id": 123 } → /campaigns/123.
| Argument | Type | Description |
|---|---|---|
| body | object | JSON request body (for POST/PUT/PATCH). |
| path* | string | Endpoint path with `{placeholder}` syntax for path params, exactly as returned by search_adbutler_api (e.g. "/campaigns/{id}"). |
| method* | string | HTTP method, e.g. "GET", "POST", "PUT", "DELETE". |
| path_params | object | Map of path placeholder names to values, e.g. { "id": 123 }. |
| query_params | object | Query string parameters appended to the URL. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"method",
"path"
],
"properties": {
"body": {
"type": "object",
"description": "JSON request body (for POST/PUT/PATCH).",
"additionalProperties": {}
},
"path": {
"type": "string",
"description": "Endpoint path with `{placeholder}` syntax for path params, exactly as returned by search_adbutler_api (e.g. \"/campaigns/{id}\")."
},
"method": {
"type": "string",
"description": "HTTP method, e.g. \"GET\", \"POST\", \"PUT\", \"DELETE\"."
},
"path_params": {
"type": "object",
"description": "Map of path placeholder names to values, e.g. { \"id\": 123 }.",
"additionalProperties": {
"type": [
"string",
"number"
]
}
},
"query_params": {
"type": "object",
"description": "Query string parameters appended to the URL.",
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}Bulk create catalog ad items in a campaign
| Argument | Type | Description |
|---|---|---|
| items* | array | Array of catalog ad item objects to create |
| campaign_id* | number | Campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_id",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"description": "Array of catalog ad item objects to create"
},
"campaign_id": {
"type": "number",
"description": "Campaign ID"
}
},
"additionalProperties": false
}Bulk delete catalog ad items from a campaign
| Argument | Type | Description |
|---|---|---|
| items* | array | Array of catalog ad item IDs to delete |
| campaign_id* | number | Campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_id",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "number"
},
"description": "Array of catalog ad item IDs to delete"
},
"campaign_id": {
"type": "number",
"description": "Campaign ID"
}
},
"additionalProperties": false
}Cancel a signature request
| Argument | Type | Description |
|---|---|---|
| request_id* | number | Signature request ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"request_id"
],
"properties": {
"request_id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Convert a native ad item to an image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Native ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Native ad item ID"
}
},
"additionalProperties": false
}Create a new advertiser
| Argument | Type | Description |
|---|---|---|
| name* | string | Advertiser name |
| string | Contact email | |
| metadata | object | Custom metadata key-value pairs |
| password | string | Password for advertiser portal (min 8 chars, must include upper, lower, number) |
| can_add_ad_items | boolean | Whether advertiser can submit advertisements for scheduling |
| can_change_password | boolean | Whether advertiser can change password |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Advertiser name"
},
"email": {
"type": "string",
"description": "Contact email"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"password": {
"type": "string",
"description": "Password for advertiser portal (min 8 chars, must include upper, lower, number)"
},
"can_add_ad_items": {
"type": "boolean",
"description": "Whether advertiser can submit advertisements for scheduling"
},
"can_change_password": {
"type": "boolean",
"description": "Whether advertiser can change password"
}
},
"additionalProperties": false
}Create a new audience in a user database
| Argument | Type | Description |
|---|---|---|
| name | string | Audience name |
| attributes | object | Attribute targets defining the audience (e.g. { "gender": { "operator": "=", "operand": "male" } }) |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id"
],
"properties": {
"name": {
"type": "string",
"description": "Audience name"
},
"attributes": {
"type": "object",
"description": "Attribute targets defining the audience (e.g. { \"gender\": { \"operator\": \"=\", \"operand\": \"male\" } })",
"additionalProperties": {
"type": "object",
"required": [
"operator",
"operand"
],
"properties": {
"operand": {
"type": "string",
"description": "Value to compare against"
},
"operator": {
"type": "string",
"description": "Comparison operator (e.g. \"=\", \">=\", \"<=\", \"!=\")"
}
},
"additionalProperties": false
}
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Create a new audio creative. The API uses multipart file upload.
| Argument | Type | Description |
|---|---|---|
| name | string | Creative name |
| group* | number | Media group ID |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"group"
],
"properties": {
"name": {
"type": "string",
"description": "Creative name"
},
"group": {
"type": "number",
"description": "Media group ID"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Create a new beacon signing key
| Argument | Type | Description |
|---|---|---|
| key_name* | string | Beacon signing key name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"key_name"
],
"properties": {
"key_name": {
"type": "string",
"description": "Beacon signing key name"
}
},
"additionalProperties": false
}Create a new bidder
| Argument | Type | Description |
|---|---|---|
| name* | string | Bidder name |
| status | string | Bidder status |
| bid_url | string | Bid endpoint URL |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Bidder name"
},
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "Bidder status"
},
"bid_url": {
"type": "string",
"description": "Bid endpoint URL"
}
},
"additionalProperties": false
}Create a new standard campaign
| Argument | Type | Description |
|---|---|---|
| name* | string | Campaign name |
| budget | object | Budget limits (daily/weekly/monthly/lifetime) |
| contract | number | Contract ID (requires Contract Management add-on) |
| metadata | object | Custom metadata key-value pairs |
| advertiser | number | Advertiser ID |
| roadblock_tags | string | Tag to link campaign to a roadblock |
| targeting_source | string | Whether targeting is set at campaign or ad item level |
| scheduling_source | string | Whether scheduling is set at campaign or ad item level |
| trusted_redirect_domains | array | Array of trusted redirect domains |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Campaign name"
},
"budget": {
"type": "object",
"properties": {
"daily": {
"type": "number"
},
"weekly": {
"type": "number"
},
"monthly": {
"type": "number"
},
"lifetime": {
"type": "number"
}
},
"description": "Budget limits (daily/weekly/monthly/lifetime)",
"additionalProperties": false
},
"contract": {
"type": "number",
"description": "Contract ID (requires Contract Management add-on)"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"advertiser": {
"type": "number",
"description": "Advertiser ID"
},
"roadblock_tags": {
"type": "string",
"description": "Tag to link campaign to a roadblock"
},
"targeting_source": {
"enum": [
"CAMPAIGN",
"AD_ITEM"
],
"type": "string",
"description": "Whether targeting is set at campaign or ad item level"
},
"scheduling_source": {
"enum": [
"CAMPAIGN",
"AD_ITEM"
],
"type": "string",
"description": "Whether scheduling is set at campaign or ad item level"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of trusted redirect domains"
}
},
"additionalProperties": false
}Create a new campaign assignment (assign an ad item to a campaign)
| Argument | Type | Description |
|---|---|---|
| active | boolean | Whether assignment is active (defaults to true) |
| weight | number | Relative delivery weight (defaults to 1) |
| campaign* | object | Campaign object with id and type |
| keywords | string | Comma-separated keywords for targeting |
| schedule | number | Schedule ID (only if campaign scheduling_source is "AD_ITEM") |
| geo_target | number | Geo Target ID (only if campaign targeting_source is "AD_ITEM") |
| list_target | number | List Target ID |
| advertisement* | object | Advertisement object with id and type |
| data_key_target | number | Data Key Target ID |
| platform_target | number | Platform Target ID |
| keywords_match_method | string | Keyword matching method |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"advertisement",
"campaign"
],
"properties": {
"active": {
"type": "boolean",
"description": "Whether assignment is active (defaults to true)"
},
"weight": {
"type": "number",
"description": "Relative delivery weight (defaults to 1)"
},
"campaign": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign ID"
},
"type": {
"type": "string",
"const": "standard_campaign",
"description": "Campaign type"
}
},
"description": "Campaign object with id and type",
"additionalProperties": false
},
"keywords": {
"type": "string",
"description": "Comma-separated keywords for targeting"
},
"schedule": {
"type": "number",
"description": "Schedule ID (only if campaign scheduling_source is \"AD_ITEM\")"
},
"geo_target": {
"type": "number",
"description": "Geo Target ID (only if campaign targeting_source is \"AD_ITEM\")"
},
"list_target": {
"type": "number",
"description": "List Target ID"
},
"advertisement": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
},
"type": {
"type": "string",
"description": "Ad item type: \"image_ad_item\", \"custom_html_ad_item\", \"rich_media_ad_item\", \"native_ad_item\""
}
},
"description": "Advertisement object with id and type",
"additionalProperties": false
},
"data_key_target": {
"type": "number",
"description": "Data Key Target ID"
},
"platform_target": {
"type": "number",
"description": "Platform Target ID"
},
"keywords_match_method": {
"enum": [
"required",
"preferred",
"filtered"
],
"type": "string",
"description": "Keyword matching method"
}
},
"additionalProperties": false
}Create a new catalog ad item
| Argument | Type | Description |
|---|---|---|
| name* | string | Ad item name |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| catalog_id* | number | Catalog ID |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| catalog_item_identifier* | string | Unique identifier for the catalog item |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"catalog_id",
"catalog_item_identifier"
],
"properties": {
"name": {
"type": "string",
"description": "Ad item name"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"catalog_item_identifier": {
"type": "string",
"description": "Unique identifier for the catalog item"
}
},
"additionalProperties": false
}Create a new catalog zone for product/retail ad serving
| Argument | Type | Description |
|---|---|---|
| name* | string | Zone name |
| bid_floor | number | Default bid floor |
| publisher | number | Publisher ID |
| catalog_id* | number | Catalog ID |
| auction_type | string | Auction type |
| bid_floor_cpc | number | CPC bid floor |
| bid_floor_cpm | number | CPM bid floor |
| advertiser_cost_type | string | Billing model |
| click_cooldown_period | number | Click cooldown period in seconds (1-86400) |
| conversion_lookback_period | number | Conversion lookback period in seconds (1-7776000) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"catalog_id"
],
"properties": {
"name": {
"type": "string",
"description": "Zone name"
},
"bid_floor": {
"type": "number",
"description": "Default bid floor"
},
"publisher": {
"type": "number",
"description": "Publisher ID"
},
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"auction_type": {
"enum": [
"FIRST_PRICE",
"SECOND_PRICE"
],
"type": "string",
"description": "Auction type"
},
"bid_floor_cpc": {
"type": "number",
"description": "CPC bid floor"
},
"bid_floor_cpm": {
"type": "number",
"description": "CPM bid floor"
},
"advertiser_cost_type": {
"enum": [
"CPM",
"CPC"
],
"type": "string",
"description": "Billing model"
},
"click_cooldown_period": {
"type": "number",
"description": "Click cooldown period in seconds (1-86400)"
},
"conversion_lookback_period": {
"type": "number",
"description": "Conversion lookback period in seconds (1-7776000)"
}
},
"additionalProperties": false
}Create a new channel
| Argument | Type | Description |
|---|---|---|
| name* | string | Channel name |
| priority | string | Serving priority (default: standard) |
| use_share_of_voice | boolean | Whether to use share of voice as serving strategy (false = use weight) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Channel name"
},
"priority": {
"enum": [
"sponsorship",
"standard",
"network",
"bulk",
"house"
],
"type": "string",
"description": "Serving priority (default: standard)"
},
"use_share_of_voice": {
"type": "boolean",
"description": "Whether to use share of voice as serving strategy (false = use weight)"
}
},
"additionalProperties": false
}Assign a zone to a channel
| Argument | Type | Description |
|---|---|---|
| zone* | object | Zone object with id and type |
| channel* | number | Channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"channel",
"zone"
],
"properties": {
"zone": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
},
"type": {
"enum": [
"standard_zone",
"email_zone"
],
"type": "string",
"description": "Zone type (default: standard_zone)"
}
},
"description": "Zone object with id and type",
"additionalProperties": false
},
"channel": {
"type": "number",
"description": "Channel ID"
}
},
"additionalProperties": false
}Create a new contact
| Argument | Type | Description |
|---|---|---|
| name* | string | Contact name (full name recommended) |
| email* | string | Contact email address (must be unique) |
| notes | string | Additional notes about the contact |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"email"
],
"properties": {
"name": {
"type": "string",
"description": "Contact name (full name recommended)"
},
"email": {
"type": "string",
"description": "Contact email address (must be unique)"
},
"notes": {
"type": "string",
"description": "Additional notes about the contact"
}
},
"additionalProperties": false
}Create a new contract
| Argument | Type | Description |
|---|---|---|
| name* | string | Contract name |
| rate | number | Contract rate (in account currency) |
| end_at | string | Contract end date (YYYY-MM-DD) |
| status | string | Contract status |
| start_at | string | Contract start date (YYYY-MM-DD) |
| advertiser* | number | Advertiser ID |
| description | string | Contract description |
| payment_due_date | string | Payment due date (YYYY-MM-DD) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"advertiser"
],
"properties": {
"name": {
"type": "string",
"description": "Contract name"
},
"rate": {
"type": "number",
"description": "Contract rate (in account currency)"
},
"end_at": {
"type": "string",
"description": "Contract end date (YYYY-MM-DD)"
},
"status": {
"enum": [
"open",
"terminated",
"fulfilled",
"closed"
],
"type": "string",
"description": "Contract status"
},
"start_at": {
"type": "string",
"description": "Contract start date (YYYY-MM-DD)"
},
"advertiser": {
"type": "number",
"description": "Advertiser ID"
},
"description": {
"type": "string",
"description": "Contract description"
},
"payment_due_date": {
"type": "string",
"description": "Payment due date (YYYY-MM-DD)"
}
},
"additionalProperties": false
}Create a new document for a contract
| Argument | Type | Description |
|---|---|---|
| attributes | string | JSON-encoded object with name, admin_executed, vendor_executed fields |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id"
],
"properties": {
"attributes": {
"type": "string",
"description": "JSON-encoded object with name, admin_executed, vendor_executed fields"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Create a contract document from a template
| Argument | Type | Description |
|---|---|---|
| contract_id* | number | Contract ID |
| template_id | number | Template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id"
],
"properties": {
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"template_id": {
"type": "number",
"description": "Template ID"
}
},
"additionalProperties": false
}Create a new payment for a contract
| Argument | Type | Description |
|---|---|---|
| note | string | Payment note or description |
| amount* | number | Amount paid (can be negative for refunds) |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"amount"
],
"properties": {
"note": {
"type": "string",
"description": "Payment note or description"
},
"amount": {
"type": "number",
"description": "Amount paid (can be negative for refunds)"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Create a new contract template. Requires name, file, attributes (JSON string), email_subject, and email_body.
| Argument | Type | Description |
|---|---|---|
| file* | string | URL or path to the contract template file |
| name* | string | Template name |
| attributes* | string | JSON-encoded object containing name, email_subject, email_body, and optionally signing_service, basic_inputs, contract_column_inputs, signers |
| email_body* | string | Email body text when sending for signature |
| email_subject* | string | Email subject line when sending for signature |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"file",
"attributes",
"email_subject",
"email_body"
],
"properties": {
"file": {
"type": "string",
"description": "URL or path to the contract template file"
},
"name": {
"type": "string",
"description": "Template name"
},
"attributes": {
"type": "string",
"description": "JSON-encoded object containing name, email_subject, email_body, and optionally signing_service, basic_inputs, contract_column_inputs, signers"
},
"email_body": {
"type": "string",
"description": "Email body text when sending for signature"
},
"email_subject": {
"type": "string",
"description": "Email subject line when sending for signature"
}
},
"additionalProperties": false
}Create a new image creative. The API uses multipart file upload — pass the media group ID and file attributes.
| Argument | Type | Description |
|---|---|---|
| name | string | Creative name |
| group* | number | Media group ID |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"group"
],
"properties": {
"name": {
"type": "string",
"description": "Creative name"
},
"group": {
"type": "number",
"description": "Media group ID"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Create a new custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| name* | string | Ad item name |
| width | number | Ad width in pixels (0 for flexible) |
| height | number | Ad height in pixels (0 for flexible) |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| custom_html* | string | The HTML content of the ad item |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| html_content_below | string | HTML content below the ad item |
| trusted_redirect_domains | array | Trusted redirect domains |
| expand_vertical_direction | string | Vertical expand direction |
| expand_horizontal_direction | string | Horizontal expand direction |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"custom_html"
],
"properties": {
"name": {
"type": "string",
"description": "Ad item name"
},
"width": {
"type": "number",
"description": "Ad width in pixels (0 for flexible)"
},
"height": {
"type": "number",
"description": "Ad height in pixels (0 for flexible)"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"custom_html": {
"type": "string",
"description": "The HTML content of the ad item"
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"html_content_below": {
"type": "string",
"description": "HTML content below the ad item"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
},
"expand_vertical_direction": {
"enum": [
"none",
"up",
"down"
],
"type": "string",
"description": "Vertical expand direction"
},
"expand_horizontal_direction": {
"enum": [
"none",
"left",
"right"
],
"type": "string",
"description": "Horizontal expand direction"
}
},
"additionalProperties": false
}Create a new report configuration
| Argument | Type | Description |
|---|---|---|
| date* | object | Date configuration (either preset or start+end required) |
| name* | string | Report name |
| type* | string | Report type |
| period* | string | Data grouping period |
| columns | array | Columns to include: impressions, eligible, viewable, clicks, conversions, ctr, cvr, e_cpm, e_cpc, e_cpa, cost, payout, revenue |
| filters | object | Filter criteria: { publishers: [...], advertisers: [...], zones: [...], campaigns: [...], ad_items: [...], channels: [...] } |
| exclude_channel_stats | boolean | Exclude stats from channel-served ads |
| require_channel_stats | boolean | Only include stats from channel-served ads |
| exclude_campaign_ad_items | boolean | Exclude ad items in campaigns |
| exclude_publisher_ad_items | boolean | Exclude ad items directly in zones |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"type",
"period",
"date"
],
"properties": {
"date": {
"type": "object",
"properties": {
"end": {
"type": "string",
"description": "Custom end date (ISO 8601 format)"
},
"start": {
"type": "string",
"description": "Custom start date (ISO 8601 format)"
},
"preset": {
"type": "string",
"description": "Date preset (today, yesterday, last-7-days, last-30-days, etc.)"
},
"timezone": {
"type": "string",
"description": "Timezone (e.g. \"America/Toronto\")"
}
},
"description": "Date configuration (either preset or start+end required)",
"additionalProperties": false
},
"name": {
"type": "string",
"description": "Report name"
},
"type": {
"enum": [
"overview",
"advertiser",
"publisher",
"zone",
"campaign",
"channel",
"geo-target",
"ad-item"
],
"type": "string",
"description": "Report type"
},
"period": {
"enum": [
"day",
"week",
"month",
"year"
],
"type": "string",
"description": "Data grouping period"
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Columns to include: impressions, eligible, viewable, clicks, conversions, ctr, cvr, e_cpm, e_cpc, e_cpa, cost, payout, revenue"
},
"filters": {
"type": "object",
"description": "Filter criteria: { publishers: [...], advertisers: [...], zones: [...], campaigns: [...], ad_items: [...], channels: [...] }",
"additionalProperties": {}
},
"exclude_channel_stats": {
"type": "boolean",
"description": "Exclude stats from channel-served ads"
},
"require_channel_stats": {
"type": "boolean",
"description": "Only include stats from channel-served ads"
},
"exclude_campaign_ad_items": {
"type": "boolean",
"description": "Exclude ad items in campaigns"
},
"exclude_publisher_ad_items": {
"type": "boolean",
"description": "Exclude ad items directly in zones"
}
},
"additionalProperties": false
}Create a new data key for custom targeting
| Argument | Type | Description |
|---|---|---|
| name* | string | Data key name (max 32 chars, must be unique) |
| type* | string | Data key value type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Data key name (max 32 chars, must be unique)"
},
"type": {
"enum": [
"STRING",
"NUMBER",
"DATE",
"DATETIME",
"TIME"
],
"type": "string",
"description": "Data key value type"
}
},
"additionalProperties": false
}Create a new data key target (targeting rule)
| Argument | Type | Description |
|---|---|---|
| name* | string | Data key target name |
| target* | string | JSON formatted target logic, e.g. ["OR", {"my_number": {"=": "5"}}, {"my_string": {"=": "test"}}] |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"target"
],
"properties": {
"name": {
"type": "string",
"description": "Data key target name"
},
"target": {
"type": "string",
"description": "JSON formatted target logic, e.g. [\"OR\", {\"my_number\": {\"=\": \"5\"}}, {\"my_string\": {\"=\": \"test\"}}]"
}
},
"additionalProperties": false
}Create a new data list
| Argument | Type | Description |
|---|---|---|
| label* | string | Data list label/name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"label"
],
"properties": {
"label": {
"type": "string",
"description": "Data list label/name"
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| name | string | Day parting name |
| ranges | object | Object mapping day names (monday-sunday) to arrays of time ranges like "09:00:00-17:00:00" |
| is_template | boolean | If true, shown in UI when creating/editing schedules |
| use_member_timezone | boolean | If true, use account timezone; if false, use viewer timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Day parting name"
},
"ranges": {
"type": "object",
"description": "Object mapping day names (monday-sunday) to arrays of time ranges like \"09:00:00-17:00:00\"",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"is_template": {
"type": "boolean",
"description": "If true, shown in UI when creating/editing schedules"
},
"use_member_timezone": {
"type": "boolean",
"description": "If true, use account timezone; if false, use viewer timezone"
}
},
"additionalProperties": false
}Create a new demand endpoint
| Argument | Type | Description |
|---|---|---|
| name* | string | Demand endpoint name |
| status | string | Whether to send bid requests (default: active) |
| priority | string | Serving priority |
| bid_floor | number | Default CPM bid floor |
| geo_target | number | Geo target ID for geographic targeting |
| filter_type | string | Zone filtering type |
| allowed_sizes | array | Allowed zone sizes (e.g. ["300x250", "728x90"]) |
| demand_source* | number | Demand Source ID this endpoint belongs to |
| revenue_share | number | Revenue share percentage paid to publisher |
| filtered_zones | array | Zone IDs for the filter list |
| markup_percent | number | Markup percent applied to zone bid floor |
| supported_formats* | array | Supported ad formats: "display", "native", "video" |
| default_parameters* | object | Default parameters for the endpoint (e.g. { url: "https://..." }) |
| filtered_vast_zones | array | VAST zone IDs for the filter list |
| native_json_encoded | boolean | Whether native JSON should be encoded |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"demand_source",
"default_parameters",
"supported_formats"
],
"properties": {
"name": {
"type": "string",
"description": "Demand endpoint name"
},
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "Whether to send bid requests (default: active)"
},
"priority": {
"enum": [
"sponsorship",
"standard",
"network",
"bulk",
"house"
],
"type": "string",
"description": "Serving priority"
},
"bid_floor": {
"type": "number",
"description": "Default CPM bid floor"
},
"geo_target": {
"type": "number",
"description": "Geo target ID for geographic targeting"
},
"filter_type": {
"enum": [
"all",
"whitelist",
"blacklist"
],
"type": "string",
"description": "Zone filtering type"
},
"allowed_sizes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed zone sizes (e.g. [\"300x250\", \"728x90\"])"
},
"demand_source": {
"type": "number",
"description": "Demand Source ID this endpoint belongs to"
},
"revenue_share": {
"type": "number",
"description": "Revenue share percentage paid to publisher"
},
"filtered_zones": {
"type": "array",
"items": {
"type": "number"
},
"description": "Zone IDs for the filter list"
},
"markup_percent": {
"type": "number",
"description": "Markup percent applied to zone bid floor"
},
"supported_formats": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supported ad formats: \"display\", \"native\", \"video\""
},
"default_parameters": {
"type": "object",
"description": "Default parameters for the endpoint (e.g. { url: \"https://...\" })",
"additionalProperties": {}
},
"filtered_vast_zones": {
"type": "array",
"items": {
"type": "number"
},
"description": "VAST zone IDs for the filter list"
},
"native_json_encoded": {
"type": "boolean",
"description": "Whether native JSON should be encoded"
}
},
"additionalProperties": false
}Create a new demand source
| Argument | Type | Description |
|---|---|---|
| name* | string | Demand source name |
| status | string | Whether to send bid requests (default: active) |
| network* | string | Network type: 'adview', 'aerserv', 'inmobi', 'inneractive', 'loopme', 'mobilefuse', 'onebyaol', 'pubmatic', 'pubnative', 'smaato', 'startapp', 'tappx', 'consumable', 'bidphysics', or 'openrtb' |
| spend_limit | number | Spend limit amount |
| spend_limit_end | string | Spend limit end date (ISO-8601) |
| spend_limit_start | string | Spend limit start date (ISO-8601) |
| spend_limit_period | string | Spend limit reset interval |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"network"
],
"properties": {
"name": {
"type": "string",
"description": "Demand source name"
},
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "Whether to send bid requests (default: active)"
},
"network": {
"type": "string",
"description": "Network type: 'adview', 'aerserv', 'inmobi', 'inneractive', 'loopme', 'mobilefuse', 'onebyaol', 'pubmatic', 'pubnative', 'smaato', 'startapp', 'tappx', 'consumable', 'bidphysics', or 'openrtb'"
},
"spend_limit": {
"type": "number",
"description": "Spend limit amount"
},
"spend_limit_end": {
"type": "string",
"description": "Spend limit end date (ISO-8601)"
},
"spend_limit_start": {
"type": "string",
"description": "Spend limit start date (ISO-8601)"
},
"spend_limit_period": {
"enum": [
"once",
"weekly",
"biweekly",
"monthly",
"quarterly"
],
"type": "string",
"description": "Spend limit reset interval"
}
},
"additionalProperties": false
}Create a new email zone for serving ads in email newsletters
| Argument | Type | Description |
|---|---|---|
| name* | string | Zone name |
| width* | number | Zone width in pixels |
| height* | number | Zone height in pixels |
| metadata | object | Custom metadata key-value pairs |
| publisher | number | Publisher ID |
| uid_rotate | boolean | Serve different ads per user |
| rotate_timer | object | Period after which user sees a new ad |
| auction_tie_break | string | Tie-breaking method for auctions |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"width",
"height"
],
"properties": {
"name": {
"type": "string",
"description": "Zone name"
},
"width": {
"type": "number",
"description": "Zone width in pixels"
},
"height": {
"type": "number",
"description": "Zone height in pixels"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"publisher": {
"type": "number",
"description": "Publisher ID"
},
"uid_rotate": {
"type": "boolean",
"description": "Serve different ads per user"
},
"rotate_timer": {
"type": "object",
"required": [
"amount",
"interval"
],
"properties": {
"amount": {
"type": "number",
"description": "Period amount"
},
"interval": {
"enum": [
"minutes",
"days"
],
"type": "string",
"description": "Period interval"
}
},
"description": "Period after which user sees a new ad",
"additionalProperties": false
},
"auction_tie_break": {
"enum": [
"RANDOM",
"SCORE"
],
"type": "string",
"description": "Tie-breaking method for auctions"
}
},
"additionalProperties": false
}Create a new event log upload configuration
| Argument | Type | Description |
|---|---|---|
| name | string | Configuration name |
| format | string | Log file format |
| enabled | boolean | Whether the upload configuration is enabled |
| frequency | string | Upload frequency (e.g. "daily", "hourly") |
| connection_id | number | SFTP connection ID to use for upload |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Configuration name"
},
"format": {
"type": "string",
"description": "Log file format"
},
"enabled": {
"type": "boolean",
"description": "Whether the upload configuration is enabled"
},
"frequency": {
"type": "string",
"description": "Upload frequency (e.g. \"daily\", \"hourly\")"
},
"connection_id": {
"type": "number",
"description": "SFTP connection ID to use for upload"
}
},
"additionalProperties": false
}Create a new geo target for geographic targeting. Areas is an array of objects with continent, country (2-letter code), region, city fields.
| Argument | Type | Description |
|---|---|---|
| name* | string | Geo target name |
| unit | string | Distance unit for range |
| areas* | array | Array of geographic areas to target |
| range | number | Radius range for geo-fencing (only applies when targeting a city) |
| inclusive | boolean | If true, target users IN these areas; if false, EXCLUDE these areas |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"areas"
],
"properties": {
"name": {
"type": "string",
"description": "Geo target name"
},
"unit": {
"enum": [
"miles",
"kilometers"
],
"type": "string",
"description": "Distance unit for range"
},
"areas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City name (e.g., \"San Francisco\")"
},
"region": {
"type": "string",
"description": "Region/state (e.g., \"California\")"
},
"country": {
"type": "string",
"description": "Two-letter country code (e.g., \"US\", \"CA\")"
},
"continent": {
"type": "string",
"description": "Continent name (e.g. \"North America\", \"Europe\"). Not needed if country is provided."
}
},
"additionalProperties": false
},
"description": "Array of geographic areas to target"
},
"range": {
"type": "number",
"description": "Radius range for geo-fencing (only applies when targeting a city)"
},
"inclusive": {
"type": "boolean",
"description": "If true, target users IN these areas; if false, EXCLUDE these areas"
}
},
"additionalProperties": false
}Create a new image ad item (banner)
| Argument | Type | Description |
|---|---|---|
| name* | string | Ad item name |
| width | number | Ad width in pixels (defaults to 0) |
| height | number | Ad height in pixels (defaults to 0) |
| creative | number | Image creative ID (mutually exclusive with creative_url) |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| html_target | string | Window/frame for destination URL (e.g. "_blank") |
| creative_url | string | URL to image file — PNG, JPEG, or GIF (mutually exclusive with creative) |
| html_alt_text | string | Alt text for the image |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| html_content_below | string | HTML content below the ad item |
| trusted_redirect_domains | array | Trusted redirect domains |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Ad item name"
},
"width": {
"type": "number",
"description": "Ad width in pixels (defaults to 0)"
},
"height": {
"type": "number",
"description": "Ad height in pixels (defaults to 0)"
},
"creative": {
"type": "number",
"description": "Image creative ID (mutually exclusive with creative_url)"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"html_target": {
"type": "string",
"description": "Window/frame for destination URL (e.g. \"_blank\")"
},
"creative_url": {
"type": "string",
"description": "URL to image file — PNG, JPEG, or GIF (mutually exclusive with creative)"
},
"html_alt_text": {
"type": "string",
"description": "Alt text for the image"
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"html_content_below": {
"type": "string",
"description": "HTML content below the ad item"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
}
},
"additionalProperties": false
}Create a new list target (inclusion/exclusion using a data list)
| Argument | Type | Description |
|---|---|---|
| label* | string | List target name |
| data_list | number | Data list ID containing the values to target |
| inclusive | boolean | If true, inclusion target; if false, exclusion target |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"label"
],
"properties": {
"label": {
"type": "string",
"description": "List target name"
},
"data_list": {
"type": "number",
"description": "Data list ID containing the values to target"
},
"inclusive": {
"type": "boolean",
"description": "If true, inclusion target; if false, exclusion target"
}
},
"additionalProperties": false
}Create a new manager
| Argument | Type | Description |
|---|---|---|
| name* | string | Manager name |
| email* | string | Manager email address |
| notes | string | Notes about the manager |
| password | string | Login password (min 8 chars with upper, lower, number). Random if blank. |
| position | string | Manager position in organization |
| is_enabled | boolean | Whether the manager account is enabled |
| can_manage_links | boolean | Can create/edit/delete active tracking links |
| can_manage_media | boolean | Can manage creatives and media groups |
| can_manage_users | boolean | Can manage user accounts and permissions |
| publisher_access | string | Publisher access level |
| statistics_access | string | Statistics access level |
| can_manage_bidders | boolean | Can manage bidders |
| can_manage_billing | boolean | Can view invoices and billing |
| can_manage_targets | boolean | Can assign/remove targets from placements |
| can_manage_tickets | boolean | Can create/view support tickets |
| can_manage_contracts | boolean | Can manage contracts and templates |
| can_manage_data_keys | boolean | Can manage data keys |
| can_manage_product_db | boolean | Can manage product catalogs |
| can_manage_self_serve | boolean | Can manage Self-Serve portals |
| publisher_access_list | array | Publisher IDs accessible when publisher_access is "specific" |
| can_manage_programmatic | boolean | Can manage demand sources and PMP deals |
| can_manage_admin_api_access | boolean | Can manage API keys |
| can_assign_campaigns_directly | boolean | Can assign campaigns directly to zones |
| can_manage_native_ad_templates | boolean | Can manage native templates |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"email"
],
"properties": {
"name": {
"type": "string",
"description": "Manager name"
},
"email": {
"type": "string",
"description": "Manager email address"
},
"notes": {
"type": "string",
"description": "Notes about the manager"
},
"password": {
"type": "string",
"description": "Login password (min 8 chars with upper, lower, number). Random if blank."
},
"position": {
"type": "string",
"description": "Manager position in organization"
},
"is_enabled": {
"type": "boolean",
"description": "Whether the manager account is enabled"
},
"can_manage_links": {
"type": "boolean",
"description": "Can create/edit/delete active tracking links"
},
"can_manage_media": {
"type": "boolean",
"description": "Can manage creatives and media groups"
},
"can_manage_users": {
"type": "boolean",
"description": "Can manage user accounts and permissions"
},
"publisher_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Publisher access level"
},
"statistics_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Statistics access level"
},
"can_manage_bidders": {
"type": "boolean",
"description": "Can manage bidders"
},
"can_manage_billing": {
"type": "boolean",
"description": "Can view invoices and billing"
},
"can_manage_targets": {
"type": "boolean",
"description": "Can assign/remove targets from placements"
},
"can_manage_tickets": {
"type": "boolean",
"description": "Can create/view support tickets"
},
"can_manage_contracts": {
"type": "boolean",
"description": "Can manage contracts and templates"
},
"can_manage_data_keys": {
"type": "boolean",
"description": "Can manage data keys"
},
"can_manage_product_db": {
"type": "boolean",
"description": "Can manage product catalogs"
},
"can_manage_self_serve": {
"type": "boolean",
"description": "Can manage Self-Serve portals"
},
"publisher_access_list": {
"type": "array",
"items": {
"type": "number"
},
"description": "Publisher IDs accessible when publisher_access is \"specific\""
},
"can_manage_programmatic": {
"type": "boolean",
"description": "Can manage demand sources and PMP deals"
},
"can_manage_admin_api_access": {
"type": "boolean",
"description": "Can manage API keys"
},
"can_assign_campaigns_directly": {
"type": "boolean",
"description": "Can assign campaigns directly to zones"
},
"can_manage_native_ad_templates": {
"type": "boolean",
"description": "Can manage native templates"
}
},
"additionalProperties": false
}Create a new media group
| Argument | Type | Description |
|---|---|---|
| name* | string | Media group name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Media group name"
}
},
"additionalProperties": false
}Create a new native ad item using a native template
| Argument | Type | Description |
|---|---|---|
| name* | string | Ad item name |
| width | number | Ad width in pixels |
| height | number | Ad height in pixels |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| template* | number | Native template ID |
| variables* | object | Template variables as key-value pairs (keys should be integer strings) |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| trusted_redirect_domains | array | Trusted redirect domains |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"template",
"variables"
],
"properties": {
"name": {
"type": "string",
"description": "Ad item name"
},
"width": {
"type": "number",
"description": "Ad width in pixels"
},
"height": {
"type": "number",
"description": "Ad height in pixels"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"template": {
"type": "number",
"description": "Native template ID"
},
"variables": {
"type": "object",
"description": "Template variables as key-value pairs (keys should be integer strings)",
"additionalProperties": {
"type": "string"
}
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
}
},
"additionalProperties": false
}Create a new native ad template with HTML and variable placeholders
| Argument | Type | Description |
|---|---|---|
| name* | string | Template name |
| raw_html* | string | HTML template content with variable placeholders (e.g. "[%title%]") |
| variables* | array | Array of template variables |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"raw_html",
"variables"
],
"properties": {
"name": {
"type": "string",
"description": "Template name"
},
"raw_html": {
"type": "string",
"description": "HTML template content with variable placeholders (e.g. \"[%title%]\")"
},
"variables": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"placeholder",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Variable name"
},
"type": {
"enum": [
"url",
"url_raw",
"text",
"file",
"number",
"image_url",
"dropdown",
"third_party_script"
],
"type": "string",
"description": "Variable type"
},
"optional": {
"type": "boolean",
"description": "Whether the variable can be left blank (default: false)"
},
"max_length": {
"type": "number",
"description": "Max length for text variables"
},
"placeholder": {
"type": "string",
"description": "Placeholder in raw_html (e.g. \"[%title%]\")"
},
"dropdown_values": {
"type": "string",
"description": "Comma-separated options for dropdown variables"
}
},
"additionalProperties": false
},
"description": "Array of template variables"
}
},
"additionalProperties": false
}Create a new data asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| len | number | Max length |
| type | number | Data asset type |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"len": {
"type": "number",
"description": "Max length"
},
"type": {
"type": "number",
"description": "Data asset type"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Create a new image asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| h | number | Height |
| w | number | Width |
| hmin | number | Min height |
| type | number | Image asset type |
| wmin | number | Min width |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"h": {
"type": "number",
"description": "Height"
},
"w": {
"type": "number",
"description": "Width"
},
"hmin": {
"type": "number",
"description": "Min height"
},
"type": {
"type": "number",
"description": "Image asset type"
},
"wmin": {
"type": "number",
"description": "Min width"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Create a new OpenRTB native template
| Argument | Type | Description |
|---|---|---|
| name | string | ORTB native template name |
| html_template | string | HTML template for rendering the native ad (e.g. "<div>{{title}}</div>") |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "ORTB native template name"
},
"html_template": {
"type": "string",
"description": "HTML template for rendering the native ad (e.g. \"<div>{{title}}</div>\")"
}
},
"additionalProperties": false
}Create a new title asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| len | number | Max length of title |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"len": {
"type": "number",
"description": "Max length of title"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Create a new placement (assign an ad item or campaign to a zone or channel)
| Argument | Type | Description |
|---|---|---|
| cost | object | Pricing model: fixed_cost OR cpm/cpc/cpa |
| zone | object | Zone object (required if channel not set; mutually exclusive with channel) |
| active | boolean | Whether placement is active (defaults to true) |
| payout | object | Publisher payout configuration |
| weight | number | Relative delivery weight |
| channel | number | Channel ID (required if zone not set; mutually exclusive with zone) |
| keywords | string | Comma-separated keywords for targeting |
| priority | string | Serving priority level (defaults to "standard") |
| schedule* | number | Schedule ID |
| geo_target | number | Geotarget ID |
| list_target | number | List Target ID |
| serve_method | string | Serving system: weight-based or auction-based |
| advertisement* | object | Advertisement object with id and type |
| share_of_voice | number | Share of voice percentage (required when zone uses share_of_voice) |
| platform_target | number | Platform target ID |
| data_key_target_id | number | Data Key Target ID (Enterprise only) |
| contextual_segments | array | Array of contextual segment IDs |
| keywords_match_method | string | Keyword matching method |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"advertisement",
"schedule"
],
"properties": {
"cost": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"fixed_cost": {
"type": "number"
}
},
"description": "Pricing model: fixed_cost OR cpm/cpc/cpa",
"additionalProperties": false
},
"zone": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
},
"type": {
"enum": [
"standard_zone",
"text_zone",
"email_zone"
],
"type": "string",
"description": "Zone type"
}
},
"description": "Zone object (required if channel not set; mutually exclusive with channel)",
"additionalProperties": false
},
"active": {
"type": "boolean",
"description": "Whether placement is active (defaults to true)"
},
"payout": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"type": {
"enum": [
"rate",
"percent"
],
"type": "string"
},
"fixed": {
"type": "number"
}
},
"description": "Publisher payout configuration",
"additionalProperties": false
},
"weight": {
"type": "number",
"description": "Relative delivery weight"
},
"channel": {
"type": "number",
"description": "Channel ID (required if zone not set; mutually exclusive with zone)"
},
"keywords": {
"type": "string",
"description": "Comma-separated keywords for targeting"
},
"priority": {
"enum": [
"sponsorship",
"standard",
"network",
"bulk",
"house"
],
"type": "string",
"description": "Serving priority level (defaults to \"standard\")"
},
"schedule": {
"type": "number",
"description": "Schedule ID"
},
"geo_target": {
"type": "number",
"description": "Geotarget ID"
},
"list_target": {
"type": "number",
"description": "List Target ID"
},
"serve_method": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Serving system: weight-based or auction-based"
},
"advertisement": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item or campaign ID"
},
"type": {
"type": "string",
"description": "Type: \"image_ad_item\", \"custom_html_ad_item\", \"rich_media_ad_item\", \"native_ad_item\", \"standard_campaign\""
}
},
"description": "Advertisement object with id and type",
"additionalProperties": false
},
"share_of_voice": {
"type": "number",
"description": "Share of voice percentage (required when zone uses share_of_voice)"
},
"platform_target": {
"type": "number",
"description": "Platform target ID"
},
"data_key_target_id": {
"type": "number",
"description": "Data Key Target ID (Enterprise only)"
},
"contextual_segments": {
"type": "array",
"items": {
"type": "number"
},
"description": "Array of contextual segment IDs"
},
"keywords_match_method": {
"enum": [
"required",
"preferred",
"filtered"
],
"type": "string",
"description": "Keyword matching method"
}
},
"additionalProperties": false
}Create a new platform target for device/OS/browser targeting
| Argument | Type | Description |
|---|---|---|
| name* | string | Platform target name |
| platform | string | Preset platform target (default: any) |
| device_targets | array | List of device patterns to target (e.g. "Apple*", "Samsung Galaxy S5") |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Platform target name"
},
"platform": {
"enum": [
"any",
"specific",
"mobile",
"tablet",
"mobile_and_tablet",
"desktop"
],
"type": "string",
"description": "Preset platform target (default: any)"
},
"device_targets": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of device patterns to target (e.g. \"Apple*\", \"Samsung Galaxy S5\")"
}
},
"additionalProperties": false
}Create a new PMP deal
| Argument | Type | Description |
|---|---|---|
| name | string | PMP deal name |
| bid_floor | number | Bid floor for this deal |
| geo_target | number | Geo target ID (0 = no targeting) |
| audience_target | number | Audience target ID (null = no targeting) |
| whitelist_seats | array | Seat IDs with access to this deal |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "PMP deal name"
},
"bid_floor": {
"type": "number",
"description": "Bid floor for this deal"
},
"geo_target": {
"type": "number",
"description": "Geo target ID (0 = no targeting)"
},
"audience_target": {
"type": "number",
"description": "Audience target ID (null = no targeting)"
},
"whitelist_seats": {
"type": "array",
"items": {
"type": "string"
},
"description": "Seat IDs with access to this deal"
}
},
"additionalProperties": false
}Create a new postal code target
| Argument | Type | Description |
|---|---|---|
| label* | string | Postal code target name |
| inclusive | boolean | If true, inclusion target; if false, exclusion target |
| locations* | array | Array of locations grouped by country |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"label",
"locations"
],
"properties": {
"label": {
"type": "string",
"description": "Postal code target name"
},
"inclusive": {
"type": "boolean",
"description": "If true, inclusion target; if false, exclusion target"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"required": [
"country",
"postal_codes"
],
"properties": {
"country": {
"type": "string",
"description": "Two-letter country code (e.g. \"JP\", \"US\")"
},
"postal_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of postal codes for this country"
}
},
"additionalProperties": false
},
"description": "Array of locations grouped by country"
}
},
"additionalProperties": false
}Create a new product catalog for a publisher
| Argument | Type | Description |
|---|---|---|
| name | string | Catalog name |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id"
],
"properties": {
"name": {
"type": "string",
"description": "Catalog name"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Create a new item in a product catalog
| Argument | Type | Description |
|---|---|---|
| url | string | Item URL |
| name | string | Item name |
| price | string | Item price |
| category | string | Item category |
| image_url | string | Item image URL |
| catalog_id* | number | Catalog ID |
| identifier | string | Unique identifier for the catalog item |
| description | string | Item description |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"catalog_id"
],
"properties": {
"url": {
"type": "string",
"description": "Item URL"
},
"name": {
"type": "string",
"description": "Item name"
},
"price": {
"type": "string",
"description": "Item price"
},
"category": {
"type": "string",
"description": "Item category"
},
"image_url": {
"type": "string",
"description": "Item image URL"
},
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"identifier": {
"type": "string",
"description": "Unique identifier for the catalog item"
},
"description": {
"type": "string",
"description": "Item description"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Create a new product source for a publisher
| Argument | Type | Description |
|---|---|---|
| url | string | Source URL |
| name | string | Source name |
| type | string | Source type |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id"
],
"properties": {
"url": {
"type": "string",
"description": "Source URL"
},
"name": {
"type": "string",
"description": "Source name"
},
"type": {
"type": "string",
"description": "Source type"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Create a new product source target for a publisher
| Argument | Type | Description |
|---|---|---|
| name | string | Source target name |
| source_id | number | Source ID to target |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id"
],
"properties": {
"name": {
"type": "string",
"description": "Source target name"
},
"source_id": {
"type": "number",
"description": "Source ID to target"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Create a new publisher
| Argument | Type | Description |
|---|---|---|
| name* | string | Publisher name |
| string | Contact email (allows publisher to log in) | |
| domain | string | Publisher domain (top-level domains only) |
| metadata | object | Custom metadata key-value pairs |
| timezone | string | Timezone (e.g., "America/New_York") |
| seller_type | string | Seller type for ads.txt |
| default_payout | object | Default payout configuration |
| can_approve_ads | boolean | Allow publisher to approve/deny ad items |
| can_admin_account | boolean | Grant administrator privileges |
| can_change_password | boolean | Whether publisher can change password |
| can_view_wordpress_key | boolean | Allow publisher to view WordPress key |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Publisher name"
},
"email": {
"type": "string",
"description": "Contact email (allows publisher to log in)"
},
"domain": {
"type": "string",
"description": "Publisher domain (top-level domains only)"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"timezone": {
"type": "string",
"description": "Timezone (e.g., \"America/New_York\")"
},
"seller_type": {
"enum": [
"publisher",
"intermediary",
"both"
],
"type": "string",
"description": "Seller type for ads.txt"
},
"default_payout": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"type": {
"enum": [
"rate",
"percent"
],
"type": "string"
},
"fixed": {
"type": "number"
}
},
"description": "Default payout configuration",
"additionalProperties": false
},
"can_approve_ads": {
"type": "boolean",
"description": "Allow publisher to approve/deny ad items"
},
"can_admin_account": {
"type": "boolean",
"description": "Grant administrator privileges"
},
"can_change_password": {
"type": "boolean",
"description": "Whether publisher can change password"
},
"can_view_wordpress_key": {
"type": "boolean",
"description": "Allow publisher to view WordPress key"
}
},
"additionalProperties": false
}Create a new report schedule
| Argument | Type | Description |
|---|---|---|
| frequency | string | Schedule frequency |
| recipients | array | Array of recipient objects |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id"
],
"properties": {
"frequency": {
"type": "string",
"description": "Schedule frequency"
},
"recipients": {
"type": "array",
"items": {},
"description": "Array of recipient objects"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Create a new rich media ad item
| Argument | Type | Description |
|---|---|---|
| name* | string | Ad item name |
| width | number | Ad width in pixels |
| height | number | Ad height in pixels |
| creative* | number | Rich media creative ID |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| html_content_below | string | HTML content below the ad item |
| trusted_redirect_domains | array | Trusted redirect domains |
| expand_vertical_direction | string | Vertical expand direction |
| expand_horizontal_direction | string | Horizontal expand direction |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"creative"
],
"properties": {
"name": {
"type": "string",
"description": "Ad item name"
},
"width": {
"type": "number",
"description": "Ad width in pixels"
},
"height": {
"type": "number",
"description": "Ad height in pixels"
},
"creative": {
"type": "number",
"description": "Rich media creative ID"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"html_content_below": {
"type": "string",
"description": "HTML content below the ad item"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
},
"expand_vertical_direction": {
"enum": [
"none",
"up",
"down"
],
"type": "string",
"description": "Vertical expand direction"
},
"expand_horizontal_direction": {
"enum": [
"none",
"left",
"right"
],
"type": "string",
"description": "Horizontal expand direction"
}
},
"additionalProperties": false
}Create a new rich media creative. The API uses multipart file upload (ZIP for HTML5).
| Argument | Type | Description |
|---|---|---|
| name | string | Creative name |
| group* | number | Media group ID |
| description | string | Creative description |
| index_file_path | string | Path to index HTML file inside ZIP archive (for HTML5) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"group"
],
"properties": {
"name": {
"type": "string",
"description": "Creative name"
},
"group": {
"type": "number",
"description": "Media group ID"
},
"description": {
"type": "string",
"description": "Creative description"
},
"index_file_path": {
"type": "string",
"description": "Path to index HTML file inside ZIP archive (for HTML5)"
}
},
"additionalProperties": false
}Create a new role with permission settings
| Argument | Type | Description |
|---|---|---|
| name* | string | Role name |
| is_default_role | boolean | Auto-assign this role to new users |
| can_manage_links | boolean | Can manage tracking links |
| can_manage_media | boolean | Can manage creatives and media groups |
| can_manage_users | boolean | Can manage users |
| publisher_access | string | Publisher access level |
| statistics_access | string | Statistics access level |
| can_manage_bidders | boolean | Can manage bidders |
| can_manage_billing | boolean | Can manage billing |
| can_manage_targets | boolean | Can manage targets |
| can_manage_tickets | boolean | Can manage tickets |
| can_manage_contracts | boolean | Can manage contracts |
| can_manage_data_keys | boolean | Can manage data keys |
| can_manage_product_db | boolean | Can manage product catalogs |
| can_manage_self_serve | boolean | Can manage Self-Serve |
| publisher_access_list | array | Publisher IDs for specific access |
| can_manage_programmatic | boolean | Can manage programmatic |
| can_manage_admin_api_access | boolean | Can manage API keys |
| can_assign_campaigns_directly | boolean | Can assign campaigns directly |
| can_manage_native_ad_templates | boolean | Can manage native templates |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Role name"
},
"is_default_role": {
"type": "boolean",
"description": "Auto-assign this role to new users"
},
"can_manage_links": {
"type": "boolean",
"description": "Can manage tracking links"
},
"can_manage_media": {
"type": "boolean",
"description": "Can manage creatives and media groups"
},
"can_manage_users": {
"type": "boolean",
"description": "Can manage users"
},
"publisher_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Publisher access level"
},
"statistics_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Statistics access level"
},
"can_manage_bidders": {
"type": "boolean",
"description": "Can manage bidders"
},
"can_manage_billing": {
"type": "boolean",
"description": "Can manage billing"
},
"can_manage_targets": {
"type": "boolean",
"description": "Can manage targets"
},
"can_manage_tickets": {
"type": "boolean",
"description": "Can manage tickets"
},
"can_manage_contracts": {
"type": "boolean",
"description": "Can manage contracts"
},
"can_manage_data_keys": {
"type": "boolean",
"description": "Can manage data keys"
},
"can_manage_product_db": {
"type": "boolean",
"description": "Can manage product catalogs"
},
"can_manage_self_serve": {
"type": "boolean",
"description": "Can manage Self-Serve"
},
"publisher_access_list": {
"type": "array",
"items": {
"type": "number"
},
"description": "Publisher IDs for specific access"
},
"can_manage_programmatic": {
"type": "boolean",
"description": "Can manage programmatic"
},
"can_manage_admin_api_access": {
"type": "boolean",
"description": "Can manage API keys"
},
"can_assign_campaigns_directly": {
"type": "boolean",
"description": "Can assign campaigns directly"
},
"can_manage_native_ad_templates": {
"type": "boolean",
"description": "Can manage native templates"
}
},
"additionalProperties": false
}Create a new schedule for time-based ad delivery. Schedules are automatically linked to ad items via placements.
| Argument | Type | Description |
|---|---|---|
| end_at | string | End date/time in ISO-8601 format, null for indefinite |
| end_date | string | End date (YYYY-MM-DD HH:MM:SS), null for indefinite — deprecated, use end_at |
| start_at | string | Start date/time in ISO-8601 format |
| quota_type | string | Quota measurement type |
| start_date | string | Start date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at |
| day_cap_type | string | Daily cap type |
| day_cap_limit | number | Daily cap limit (number of views or clicks per day) |
| day_parting_id | number | Day parting ID for time-of-day targeting |
| quota_lifetime | number | Total quota amount (views or clicks, not per thousand) |
| delivery_method | string | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
| end_at_timezone | string | IANA timezone for end_at |
| start_at_timezone | string | IANA timezone for start_at (e.g. "America/New_York") |
| per_user_view_limit | number | Per-user view frequency cap |
| per_user_view_period | number | Days before per-user view counter resets |
| under_delivery_behaviour | string | Whether to keep serving until quota met or stop on end date |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"end_at": {
"type": "string",
"description": "End date/time in ISO-8601 format, null for indefinite"
},
"end_date": {
"type": "string",
"description": "End date (YYYY-MM-DD HH:MM:SS), null for indefinite — deprecated, use end_at"
},
"start_at": {
"type": "string",
"description": "Start date/time in ISO-8601 format"
},
"quota_type": {
"enum": [
"views",
"clicks"
],
"type": "string",
"description": "Quota measurement type"
},
"start_date": {
"type": "string",
"description": "Start date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at"
},
"day_cap_type": {
"enum": [
"views",
"clicks"
],
"type": "string",
"description": "Daily cap type"
},
"day_cap_limit": {
"type": "number",
"description": "Daily cap limit (number of views or clicks per day)"
},
"day_parting_id": {
"type": "number",
"description": "Day parting ID for time-of-day targeting"
},
"quota_lifetime": {
"type": "number",
"description": "Total quota amount (views or clicks, not per thousand)"
},
"delivery_method": {
"enum": [
"default",
"smooth"
],
"type": "string",
"description": "Delivery pacing: \"default\" (ASAP) or \"smooth\" (evenly distributed)"
},
"end_at_timezone": {
"type": "string",
"description": "IANA timezone for end_at"
},
"start_at_timezone": {
"type": "string",
"description": "IANA timezone for start_at (e.g. \"America/New_York\")"
},
"per_user_view_limit": {
"type": "number",
"description": "Per-user view frequency cap"
},
"per_user_view_period": {
"type": "number",
"description": "Days before per-user view counter resets"
},
"under_delivery_behaviour": {
"enum": [
"endOnQuota",
"endOnDate"
],
"type": "string",
"description": "Whether to keep serving until quota met or stop on end date"
}
},
"additionalProperties": false
}Create a new SFTP connection
| Argument | Type | Description |
|---|---|---|
| host | string | SFTP host |
| name | string | Connection name |
| path | string | Remote path |
| port | number | SFTP port |
| password | string | SFTP password |
| username | string | SFTP username |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"host": {
"type": "string",
"description": "SFTP host"
},
"name": {
"type": "string",
"description": "Connection name"
},
"path": {
"type": "string",
"description": "Remote path"
},
"port": {
"type": "number",
"description": "SFTP port"
},
"password": {
"type": "string",
"description": "SFTP password"
},
"username": {
"type": "string",
"description": "SFTP username"
}
},
"additionalProperties": false
}Create a new signature request for a contract
| Argument | Type | Description |
|---|---|---|
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id"
],
"properties": {
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Create a free AdButler trial account. Use this when the user does NOT have an AdButler account yet. Collects their info and creates the account. After calling this, the user must check their email for a verification code, then call verify_trial_email to complete setup.
| Argument | Type | Description |
|---|---|---|
| name* | string | Full name |
| email* | string | User email address |
| phone | string | Phone number (optional) |
| company* | string | Company or organization name |
| website | string | Website URL (optional) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"name",
"company"
],
"properties": {
"name": {
"type": "string",
"description": "Full name"
},
"email": {
"type": "string",
"description": "User email address"
},
"phone": {
"type": "string",
"description": "Phone number (optional)"
},
"company": {
"type": "string",
"description": "Company or organization name"
},
"website": {
"type": "string",
"description": "Website URL (optional)"
}
},
"additionalProperties": false
}Create a new trusted redirect domain
| Argument | Type | Description |
|---|---|---|
| domain* | string | Trusted redirect domain (e.g. example.com) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"domain"
],
"properties": {
"domain": {
"type": "string",
"description": "Trusted redirect domain (e.g. example.com)"
}
},
"additionalProperties": false
}Create a new user in a user database
| Argument | Type | Description |
|---|---|---|
| user_id | string | User ID |
| attributes | object | User attribute values |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id"
],
"properties": {
"user_id": {
"type": "string",
"description": "User ID"
},
"attributes": {
"type": "object",
"description": "User attribute values",
"additionalProperties": {}
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Create a new user attribute in a user database
| Argument | Type | Description |
|---|---|---|
| id | string | Field name in the user data (e.g. "signup_datetime") |
| type | string | Data type of the field |
| label | string | Descriptive label for the field |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id"
],
"properties": {
"id": {
"type": "string",
"description": "Field name in the user data (e.g. \"signup_datetime\")"
},
"type": {
"enum": [
"number",
"phone_number",
"email",
"text",
"date_time",
"timestamp"
],
"type": "string",
"description": "Data type of the field"
},
"label": {
"type": "string",
"description": "Descriptive label for the field"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Create a new user database
| Argument | Type | Description |
|---|---|---|
| name | string | User database name |
| id_field_name | string | Name of the field to use as primary user identifier |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "User database name"
},
"id_field_name": {
"type": "string",
"description": "Name of the field to use as primary user identifier"
}
},
"additionalProperties": false
}Create a new VAST report configuration
| Argument | Type | Description |
|---|---|---|
| name* | string | Report name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Report name"
}
},
"additionalProperties": false
}Create a new video creative. The API uses multipart file upload.
| Argument | Type | Description |
|---|---|---|
| name | string | Creative name |
| group* | number | Media group ID |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"group"
],
"properties": {
"name": {
"type": "string",
"description": "Creative name"
},
"group": {
"type": "number",
"description": "Media group ID"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| name* | string | Zone name |
| width | number | Zone width in pixels (must be 0 if dimensions is "dynamic") |
| height | number | Zone height in pixels (must be 0 if dimensions is "dynamic") |
| metadata | object | Custom metadata key-value pairs |
| bid_floor | number | Default bid floor for programmatic |
| pmp_deals | array | Allowed PMP Deal IDs |
| publisher | number | Publisher ID |
| dimensions | string | Zone dimensions type: "fixed" (default) or "dynamic" |
| min_payout | number | Minimum payout per impression (CPM) |
| responsive | string | Size behavior |
| burn_in_hours | number | Hours before eCPM confidence |
| refresh_limit | number | Total times zone will refresh |
| ad_size_filter | object | Ad size filter (dynamic zones only) |
| api_frameworks | array | Supported API frameworks for OpenRTB |
| iab_categories | array | IAB category descriptors |
| private_auction | boolean | Whether auction ignores non-deal bids |
| unique_delivery | boolean | Serve unique ads on each zone |
| rtb_placement_id | string | OpenRTB tagid identifier |
| auction_tie_break | string | Tie-breaking method for auctions |
| refresh_frequency | number | Interval in seconds for serving new ads |
| use_share_of_voice | boolean | Use "share of voice" as serving strategy |
| burn_in_impressions | number | Impressions before eCPM confidence |
| allow_demand_sources | boolean | Allow requests to demand endpoints |
| serve_priority_order | string | Priority order: "weight" or "auction" |
| optimization_strategy | string | Zone optimization strategy |
| ecpm_testing_allowance | number | Percentage for eCPM recalculation testing |
| allowed_root_native_templates | array | Allowed root native template IDs |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Zone name"
},
"width": {
"type": "number",
"description": "Zone width in pixels (must be 0 if dimensions is \"dynamic\")"
},
"height": {
"type": "number",
"description": "Zone height in pixels (must be 0 if dimensions is \"dynamic\")"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"bid_floor": {
"type": "number",
"description": "Default bid floor for programmatic"
},
"pmp_deals": {
"type": "array",
"items": {
"type": "number"
},
"description": "Allowed PMP Deal IDs"
},
"publisher": {
"type": "number",
"description": "Publisher ID"
},
"dimensions": {
"enum": [
"fixed",
"dynamic"
],
"type": "string",
"description": "Zone dimensions type: \"fixed\" (default) or \"dynamic\""
},
"min_payout": {
"type": "number",
"description": "Minimum payout per impression (CPM)"
},
"responsive": {
"enum": [
"fixed",
"auto",
"inherit"
],
"type": "string",
"description": "Size behavior"
},
"burn_in_hours": {
"type": "number",
"description": "Hours before eCPM confidence"
},
"refresh_limit": {
"type": "number",
"description": "Total times zone will refresh"
},
"ad_size_filter": {
"type": "object",
"properties": {
"type": {
"enum": [
"INCLUSIVE",
"EXCLUSIVE"
],
"type": "string"
},
"sizes": {
"type": "array",
"items": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": false
}
}
},
"description": "Ad size filter (dynamic zones only)",
"additionalProperties": false
},
"api_frameworks": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supported API frameworks for OpenRTB"
},
"iab_categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "IAB category descriptors"
},
"private_auction": {
"type": "boolean",
"description": "Whether auction ignores non-deal bids"
},
"unique_delivery": {
"type": "boolean",
"description": "Serve unique ads on each zone"
},
"rtb_placement_id": {
"type": "string",
"description": "OpenRTB tagid identifier"
},
"auction_tie_break": {
"enum": [
"RANDOM",
"SCORE"
],
"type": "string",
"description": "Tie-breaking method for auctions"
},
"refresh_frequency": {
"type": "number",
"description": "Interval in seconds for serving new ads"
},
"use_share_of_voice": {
"type": "boolean",
"description": "Use \"share of voice\" as serving strategy"
},
"burn_in_impressions": {
"type": "number",
"description": "Impressions before eCPM confidence"
},
"allow_demand_sources": {
"type": "boolean",
"description": "Allow requests to demand endpoints"
},
"serve_priority_order": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Priority order: \"weight\" or \"auction\""
},
"optimization_strategy": {
"type": "string",
"description": "Zone optimization strategy"
},
"ecpm_testing_allowance": {
"type": "number",
"description": "Percentage for eCPM recalculation testing"
},
"allowed_root_native_templates": {
"type": "array",
"items": {
"type": "number"
},
"description": "Allowed root native template IDs"
}
},
"additionalProperties": false
}Create a new ORTB native ad for a standard zone
| Argument | Type | Description |
|---|---|---|
| name | string | ORTB native ad name |
| zone_id* | number | Standard zone ID |
| template_id | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zone_id"
],
"properties": {
"name": {
"type": "string",
"description": "ORTB native ad name"
},
"zone_id": {
"type": "number",
"description": "Standard zone ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Delete an advertiser
| Argument | Type | Description |
|---|---|---|
| id* | number | Advertiser ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Advertiser ID"
}
},
"additionalProperties": false
}Permanently delete an archived standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived campaign ID"
}
},
"additionalProperties": false
}Permanently delete an archived channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived channel ID"
}
},
"additionalProperties": false
}Permanently delete an archived contract
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived contract ID"
}
},
"additionalProperties": false
}Delete an audience from a user database
| Argument | Type | Description |
|---|---|---|
| id* | number | Audience ID |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Audience ID"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Delete an audio creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Delete a beacon signing key
| Argument | Type | Description |
|---|---|---|
| id* | number | Beacon signing key ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Beacon signing key ID"
}
},
"additionalProperties": false
}Delete a bidder
| Argument | Type | Description |
|---|---|---|
| id* | number | Bidder ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Bidder ID"
}
},
"additionalProperties": false
}Delete a standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign ID"
}
},
"additionalProperties": false
}Delete a campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign assignment ID"
}
},
"additionalProperties": false
}Delete a catalog ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Delete a catalog zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Catalog zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Catalog zone ID"
}
},
"additionalProperties": false
}Delete a channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Channel ID"
}
},
"additionalProperties": false
}Remove a zone from a channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Channel zone assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Channel zone assignment ID"
}
},
"additionalProperties": false
}Delete a contact
| Argument | Type | Description |
|---|---|---|
| id* | number | Contact ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contact ID"
}
},
"additionalProperties": false
}Delete a contract
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Delete a contract document
| Argument | Type | Description |
|---|---|---|
| id* | number | Document ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Document ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Delete a contract payment
| Argument | Type | Description |
|---|---|---|
| id* | number | Payment ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Payment ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Delete a contract template
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract template ID"
}
},
"additionalProperties": false
}Delete an image creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Delete a custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Delete a report configuration
| Argument | Type | Description |
|---|---|---|
| id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Delete a data key
| Argument | Type | Description |
|---|---|---|
| id* | number | Data key ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data key ID"
}
},
"additionalProperties": false
}Delete a data key target
| Argument | Type | Description |
|---|---|---|
| id* | number | Data key target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data key target ID"
}
},
"additionalProperties": false
}Delete a data list
| Argument | Type | Description |
|---|---|---|
| id* | number | Data list ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data list ID"
}
},
"additionalProperties": false
}Delete a day parting rule
| Argument | Type | Description |
|---|---|---|
| id* | number | Day parting ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Day parting ID"
}
},
"additionalProperties": false
}Delete a demand endpoint
| Argument | Type | Description |
|---|---|---|
| id* | number | Demand endpoint ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Demand endpoint ID"
}
},
"additionalProperties": false
}Delete a demand source
| Argument | Type | Description |
|---|---|---|
| id* | number | Demand source ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Demand source ID"
}
},
"additionalProperties": false
}Delete an email zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Email zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Email zone ID"
}
},
"additionalProperties": false
}Delete an event log upload configuration
| Argument | Type | Description |
|---|---|---|
| id* | number | Upload configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Upload configuration ID"
}
},
"additionalProperties": false
}Delete a geo target
| Argument | Type | Description |
|---|---|---|
| id* | number | Geo target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Geo target ID"
}
},
"additionalProperties": false
}Delete an image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Delete a list target
| Argument | Type | Description |
|---|---|---|
| id* | number | List target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "List target ID"
}
},
"additionalProperties": false
}Delete a manager
| Argument | Type | Description |
|---|---|---|
| id* | number | Manager ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Manager ID"
}
},
"additionalProperties": false
}Delete a media group
| Argument | Type | Description |
|---|---|---|
| id* | number | Media group ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Media group ID"
}
},
"additionalProperties": false
}Delete a native ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Delete a native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Native template ID"
}
},
"additionalProperties": false
}Delete a data asset from an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Data asset ID |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data asset ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Delete an image asset from an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Image asset ID |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Image asset ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Delete an OpenRTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Delete a title asset from an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Title asset ID |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Title asset ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Delete a placement (remove an ad item from a zone)
| Argument | Type | Description |
|---|---|---|
| id* | number | Placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Placement ID"
}
},
"additionalProperties": false
}Delete a platform target
| Argument | Type | Description |
|---|---|---|
| id* | number | Platform target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Platform target ID"
}
},
"additionalProperties": false
}Delete a PMP deal
| Argument | Type | Description |
|---|---|---|
| id* | number | PMP deal ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "PMP deal ID"
}
},
"additionalProperties": false
}Delete a postal code target
| Argument | Type | Description |
|---|---|---|
| id* | number | Postal code target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Postal code target ID"
}
},
"additionalProperties": false
}Delete a product source
| Argument | Type | Description |
|---|---|---|
| source_id* | number | Source ID |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"source_id"
],
"properties": {
"source_id": {
"type": "number",
"description": "Source ID"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Delete a product source target
| Argument | Type | Description |
|---|---|---|
| publisher_id* | number | Publisher ID |
| source_target_id* | number | Source target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"source_target_id"
],
"properties": {
"publisher_id": {
"type": "number",
"description": "Publisher ID"
},
"source_target_id": {
"type": "number",
"description": "Source target ID"
}
},
"additionalProperties": false
}Delete a publisher
| Argument | Type | Description |
|---|---|---|
| id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Delete a report schedule
| Argument | Type | Description |
|---|---|---|
| schedule_id* | number | Schedule ID |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id",
"schedule_id"
],
"properties": {
"schedule_id": {
"type": "number",
"description": "Schedule ID"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Delete a rich media ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Delete a rich media creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Delete a role
| Argument | Type | Description |
|---|---|---|
| id* | number | Role ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Role ID"
}
},
"additionalProperties": false
}Delete a schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | Schedule ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Schedule ID"
}
},
"additionalProperties": false
}Delete an SFTP connection
| Argument | Type | Description |
|---|---|---|
| id* | number | SFTP connection ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "SFTP connection ID"
}
},
"additionalProperties": false
}Delete a signature request
| Argument | Type | Description |
|---|---|---|
| id* | number | Signature request ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Delete a recipient from a signature request
| Argument | Type | Description |
|---|---|---|
| request_id* | number | Signature request ID |
| contract_id* | number | Contract ID |
| recipient_id* | number | Recipient ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"request_id",
"recipient_id"
],
"properties": {
"request_id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"recipient_id": {
"type": "number",
"description": "Recipient ID"
}
},
"additionalProperties": false
}Delete a trusted redirect domain
| Argument | Type | Description |
|---|---|---|
| id* | number | Trusted redirect domain ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Trusted redirect domain ID"
}
},
"additionalProperties": false
}Delete a user attribute from a user database
| Argument | Type | Description |
|---|---|---|
| id* | number | User attribute ID |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "User attribute ID"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Delete a video creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Delete a standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
}
},
"additionalProperties": false
}Delete an ORTB native ad from a standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | ORTB native ad ID |
| zone_id* | number | Standard zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zone_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "ORTB native ad ID"
},
"zone_id": {
"type": "number",
"description": "Standard zone ID"
}
},
"additionalProperties": false
}Get the full schema (parameters, request body shape, response shape) for one AdButler API endpoint. Use after search_adbutler_api to understand exactly what to send when you call it.
| Argument | Type | Description |
|---|---|---|
| path* | string | Endpoint path with `{placeholder}` syntax for path params, e.g. "/campaigns/{id}". Must match the path returned by search_adbutler_api exactly. |
| method* | string | HTTP method, e.g. "GET", "POST", "PUT", "DELETE". |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"method",
"path"
],
"properties": {
"path": {
"type": "string",
"description": "Endpoint path with `{placeholder}` syntax for path params, e.g. \"/campaigns/{id}\". Must match the path returned by search_adbutler_api exactly."
},
"method": {
"type": "string",
"description": "HTTP method, e.g. \"GET\", \"POST\", \"PUT\", \"DELETE\"."
}
},
"additionalProperties": false
}Download a file revision for a contract document
| Argument | Type | Description |
|---|---|---|
| contract_id* | number | Contract ID |
| document_id* | number | Document ID |
| revision_id* | number | File revision ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"document_id",
"revision_id"
],
"properties": {
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"document_id": {
"type": "number",
"description": "Document ID"
},
"revision_id": {
"type": "number",
"description": "File revision ID"
}
},
"additionalProperties": false
}Create a new draft standard campaign. Fields go inside a "draft" object wrapper.
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing standard campaign fields (name, advertiser, etc.) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing standard campaign fields (name, advertiser, etc.)",
"additionalProperties": {}
}
},
"additionalProperties": false
}Create a new draft campaign assignment
| Argument | Type | Description |
|---|---|---|
| draft | object | Object containing campaign assignment fields (campaign and advertisement auto-resolved) |
| ad_item_draft_id* | number | Draft ad item ID this assignment references |
| campaign_draft_id* | number | Draft campaign ID this assignment belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"ad_item_draft_id"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing campaign assignment fields (campaign and advertisement auto-resolved)",
"additionalProperties": {}
},
"ad_item_draft_id": {
"type": "number",
"description": "Draft ad item ID this assignment references"
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this assignment belongs to"
}
},
"additionalProperties": false
}Create a new draft catalog ad item
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing catalog ad item fields (name required) |
| campaign_draft_id* | number | Draft campaign ID this ad item belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing catalog ad item fields (name required)",
"additionalProperties": {}
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this ad item belongs to"
}
},
"additionalProperties": false
}Create a new draft custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing custom HTML ad item fields (name, custom_html required) |
| campaign_draft_id* | number | Draft campaign ID this ad item belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing custom HTML ad item fields (name, custom_html required)",
"additionalProperties": {}
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this ad item belongs to"
}
},
"additionalProperties": false
}Create a new draft image ad item
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing image ad item fields (name required) |
| campaign_draft_id* | number | Draft campaign ID this ad item belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing image ad item fields (name required)",
"additionalProperties": {}
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this ad item belongs to"
}
},
"additionalProperties": false
}Create a new draft native ad item
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing native ad item fields (name required, plus template, variables, etc.) |
| campaign_draft_id* | number | Draft campaign ID this ad item belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing native ad item fields (name required, plus template, variables, etc.)",
"additionalProperties": {}
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this ad item belongs to"
}
},
"additionalProperties": false
}Create a new draft placement
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing placement fields (zone, advertisement, etc.) |
| campaign_draft_id* | number | Draft campaign ID this placement belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing placement fields (zone, advertisement, etc.)",
"additionalProperties": {}
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this placement belongs to"
}
},
"additionalProperties": false
}Create a new draft rich media ad item
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing rich media ad item fields (name required) |
| campaign_draft_id* | number | Draft campaign ID this ad item belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing rich media ad item fields (name required)",
"additionalProperties": {}
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this ad item belongs to"
}
},
"additionalProperties": false
}Create a new draft schedule
| Argument | Type | Description |
|---|---|---|
| draft* | object | Object containing schedule fields |
| campaign_draft_id* | number | Draft campaign ID this schedule belongs to |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"campaign_draft_id",
"draft"
],
"properties": {
"draft": {
"type": "object",
"description": "Object containing schedule fields",
"additionalProperties": {}
},
"campaign_draft_id": {
"type": "number",
"description": "Draft campaign ID this schedule belongs to"
}
},
"additionalProperties": false
}Delete a draft standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft campaign ID"
}
},
"additionalProperties": false
}Delete a draft campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft campaign assignment ID"
}
},
"additionalProperties": false
}Delete a draft catalog ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Delete a draft custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Delete a draft image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Delete a draft native ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Delete a draft placement
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft placement ID"
}
},
"additionalProperties": false
}Delete a draft rich media ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Delete a draft schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft schedule ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft schedule ID"
}
},
"additionalProperties": false
}Get a draft ad item of any type by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Get details of a specific draft standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft campaign ID"
}
},
"additionalProperties": false
}Get details of a specific draft campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft campaign assignment ID"
}
},
"additionalProperties": false
}Get details of a specific draft catalog ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Get details of a specific draft custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Get details of a specific draft image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Get details of a specific draft native ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Get details of a specific draft placement
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft placement ID"
}
},
"additionalProperties": false
}Get details of a specific draft rich media ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
}
},
"additionalProperties": false
}Get details of a specific draft schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft schedule ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft schedule ID"
}
},
"additionalProperties": false
}List all draft ad items across all types
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft campaign assignments
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft standard campaigns
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft catalog ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft custom HTML ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft image ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft native ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft placements
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft rich media ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all draft schedules
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}Save/publish a draft campaign (converts draft to live campaign)
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft campaign ID"
}
},
"additionalProperties": false
}Update an existing draft standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft campaign ID |
| draft | object | Object containing standard campaign fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft campaign ID"
},
"draft": {
"type": "object",
"description": "Object containing standard campaign fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft campaign assignment ID |
| draft | object | Object containing campaign assignment fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft campaign assignment ID"
},
"draft": {
"type": "object",
"description": "Object containing campaign assignment fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft catalog ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
| draft | object | Object containing catalog ad item fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
},
"draft": {
"type": "object",
"description": "Object containing catalog ad item fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
| draft | object | Object containing custom HTML ad item fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
},
"draft": {
"type": "object",
"description": "Object containing custom HTML ad item fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
| draft | object | Object containing image ad item fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
},
"draft": {
"type": "object",
"description": "Object containing image ad item fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft native ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
| draft | object | Object containing native ad item fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
},
"draft": {
"type": "object",
"description": "Object containing native ad item fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft placement
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft placement ID |
| draft | object | Object containing placement fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft placement ID"
},
"draft": {
"type": "object",
"description": "Object containing placement fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft rich media ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft ad item ID |
| draft | object | Object containing rich media ad item fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft ad item ID"
},
"draft": {
"type": "object",
"description": "Object containing rich media ad item fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Update an existing draft schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | Draft schedule ID |
| draft | object | Object containing schedule fields to update |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Draft schedule ID"
},
"draft": {
"type": "object",
"description": "Object containing schedule fields to update",
"additionalProperties": {}
}
},
"additionalProperties": false
}Generate ad serving tags for multiple zones at once
| Argument | Type | Description |
|---|---|---|
| zone_ids* | array | Array of zone IDs to generate tags for |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zone_ids"
],
"properties": {
"zone_ids": {
"type": "array",
"items": {
"type": "number"
},
"description": "Array of zone IDs to generate tags for"
}
},
"additionalProperties": false
}Retrieve an ad via GET request. Same parameters as serve_ad but uses GET instead of POST.
| Argument | Type | Description |
|---|---|---|
| ID* | number | Your AdButler account ID |
| ip | string | IPv4 address for geographic targeting (required for server-side requests) |
| kw | array | Keywords for keyword targeting |
| rf | number | Pass 1 to include is_redirectable field in response |
| sh | number | Screen height for platform targeting |
| sw | number | Screen width for platform targeting |
| ua | string | User agent string for platform targeting |
| pid | number | Page ID for unique delivery/roadblocks (random number, same for all zones on page) |
| spr | number | Screen pixel ratio for platform targeting |
| size | string | Expected ad size (e.g. "300x250") |
| type* | string | Response type: "json" for most eligible ad, "jsonr" for all eligible ads ranked |
| place | number | Place counter for unique delivery (0, 1, 2, etc.) |
| setID* | number | Zone ID to serve an ad from |
| referrer | string | Page URL for URL targeting (required for server-side requests) |
| _abdk_json | object | Data key key-value pairs for data key targeting |
| defer_signing | boolean | Defer beacon signing hash generation |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"ID",
"setID",
"type"
],
"properties": {
"ID": {
"type": "number",
"description": "Your AdButler account ID"
},
"ip": {
"type": "string",
"description": "IPv4 address for geographic targeting (required for server-side requests)"
},
"kw": {
"type": "array",
"items": {
"type": "string"
},
"description": "Keywords for keyword targeting"
},
"rf": {
"type": "number",
"description": "Pass 1 to include is_redirectable field in response"
},
"sh": {
"type": "number",
"description": "Screen height for platform targeting"
},
"sw": {
"type": "number",
"description": "Screen width for platform targeting"
},
"ua": {
"type": "string",
"description": "User agent string for platform targeting"
},
"pid": {
"type": "number",
"description": "Page ID for unique delivery/roadblocks (random number, same for all zones on page)"
},
"spr": {
"type": "number",
"description": "Screen pixel ratio for platform targeting"
},
"size": {
"type": "string",
"description": "Expected ad size (e.g. \"300x250\")"
},
"type": {
"enum": [
"json",
"jsonr"
],
"type": "string",
"description": "Response type: \"json\" for most eligible ad, \"jsonr\" for all eligible ads ranked"
},
"place": {
"type": "number",
"description": "Place counter for unique delivery (0, 1, 2, etc.)"
},
"setID": {
"type": "number",
"description": "Zone ID to serve an ad from"
},
"referrer": {
"type": "string",
"description": "Page URL for URL targeting (required for server-side requests)"
},
"_abdk_json": {
"type": "object",
"description": "Data key key-value pairs for data key targeting",
"additionalProperties": {}
},
"defer_signing": {
"type": "boolean",
"description": "Defer beacon signing hash generation"
}
},
"additionalProperties": false
}Get details of a specific advertiser by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Advertiser ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Advertiser ID"
}
},
"additionalProperties": false
}Get details of a specific archived advertiser
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived advertiser ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived advertiser ID"
}
},
"additionalProperties": false
}Get details of a specific archived standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived campaign ID"
}
},
"additionalProperties": false
}Get details of a specific archived channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived channel ID"
}
},
"additionalProperties": false
}Get details of a specific archived contract
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived contract ID"
}
},
"additionalProperties": false
}Get details of a specific archived email zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived email zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived email zone ID"
}
},
"additionalProperties": false
}Get details of a specific archived publisher
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived publisher ID"
}
},
"additionalProperties": false
}Get details of a specific archived standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived zone ID"
}
},
"additionalProperties": false
}Get auction placement statistics report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get details of a specific audience in a user database
| Argument | Type | Description |
|---|---|---|
| id* | number | Audience ID |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Audience ID"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Get details of a specific audio creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Get details of a specific beacon signing key by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Beacon signing key ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Beacon signing key ID"
}
},
"additionalProperties": false
}Get details of a specific bidder by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Bidder ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Bidder ID"
}
},
"additionalProperties": false
}Get details of a specific standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign ID"
}
},
"additionalProperties": false
}Get details of a specific campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign assignment ID"
}
},
"additionalProperties": false
}Get conversion tag for a campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign ID"
}
},
"additionalProperties": false
}Get eligible zones for a campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign ID"
}
},
"additionalProperties": false
}Get details of a specific catalog ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get details of a specific catalog zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Catalog zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Catalog zone ID"
}
},
"additionalProperties": false
}Get the ad serving tag for a catalog zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Catalog zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Catalog zone ID"
}
},
"additionalProperties": false
}Get details of a specific channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Channel ID"
}
},
"additionalProperties": false
}Get details of a specific channel zone assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | Channel zone assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Channel zone assignment ID"
}
},
"additionalProperties": false
}Get click details report
| Argument | Type | Description |
|---|---|---|
| zones | string | Filter by zone IDs (comma-separated) |
| preset | string | Date preset |
| timezone | string | Timezone |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| publishers | string | Filter by publisher IDs (comma-separated) |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"zones": {
"type": "string",
"description": "Filter by zone IDs (comma-separated)"
},
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"publishers": {
"type": "string",
"description": "Filter by publisher IDs (comma-separated)"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
}
},
"additionalProperties": false
}Get details of a specific contact by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Contact ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contact ID"
}
},
"additionalProperties": false
}List report schedules for a contact
| Argument | Type | Description |
|---|---|---|
| id* | number | Contact ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contact ID"
}
},
"additionalProperties": false
}Get details of a specific contract
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Get the active signature request for a contract
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Get campaigns assigned to a contract
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Get details of a specific contract document
| Argument | Type | Description |
|---|---|---|
| id* | number | Document ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Document ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Get a specific file revision for a contract document
| Argument | Type | Description |
|---|---|---|
| contract_id* | number | Contract ID |
| document_id* | number | Document ID |
| revision_id* | number | File revision ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"document_id",
"revision_id"
],
"properties": {
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"document_id": {
"type": "number",
"description": "Document ID"
},
"revision_id": {
"type": "number",
"description": "File revision ID"
}
},
"additionalProperties": false
}Get details of a specific contract payment
| Argument | Type | Description |
|---|---|---|
| id* | number | Payment ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Payment ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Get details of a specific contract template
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract template ID"
}
},
"additionalProperties": false
}Get conversion details report
| Argument | Type | Description |
|---|---|---|
| zones | string | Filter by zone IDs (comma-separated) |
| preset | string | Date preset |
| timezone | string | Timezone |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| publishers | string | Filter by publisher IDs (comma-separated) |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"zones": {
"type": "string",
"description": "Filter by zone IDs (comma-separated)"
},
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"publishers": {
"type": "string",
"description": "Filter by publisher IDs (comma-separated)"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
}
},
"additionalProperties": false
}Get details of a specific image creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Get details of a specific custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get conversion tracking tag for a custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get details of a specific report configuration
| Argument | Type | Description |
|---|---|---|
| id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Get details of a specific data key
| Argument | Type | Description |
|---|---|---|
| id* | number | Data key ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data key ID"
}
},
"additionalProperties": false
}Get details of a specific data key target
| Argument | Type | Description |
|---|---|---|
| id* | number | Data key target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data key target ID"
}
},
"additionalProperties": false
}Get details of a specific data list by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Data list ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data list ID"
}
},
"additionalProperties": false
}Get details of a specific day parting rule
| Argument | Type | Description |
|---|---|---|
| id* | number | Day parting ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Day parting ID"
}
},
"additionalProperties": false
}Get details of a specific demand endpoint by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Demand endpoint ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Demand endpoint ID"
}
},
"additionalProperties": false
}Get details of a specific demand source by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Demand source ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Demand source ID"
}
},
"additionalProperties": false
}Get demand source statistics report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get display channel forecast report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get display forecast report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get display platform estimate statistics
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get display advertising report with impressions, clicks, and CTR
| Argument | Type | Description |
|---|---|---|
| type* | string | Report type: overview, advertiser, publisher, zone, campaign, channel, geo-target, ad-item |
| zones | string | Filter by zone IDs (comma-separated) |
| period* | string | Data grouping period: day, week, month, year |
| preset | string | 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-months |
| details | boolean | Include detailed breakdown |
| summary | boolean | Include summary data |
| timezone | string | Timezone for preset (e.g. "America/New_York") |
| breakdown | boolean | Include breakdown data |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| financials | boolean | Include financial data |
| publishers | string | Filter by publisher IDs (comma-separated) |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
| exclude_channel_stats | boolean | Exclude stats from channel-served ads |
| require_channel_stats | boolean | Only include stats from channel-served ads |
| exclude_campaign_ad_items | boolean | Exclude ad items in campaigns |
| exclude_publisher_ad_items | boolean | Exclude ad items directly in zones |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"type",
"period"
],
"properties": {
"type": {
"type": "string",
"description": "Report type: overview, advertiser, publisher, zone, campaign, channel, geo-target, ad-item"
},
"zones": {
"type": "string",
"description": "Filter by zone IDs (comma-separated)"
},
"period": {
"type": "string",
"description": "Data grouping period: day, week, month, year"
},
"preset": {
"type": "string",
"description": "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-months"
},
"details": {
"type": "boolean",
"description": "Include detailed breakdown"
},
"summary": {
"type": "boolean",
"description": "Include summary data"
},
"timezone": {
"type": "string",
"description": "Timezone for preset (e.g. \"America/New_York\")"
},
"breakdown": {
"type": "boolean",
"description": "Include breakdown data"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"financials": {
"type": "boolean",
"description": "Include financial data"
},
"publishers": {
"type": "string",
"description": "Filter by publisher IDs (comma-separated)"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
},
"exclude_channel_stats": {
"type": "boolean",
"description": "Exclude stats from channel-served ads"
},
"require_channel_stats": {
"type": "boolean",
"description": "Only include stats from channel-served ads"
},
"exclude_campaign_ad_items": {
"type": "boolean",
"description": "Exclude ad items in campaigns"
},
"exclude_publisher_ad_items": {
"type": "boolean",
"description": "Exclude ad items directly in zones"
}
},
"additionalProperties": false
}Get details of a specific email zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Email zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Email zone ID"
}
},
"additionalProperties": false
}Get the conversion tracking tag for an email zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Email zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Email zone ID"
}
},
"additionalProperties": false
}Get the ad serving tag for an email zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Email zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Email zone ID"
}
},
"additionalProperties": false
}Get details of a specific event log upload configuration
| Argument | Type | Description |
|---|---|---|
| id* | number | Upload configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Upload configuration ID"
}
},
"additionalProperties": false
}Get details of a specific event log upload log entry
| Argument | Type | Description |
|---|---|---|
| id* | number | Upload log ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Upload log ID"
}
},
"additionalProperties": false
}Get event logs for account activity (changes, logins, etc.)
| Argument | Type | Description |
|---|---|---|
| to | string | End date filter |
| from | string | Start date filter |
| log_type* | string | Type of event log to retrieve |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"log_type"
],
"properties": {
"to": {
"type": "string",
"description": "End date filter"
},
"from": {
"type": "string",
"description": "Start date filter"
},
"log_type": {
"type": "string",
"description": "Type of event log to retrieve"
}
},
"additionalProperties": false
}Get geographic summary report
| Argument | Type | Description |
|---|---|---|
| zones | string | Filter by zone IDs (comma-separated) |
| preset | string | Date preset |
| timezone | string | Timezone |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| publishers | string | Filter by publisher IDs (comma-separated) |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"zones": {
"type": "string",
"description": "Filter by zone IDs (comma-separated)"
},
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"publishers": {
"type": "string",
"description": "Filter by publisher IDs (comma-separated)"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
}
},
"additionalProperties": false
}Get details of a specific geo target
| Argument | Type | Description |
|---|---|---|
| id* | number | Geo target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Geo target ID"
}
},
"additionalProperties": false
}Get details of a specific image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get conversion tracking tag for an image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get the Kogan self-serve dashboard report, including overview and Value Catcher ad item stats. Kogan marketplace accounts only — requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
| Argument | Type | Description |
|---|---|---|
| to | string | End date (required with "from" unless preset is set) |
| from | string | Start date (required with "to" unless preset is set) |
| type* | string | Report type: overview, advertiser, zone, campaign, ad-item, value-catcher-ad-item |
| period* | string | Data grouping period: day, week, month, year |
| portal | number | Marketplace portal ID — report currency follows the portal (e.g. NZ portal reports in NZD); omit for the account default currency |
| preset | string | Date preset: today, last-24-hours, yesterday, this-week, last-7-days, last-week, last-14-days, this-month, last-30-days, last-month, last-3-months, last-6-months, last-12-months, year-to-date, last-year (required unless from/to are set) |
| details | boolean | Include detailed breakdown |
| summary | boolean | Include summary data |
| ad_items | string | Filter by ad item IDs (comma-separated) |
| channels | string | Filter by channel IDs (comma-separated) |
| timezone | string | Timezone for dates (default Australia/Melbourne) |
| breakdown | boolean | Include breakdown data |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| financials | boolean | Include financial data |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
| simple_stats | boolean | Return simplified stats |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"type",
"period"
],
"properties": {
"to": {
"type": "string",
"description": "End date (required with \"from\" unless preset is set)"
},
"from": {
"type": "string",
"description": "Start date (required with \"to\" unless preset is set)"
},
"type": {
"type": "string",
"description": "Report type: overview, advertiser, zone, campaign, ad-item, value-catcher-ad-item"
},
"period": {
"type": "string",
"description": "Data grouping period: day, week, month, year"
},
"portal": {
"type": "number",
"description": "Marketplace portal ID — report currency follows the portal (e.g. NZ portal reports in NZD); omit for the account default currency"
},
"preset": {
"type": "string",
"description": "Date preset: today, last-24-hours, yesterday, this-week, last-7-days, last-week, last-14-days, this-month, last-30-days, last-month, last-3-months, last-6-months, last-12-months, year-to-date, last-year (required unless from/to are set)"
},
"details": {
"type": "boolean",
"description": "Include detailed breakdown"
},
"summary": {
"type": "boolean",
"description": "Include summary data"
},
"ad_items": {
"type": "string",
"description": "Filter by ad item IDs (comma-separated)"
},
"channels": {
"type": "string",
"description": "Filter by channel IDs (comma-separated)"
},
"timezone": {
"type": "string",
"description": "Timezone for dates (default Australia/Melbourne)"
},
"breakdown": {
"type": "boolean",
"description": "Include breakdown data"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"financials": {
"type": "boolean",
"description": "Include financial data"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
},
"simple_stats": {
"type": "boolean",
"description": "Return simplified stats"
}
},
"additionalProperties": false
}Get a Kogan marketplace product by seller ID and SKU (title, brand, category, stock, offers, store URLs, images). Kogan marketplace accounts only — requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
| Argument | Type | Description |
|---|---|---|
| sku* | string | Product SKU |
| seller_id* | string | Kogan seller ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"seller_id",
"sku"
],
"properties": {
"sku": {
"type": "string",
"description": "Product SKU"
},
"seller_id": {
"type": "string",
"description": "Kogan seller ID"
}
},
"additionalProperties": false
}Get a Kogan marketplace advertising report (includes Value Catcher stats merged with display stats). Kogan marketplace accounts only — requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
| Argument | Type | Description |
|---|---|---|
| to | string | End date (required with "from" unless preset is set) |
| from | string | Start date (required with "to" unless preset is set) |
| type* | string | Report type: advertiser, campaign, ad-item |
| zones | string | Filter by zone IDs (comma-separated) |
| period* | string | Data grouping period: day, week, month, year |
| portal | number | Marketplace portal ID — report currency follows the portal (e.g. NZ portal reports in NZD); omit for the account default currency |
| preset | string | Date preset: today, last-24-hours, yesterday, this-week, last-7-days, last-week, last-14-days, this-month, last-30-days, last-month, last-3-months, last-6-months, last-12-months, year-to-date, last-year (required unless from/to are set) |
| details | boolean | Include detailed breakdown |
| summary | boolean | Include summary data |
| ad_items | string | Filter by ad item IDs (comma-separated) |
| timezone | string | Timezone for dates (default Australia/Melbourne) |
| breakdown | boolean | Include breakdown data |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| financials | boolean | Include financial data |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"type",
"period"
],
"properties": {
"to": {
"type": "string",
"description": "End date (required with \"from\" unless preset is set)"
},
"from": {
"type": "string",
"description": "Start date (required with \"to\" unless preset is set)"
},
"type": {
"type": "string",
"description": "Report type: advertiser, campaign, ad-item"
},
"zones": {
"type": "string",
"description": "Filter by zone IDs (comma-separated)"
},
"period": {
"type": "string",
"description": "Data grouping period: day, week, month, year"
},
"portal": {
"type": "number",
"description": "Marketplace portal ID — report currency follows the portal (e.g. NZ portal reports in NZD); omit for the account default currency"
},
"preset": {
"type": "string",
"description": "Date preset: today, last-24-hours, yesterday, this-week, last-7-days, last-week, last-14-days, this-month, last-30-days, last-month, last-3-months, last-6-months, last-12-months, year-to-date, last-year (required unless from/to are set)"
},
"details": {
"type": "boolean",
"description": "Include detailed breakdown"
},
"summary": {
"type": "boolean",
"description": "Include summary data"
},
"ad_items": {
"type": "string",
"description": "Filter by ad item IDs (comma-separated)"
},
"timezone": {
"type": "string",
"description": "Timezone for dates (default Australia/Melbourne)"
},
"breakdown": {
"type": "boolean",
"description": "Include breakdown data"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"financials": {
"type": "boolean",
"description": "Include financial data"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
}
},
"additionalProperties": false
}Get details of a specific list target
| Argument | Type | Description |
|---|---|---|
| id* | number | List target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "List target ID"
}
},
"additionalProperties": false
}Get live website preview URL
| Argument | Type | Description |
|---|---|---|
| url | string | Website URL to preview |
| zone_id | number | Zone ID to preview |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"url": {
"type": "string",
"description": "Website URL to preview"
},
"zone_id": {
"type": "number",
"description": "Zone ID to preview"
}
},
"additionalProperties": false
}Get details of a specific manager by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Manager ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Manager ID"
}
},
"additionalProperties": false
}Generate manual tracking links for an ad item
| Argument | Type | Description |
|---|---|---|
| type | string | Ad item type |
| ad_item_id | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"type": {
"type": "string",
"description": "Ad item type"
},
"ad_item_id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get details of a specific media group
| Argument | Type | Description |
|---|---|---|
| id* | number | Media group ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Media group ID"
}
},
"additionalProperties": false
}Get details of a specific native ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get conversion tracking tag for a native ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get details of a specific native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Native template ID"
}
},
"additionalProperties": false
}Get details of a specific data asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Data asset ID |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data asset ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Get details of a specific image asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Image asset ID |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Image asset ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Get details of a specific OpenRTB native template by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Get details of a specific title asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Title asset ID |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Title asset ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Get details of a specific placement
| Argument | Type | Description |
|---|---|---|
| id* | number | Placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Placement ID"
}
},
"additionalProperties": false
}Get conversion tracking tag for a placement
| Argument | Type | Description |
|---|---|---|
| id* | number | Placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Placement ID"
}
},
"additionalProperties": false
}Get placement forecast report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get details of a specific platform target
| Argument | Type | Description |
|---|---|---|
| id* | number | Platform target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Platform target ID"
}
},
"additionalProperties": false
}Get details of a specific PMP deal by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | PMP deal ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "PMP deal ID"
}
},
"additionalProperties": false
}Get details of a specific postal code target
| Argument | Type | Description |
|---|---|---|
| id* | number | Postal code target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Postal code target ID"
}
},
"additionalProperties": false
}Get details of a specific product catalog
| Argument | Type | Description |
|---|---|---|
| catalog_id* | number | Catalog ID |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"catalog_id"
],
"properties": {
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Get details of a specific product catalog item
| Argument | Type | Description |
|---|---|---|
| catalog_id* | number | Catalog ID |
| identifier* | string | Unique identifier for the catalog item |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"catalog_id",
"identifier"
],
"properties": {
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"identifier": {
"type": "string",
"description": "Unique identifier for the catalog item"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Get details of a specific product source
| Argument | Type | Description |
|---|---|---|
| source_id* | number | Source ID |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"source_id"
],
"properties": {
"source_id": {
"type": "number",
"description": "Source ID"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Get details of a specific product source target
| Argument | Type | Description |
|---|---|---|
| publisher_id* | number | Publisher ID |
| source_target_id* | number | Source target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"source_target_id"
],
"properties": {
"publisher_id": {
"type": "number",
"description": "Publisher ID"
},
"source_target_id": {
"type": "number",
"description": "Source target ID"
}
},
"additionalProperties": false
}Get details of a specific publisher
| Argument | Type | Description |
|---|---|---|
| id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Get a specific generated report
| Argument | Type | Description |
|---|---|---|
| generated_id* | number | Generated report ID |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id",
"generated_id"
],
"properties": {
"generated_id": {
"type": "number",
"description": "Generated report ID"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Get a specific report schedule
| Argument | Type | Description |
|---|---|---|
| schedule_id* | number | Schedule ID |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id",
"schedule_id"
],
"properties": {
"schedule_id": {
"type": "number",
"description": "Schedule ID"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Get a specific generated report from a schedule
| Argument | Type | Description |
|---|---|---|
| schedule_id* | number | Schedule ID |
| generated_id* | number | Generated report ID |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id",
"schedule_id",
"generated_id"
],
"properties": {
"schedule_id": {
"type": "number",
"description": "Schedule ID"
},
"generated_id": {
"type": "number",
"description": "Generated report ID"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Get details of a specific rich media ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get conversion tracking tag for a rich media ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
}
},
"additionalProperties": false
}Get details of a specific rich media creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Get details of a specific role by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Role ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Role ID"
}
},
"additionalProperties": false
}Get details of a specific schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | Schedule ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Schedule ID"
}
},
"additionalProperties": false
}Get details of a specific SFTP connection by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | SFTP connection ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "SFTP connection ID"
}
},
"additionalProperties": false
}Get details of a specific signature request
| Argument | Type | Description |
|---|---|---|
| id* | number | Signature request ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Get a specific recipient for a signature request
| Argument | Type | Description |
|---|---|---|
| request_id* | number | Signature request ID |
| contract_id* | number | Contract ID |
| recipient_id* | number | Recipient ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"request_id",
"recipient_id"
],
"properties": {
"request_id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"recipient_id": {
"type": "number",
"description": "Recipient ID"
}
},
"additionalProperties": false
}Get details of a specific trusted redirect domain by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | Trusted redirect domain ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Trusted redirect domain ID"
}
},
"additionalProperties": false
}Get unique visitor counts (distinct viewers of viewable impressions) per publisher, zone, advertiser or campaign. Daily or monthly periods return one count per period per entity; do NOT add daily or monthly counts together to get a range total, since the same visitor is counted in every period they were seen. Likewise, counts for different entities cannot be summed into an account total, since one visitor can appear under several. Use period "summary" for true unique visitors across the whole range. Returns data: [{type, id, name, visitors, entry_date}], where entry_date is the day, the first of the month (monthly), or the earliest date with visitors (summary); name is null if the entity could not be found (e.g. archived). Only available to accounts with the daily unique visitors feature (built for MyHealthTeams); other accounts receive a 404 / endpoint-not-found error.
| Argument | Type | Description |
|---|---|---|
| id | string | Limit to these entity IDs of the chosen type (comma-separated); omit for all entities of that type |
| to* | string | End date (inclusive): YYYY-MM-DD for daily/summary, YYYY-MM for monthly |
| from* | string | Start date: YYYY-MM-DD for daily/summary, YYYY-MM for monthly. At most 400 days before "to" |
| type* | string | Entity to group unique visitors by |
| period* | string | daily = per day, monthly = per calendar month, summary = one distinct count for the whole range |
| include_names | boolean | Add each entity's name to every row (default true); set false to skip the extra lookups |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"type",
"period",
"from",
"to"
],
"properties": {
"id": {
"type": "string",
"description": "Limit to these entity IDs of the chosen type (comma-separated); omit for all entities of that type"
},
"to": {
"type": "string",
"description": "End date (inclusive): YYYY-MM-DD for daily/summary, YYYY-MM for monthly"
},
"from": {
"type": "string",
"description": "Start date: YYYY-MM-DD for daily/summary, YYYY-MM for monthly. At most 400 days before \"to\""
},
"type": {
"enum": [
"publisher",
"zone",
"advertiser",
"campaign"
],
"type": "string",
"description": "Entity to group unique visitors by"
},
"period": {
"enum": [
"daily",
"monthly",
"summary"
],
"type": "string",
"description": "daily = per day, monthly = per calendar month, summary = one distinct count for the whole range"
},
"include_names": {
"type": "boolean",
"description": "Add each entity's name to every row (default true); set false to skip the extra lookups"
}
},
"additionalProperties": false
}Get a single user from a user database
| Argument | Type | Description |
|---|---|---|
| user_id* | string | User ID |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"user_id"
],
"properties": {
"user_id": {
"type": "string",
"description": "User ID"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Get details of a specific user attribute in a user database
| Argument | Type | Description |
|---|---|---|
| id* | number | User attribute ID |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "User attribute ID"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Get details of a specific user database by ID
| Argument | Type | Description |
|---|---|---|
| id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Get conversion tracking tag for a VAST ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item ID"
}
},
"additionalProperties": false
}Get VAST auction placements report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get conversion tracking tag for a VAST campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Get VAST channel forecast report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get a specific VAST report
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST report ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST report ID"
}
},
"additionalProperties": false
}Get VAST forecast report
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get VAST geographic summary report
| Argument | Type | Description |
|---|---|---|
| zones | string | Filter by zone IDs (comma-separated) |
| preset | string | Date preset |
| timezone | string | Timezone |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| publishers | string | Filter by publisher IDs (comma-separated) |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"zones": {
"type": "string",
"description": "Filter by zone IDs (comma-separated)"
},
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"publishers": {
"type": "string",
"description": "Filter by publisher IDs (comma-separated)"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
}
},
"additionalProperties": false
}Get conversion tracking tag for a VAST placement
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST placement ID"
}
},
"additionalProperties": false
}Get VAST platform estimate statistics
| Argument | Type | Description |
|---|---|---|
| preset | string | Date preset |
| timezone | string | Timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"preset": {
"type": "string",
"description": "Date preset"
},
"timezone": {
"type": "string",
"description": "Timezone"
}
},
"additionalProperties": false
}Get VAST video advertising report
| Argument | Type | Description |
|---|---|---|
| type* | string | Report type: overview, advertiser, publisher, zone, campaign, ad-item |
| zones | string | Filter by zone IDs (comma-separated) |
| period* | string | Data grouping period: day, week, month, year |
| preset | string | Date preset (same options as display report) |
| details | boolean | Include detailed breakdown |
| summary | boolean | Include summary data |
| timezone | string | Timezone for preset |
| breakdown | boolean | Include breakdown data |
| campaigns | string | Filter by campaign IDs (comma-separated) |
| financials | boolean | Include financial data |
| publishers | string | Filter by publisher IDs (comma-separated) |
| advertisers | string | Filter by advertiser IDs (comma-separated) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"type",
"period"
],
"properties": {
"type": {
"type": "string",
"description": "Report type: overview, advertiser, publisher, zone, campaign, ad-item"
},
"zones": {
"type": "string",
"description": "Filter by zone IDs (comma-separated)"
},
"period": {
"type": "string",
"description": "Data grouping period: day, week, month, year"
},
"preset": {
"type": "string",
"description": "Date preset (same options as display report)"
},
"details": {
"type": "boolean",
"description": "Include detailed breakdown"
},
"summary": {
"type": "boolean",
"description": "Include summary data"
},
"timezone": {
"type": "string",
"description": "Timezone for preset"
},
"breakdown": {
"type": "boolean",
"description": "Include breakdown data"
},
"campaigns": {
"type": "string",
"description": "Filter by campaign IDs (comma-separated)"
},
"financials": {
"type": "boolean",
"description": "Include financial data"
},
"publishers": {
"type": "string",
"description": "Filter by publisher IDs (comma-separated)"
},
"advertisers": {
"type": "string",
"description": "Filter by advertiser IDs (comma-separated)"
}
},
"additionalProperties": false
}Get VAST zone conversion tracking tag
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST zone ID"
}
},
"additionalProperties": false
}Get VAST zone serving tags
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST zone ID"
}
},
"additionalProperties": false
}Get details of a specific video creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Get details of a specific standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
}
},
"additionalProperties": false
}Get the conversion tracking tag for a standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
}
},
"additionalProperties": false
}Get details of a specific ORTB native ad for a standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | ORTB native ad ID |
| zone_id* | number | Standard zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zone_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "ORTB native ad ID"
},
"zone_id": {
"type": "number",
"description": "Standard zone ID"
}
},
"additionalProperties": false
}Get the ad serving tag (embed code) for a zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
}
},
"additionalProperties": false
}List all ad items (banners) across all types (image, custom HTML, rich media, native, catalog)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all advertisers in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all campaigns across all types
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all creatives across all types (image, rich media, video, audio)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all generated reports across all configurations
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all report schedules across all configurations
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all zones across all types (standard, email, catalog)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived advertisers
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived standard campaigns
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived channels
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived contracts
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived email zones
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived publishers
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived standard zones
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all audiences in a user database
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}List all audio creatives
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all beacon signing keys in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all bidders in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all campaign assignments (ad items assigned to campaigns)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all standard campaigns
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all catalog ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all catalog zones (for product/retail ad serving)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all channel zone assignments
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all channels
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all contacts in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List file revisions for a contract document
| Argument | Type | Description |
|---|---|---|
| contract_id* | number | Contract ID |
| document_id* | number | Document ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"document_id"
],
"properties": {
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"document_id": {
"type": "number",
"description": "Document ID"
}
},
"additionalProperties": false
}List all documents for a contract
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}List all payments for a contract
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}List all contract templates
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all contracts
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all image creatives
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all custom HTML ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all saved report configurations
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all data key targets (targeting rules using data key values)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all data keys (custom key-value targeting variables)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all data lists in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all data targets
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all day parting rules (time-of-day targeting)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all demand endpoints in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all demand sources in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all email zones
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all event log upload configurations
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all event log upload logs
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all geo targets (geographic targeting rules)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all image ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all list targets (allowlist/blocklist targeting)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all managers in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all media groups (collections of creatives)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all native ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all native ad templates
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all data assets for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}List all image assets for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}List all OpenRTB native templates in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all title assets for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}List all placements (assignments of ad items to zones)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all platform targets (device/OS/browser targeting)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all PMP deals in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all postal code targets
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all product catalogs for a publisher
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}List all product source targets for a publisher
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}List all product sources for a publisher
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}List all publishers in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List generated reports for a specific report configuration
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}List generated reports for a specific schedule
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| schedule_id* | number | Schedule ID |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id",
"schedule_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"schedule_id": {
"type": "number",
"description": "Schedule ID"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}List schedules for a specific report configuration
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}List all rich media ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all rich media creatives
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all roles in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all schedules (time-based delivery rules for ad items)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all SFTP connections in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all recipients for a signature request
| Argument | Type | Description |
|---|---|---|
| request_id* | number | Signature request ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"request_id"
],
"properties": {
"request_id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}List all signature requests for a contract
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}List all trusted redirect domains in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all user attributes in a user database
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}List all user databases in your AdButler account
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST report data
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all video creatives
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all ORTB native ads for a standard zone
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
| zone_id* | number | Standard zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zone_id"
],
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
},
"zone_id": {
"type": "number",
"description": "Standard zone ID"
}
},
"additionalProperties": false
}List all standard zones
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}Remove all usages of a list target
| Argument | Type | Description |
|---|---|---|
| id* | number | List target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "List target ID"
}
},
"additionalProperties": false
}Remove values from a list attribute for a user
| Argument | Type | Description |
|---|---|---|
| values | array | Values to remove |
| user_id* | string | User ID |
| user_db_id* | number | User database ID |
| list_attribute_name* | string | List attribute name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"user_id",
"list_attribute_name"
],
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Values to remove"
},
"user_id": {
"type": "string",
"description": "User ID"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
},
"list_attribute_name": {
"type": "string",
"description": "List attribute name"
}
},
"additionalProperties": false
}Replace the file on an audio creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Replace the file on a contract document
| Argument | Type | Description |
|---|---|---|
| contract_id* | number | Contract ID |
| document_id* | number | Document ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"document_id"
],
"properties": {
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"document_id": {
"type": "number",
"description": "Document ID"
}
},
"additionalProperties": false
}Replace a contract document file from a template
| Argument | Type | Description |
|---|---|---|
| contract_id* | number | Contract ID |
| document_id* | number | Document ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"document_id"
],
"properties": {
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"document_id": {
"type": "number",
"description": "Document ID"
}
},
"additionalProperties": false
}Replace the file on an image creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Replace the file on a rich media creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Replace the file on a video creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
}
},
"additionalProperties": false
}Resend a signature request
| Argument | Type | Description |
|---|---|---|
| request_id* | number | Signature request ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"request_id"
],
"properties": {
"request_id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Resend the email verification code for a trial account. Use this if the user did not receive the code or it expired.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to create the trial account |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to create the trial account"
}
},
"additionalProperties": false
}Revoke historical access for a report schedule
| Argument | Type | Description |
|---|---|---|
| schedule_id* | number | Schedule ID |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id",
"schedule_id"
],
"properties": {
"schedule_id": {
"type": "number",
"description": "Schedule ID"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Find AdButler API endpoints by keyword when no specific tool matches what you need. Returns matching endpoints with their HTTP method, path, and a brief summary. Use this when the user asks about a concept that is a *field* rather than a resource — e.g. 'priority', 'pacing', 'frequency cap', 'metadata', 'tracking pixel' — and you can't find a tool that handles it. Then call describe_adbutler_api on the most promising hit, then call_adbutler_api to invoke it.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max results to return (default 10, max 50). |
| query* | string | Keyword(s) to search for. Single word works best. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"description": "Max results to return (default 10, max 50)."
},
"query": {
"type": "string",
"description": "Keyword(s) to search for. Single word works best."
}
},
"additionalProperties": false
}Search for items in a product catalog
| Argument | Type | Description |
|---|---|---|
| query | string | Search query string |
| catalog_id* | number | Catalog ID |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"catalog_id"
],
"properties": {
"query": {
"type": "string",
"description": "Search query string"
},
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Request ad delivery for a zone. Returns the ad(s) that would be served, useful for verifying ad setup. Uses POST /adserve.
| Argument | Type | Description |
|---|---|---|
| ID* | number | Your AdButler account ID |
| ip | string | IPv4 address for geographic targeting (required for server-side requests) |
| kw | array | Keywords for keyword targeting |
| rf | number | Pass 1 to include is_redirectable field in response |
| sh | number | Screen height for platform targeting |
| sw | number | Screen width for platform targeting |
| ua | string | User agent string for platform targeting |
| pid | number | Page ID for unique delivery/roadblocks (random number, same for all zones on page) |
| spr | number | Screen pixel ratio for platform targeting |
| size | string | Expected ad size (e.g. "300x250") |
| type* | string | Response type: "json" for most eligible ad, "jsonr" for all eligible ads ranked |
| place | number | Place counter for unique delivery (0, 1, 2, etc.) |
| setID* | number | Zone ID to serve an ad from |
| referrer | string | Page URL for URL targeting (required for server-side requests) |
| _abdk_json | object | Data key key-value pairs for data key targeting |
| defer_signing | boolean | Defer beacon signing hash generation |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"ID",
"setID",
"type"
],
"properties": {
"ID": {
"type": "number",
"description": "Your AdButler account ID"
},
"ip": {
"type": "string",
"description": "IPv4 address for geographic targeting (required for server-side requests)"
},
"kw": {
"type": "array",
"items": {
"type": "string"
},
"description": "Keywords for keyword targeting"
},
"rf": {
"type": "number",
"description": "Pass 1 to include is_redirectable field in response"
},
"sh": {
"type": "number",
"description": "Screen height for platform targeting"
},
"sw": {
"type": "number",
"description": "Screen width for platform targeting"
},
"ua": {
"type": "string",
"description": "User agent string for platform targeting"
},
"pid": {
"type": "number",
"description": "Page ID for unique delivery/roadblocks (random number, same for all zones on page)"
},
"spr": {
"type": "number",
"description": "Screen pixel ratio for platform targeting"
},
"size": {
"type": "string",
"description": "Expected ad size (e.g. \"300x250\")"
},
"type": {
"enum": [
"json",
"jsonr"
],
"type": "string",
"description": "Response type: \"json\" for most eligible ad, \"jsonr\" for all eligible ads ranked"
},
"place": {
"type": "number",
"description": "Place counter for unique delivery (0, 1, 2, etc.)"
},
"setID": {
"type": "number",
"description": "Zone ID to serve an ad from"
},
"referrer": {
"type": "string",
"description": "Page URL for URL targeting (required for server-side requests)"
},
"_abdk_json": {
"type": "object",
"description": "Data key key-value pairs for data key targeting",
"additionalProperties": {}
},
"defer_signing": {
"type": "boolean",
"description": "Defer beacon signing hash generation"
}
},
"additionalProperties": false
}Configure AdButler with an existing API key. Use this if the user already has an AdButler account and API key. Note: this configures the key for the current session only. For a persistent connection, the user should instead put the key in their MCP connection settings (an "Authorization: Bearer" header, or "?api_key=" appended to the server URL) — prefer suggesting that before asking the user to share their key in chat.
| Argument | Type | Description |
|---|---|---|
| api_key* | string | The AdButler API key |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"api_key"
],
"properties": {
"api_key": {
"type": "string",
"description": "The AdButler API key"
}
},
"additionalProperties": false
}Push externally-tracked Kogan stats (impressions, clicks, conversions, quantity sold, sales) into AdButler for a set of ad items over a time window. Kogan marketplace accounts only — requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
| Argument | Type | Description |
|---|---|---|
| data* | array | Per-ad-item stat rows to record |
| meta* | object | Time window the stat rows cover |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"data",
"meta"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"ad_item_id"
],
"properties": {
"sales": {
"type": "number",
"description": "Sales value in the window (default 0.00)"
},
"clicks": {
"type": "number",
"description": "Clicks in the window (default 0)"
},
"ad_item_id": {
"type": [
"number",
"string"
],
"description": "Numeric ad item ID, or a Value Catcher composite ID \"seller_id,sku,wallet_id,zone_id\" (e.g. \"KoganSeller,OVMIASDBDWA,3,104446)\""
},
"conversions": {
"type": "number",
"description": "Conversions in the window (default 0)"
},
"impressions": {
"type": "number",
"description": "Impressions in the window (default 0)"
},
"quantity_sold": {
"type": "number",
"description": "Units sold in the window (default 0)"
}
},
"additionalProperties": false
},
"description": "Per-ad-item stat rows to record"
},
"meta": {
"type": "object",
"required": [
"from",
"to",
"timezone"
],
"properties": {
"to": {
"type": "string",
"description": "Window end, ISO-8601"
},
"from": {
"type": "string",
"description": "Window start, ISO-8601 (e.g. \"2026-02-06T00:00:00+11:00\")"
},
"timezone": {
"type": "string",
"description": "Timezone of the window (e.g. \"Australia/Melbourne\")"
}
},
"description": "Time window the stat rows cover",
"additionalProperties": false
}
},
"additionalProperties": false
}Test an SFTP connection with the provided credentials
| Argument | Type | Description |
|---|---|---|
| host | string | SFTP host |
| path | string | Remote path |
| port | number | SFTP port |
| password | string | SFTP password |
| username | string | SFTP username |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"host": {
"type": "string",
"description": "SFTP host"
},
"path": {
"type": "string",
"description": "Remote path"
},
"port": {
"type": "number",
"description": "SFTP port"
},
"password": {
"type": "string",
"description": "SFTP password"
},
"username": {
"type": "string",
"description": "SFTP username"
}
},
"additionalProperties": false
}Restore an archived advertiser back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived advertiser ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived advertiser ID"
}
},
"additionalProperties": false
}Restore an archived standard campaign back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived campaign ID"
}
},
"additionalProperties": false
}Restore an archived channel back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived channel ID"
}
},
"additionalProperties": false
}Unarchive a contract (restore from archive)
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived contract ID"
}
},
"additionalProperties": false
}Restore an archived email zone back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived email zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived email zone ID"
}
},
"additionalProperties": false
}Restore an archived publisher back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived publisher ID"
}
},
"additionalProperties": false
}Restore an archived standard zone back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived zone ID"
}
},
"additionalProperties": false
}Update an existing advertiser
| Argument | Type | Description |
|---|---|---|
| id* | number | Advertiser ID |
| name | string | Advertiser name |
| string | Contact email | |
| metadata | object | Custom metadata key-value pairs |
| password | string | Password for advertiser portal (min 8 chars, must include upper, lower, number) |
| can_add_ad_items | boolean | Whether advertiser can submit advertisements for scheduling |
| can_change_password | boolean | Whether advertiser can change password |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Advertiser ID"
},
"name": {
"type": "string",
"description": "Advertiser name"
},
"email": {
"type": "string",
"description": "Contact email"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"password": {
"type": "string",
"description": "Password for advertiser portal (min 8 chars, must include upper, lower, number)"
},
"can_add_ad_items": {
"type": "boolean",
"description": "Whether advertiser can submit advertisements for scheduling"
},
"can_change_password": {
"type": "boolean",
"description": "Whether advertiser can change password"
}
},
"additionalProperties": false
}Update an existing audience in a user database
| Argument | Type | Description |
|---|---|---|
| id* | number | Audience ID |
| name | string | Audience name |
| attributes | object | Attribute targets defining the audience |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Audience ID"
},
"name": {
"type": "string",
"description": "Audience name"
},
"attributes": {
"type": "object",
"description": "Attribute targets defining the audience",
"additionalProperties": {
"type": "object",
"required": [
"operator",
"operand"
],
"properties": {
"operand": {
"type": "string",
"description": "Value to compare against"
},
"operator": {
"type": "string",
"description": "Comparison operator"
}
},
"additionalProperties": false
}
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Update an existing audio creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
| name | string | Creative name |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
},
"name": {
"type": "string",
"description": "Creative name"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Update an existing beacon signing key
| Argument | Type | Description |
|---|---|---|
| id* | number | Beacon signing key ID |
| key_name | string | Beacon signing key name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Beacon signing key ID"
},
"key_name": {
"type": "string",
"description": "Beacon signing key name"
}
},
"additionalProperties": false
}Update an existing bidder
| Argument | Type | Description |
|---|---|---|
| id* | number | Bidder ID |
| name | string | Bidder name |
| status | string | Bidder status |
| bid_url | string | Bid endpoint URL |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Bidder ID"
},
"name": {
"type": "string",
"description": "Bidder name"
},
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "Bidder status"
},
"bid_url": {
"type": "string",
"description": "Bid endpoint URL"
}
},
"additionalProperties": false
}Update an existing standard campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign ID |
| name | string | Campaign name |
| budget | object | Budget limits |
| contract | number | Contract ID |
| metadata | object | Custom metadata key-value pairs |
| advertiser | number | Advertiser ID |
| roadblock_tags | string | Roadblock tag |
| targeting_source | string | Targeting level |
| scheduling_source | string | Scheduling level |
| trusted_redirect_domains | array | Trusted redirect domains |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign ID"
},
"name": {
"type": "string",
"description": "Campaign name"
},
"budget": {
"type": "object",
"properties": {
"daily": {
"type": "number"
},
"weekly": {
"type": "number"
},
"monthly": {
"type": "number"
},
"lifetime": {
"type": "number"
}
},
"description": "Budget limits",
"additionalProperties": false
},
"contract": {
"type": "number",
"description": "Contract ID"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"advertiser": {
"type": "number",
"description": "Advertiser ID"
},
"roadblock_tags": {
"type": "string",
"description": "Roadblock tag"
},
"targeting_source": {
"enum": [
"CAMPAIGN",
"AD_ITEM"
],
"type": "string",
"description": "Targeting level"
},
"scheduling_source": {
"enum": [
"CAMPAIGN",
"AD_ITEM"
],
"type": "string",
"description": "Scheduling level"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
}
},
"additionalProperties": false
}Update an existing campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | Campaign assignment ID |
| active | boolean | Whether assignment is active |
| weight | number | Relative delivery weight |
| keywords | string | Comma-separated keywords |
| schedule | number | Schedule ID |
| geo_target | number | Geo Target ID |
| list_target | number | List Target ID |
| data_key_target | number | Data Key Target ID |
| platform_target | number | Platform Target ID |
| keywords_match_method | string | Keyword matching method |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Campaign assignment ID"
},
"active": {
"type": "boolean",
"description": "Whether assignment is active"
},
"weight": {
"type": "number",
"description": "Relative delivery weight"
},
"keywords": {
"type": "string",
"description": "Comma-separated keywords"
},
"schedule": {
"type": "number",
"description": "Schedule ID"
},
"geo_target": {
"type": "number",
"description": "Geo Target ID"
},
"list_target": {
"type": "number",
"description": "List Target ID"
},
"data_key_target": {
"type": "number",
"description": "Data Key Target ID"
},
"platform_target": {
"type": "number",
"description": "Platform Target ID"
},
"keywords_match_method": {
"enum": [
"required",
"preferred",
"filtered"
],
"type": "string",
"description": "Keyword matching method"
}
},
"additionalProperties": false
}Update an existing catalog ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
| name | string | Ad item name |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| catalog_item_identifier | string | Unique identifier for the catalog item |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
},
"name": {
"type": "string",
"description": "Ad item name"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"catalog_item_identifier": {
"type": "string",
"description": "Unique identifier for the catalog item"
}
},
"additionalProperties": false
}Update an existing catalog zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Catalog zone ID |
| name | string | Zone name |
| auction_type | string | Auction type |
| bid_floor_cpc | number | CPC bid floor |
| bid_floor_cpm | number | CPM bid floor |
| advertiser_cost_type | string | Billing model |
| click_cooldown_period | number | Click cooldown period in seconds |
| conversion_lookback_period | number | Conversion lookback period in seconds |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Catalog zone ID"
},
"name": {
"type": "string",
"description": "Zone name"
},
"auction_type": {
"enum": [
"FIRST_PRICE",
"SECOND_PRICE"
],
"type": "string",
"description": "Auction type"
},
"bid_floor_cpc": {
"type": "number",
"description": "CPC bid floor"
},
"bid_floor_cpm": {
"type": "number",
"description": "CPM bid floor"
},
"advertiser_cost_type": {
"enum": [
"CPM",
"CPC"
],
"type": "string",
"description": "Billing model"
},
"click_cooldown_period": {
"type": "number",
"description": "Click cooldown period in seconds"
},
"conversion_lookback_period": {
"type": "number",
"description": "Conversion lookback period in seconds"
}
},
"additionalProperties": false
}Update an existing channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Channel ID |
| name | string | Channel name |
| priority | string | Serving priority |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Channel ID"
},
"name": {
"type": "string",
"description": "Channel name"
},
"priority": {
"enum": [
"sponsorship",
"standard",
"network",
"bulk",
"house"
],
"type": "string",
"description": "Serving priority"
}
},
"additionalProperties": false
}Update an existing contact
| Argument | Type | Description |
|---|---|---|
| id* | number | Contact ID |
| name | string | Contact name |
| string | Contact email address | |
| notes | string | Additional notes |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contact ID"
},
"name": {
"type": "string",
"description": "Contact name"
},
"email": {
"type": "string",
"description": "Contact email address"
},
"notes": {
"type": "string",
"description": "Additional notes"
}
},
"additionalProperties": false
}Update an existing contract
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract ID |
| name | string | Contract name |
| rate | number | Contract rate |
| end_at | string | Contract end date (YYYY-MM-DD) |
| status | string | Contract status |
| start_at | string | Contract start date (YYYY-MM-DD) |
| advertiser | number | Advertiser ID |
| description | string | Contract description |
| payment_due_date | string | Payment due date (YYYY-MM-DD) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract ID"
},
"name": {
"type": "string",
"description": "Contract name"
},
"rate": {
"type": "number",
"description": "Contract rate"
},
"end_at": {
"type": "string",
"description": "Contract end date (YYYY-MM-DD)"
},
"status": {
"enum": [
"open",
"terminated",
"fulfilled",
"closed"
],
"type": "string",
"description": "Contract status"
},
"start_at": {
"type": "string",
"description": "Contract start date (YYYY-MM-DD)"
},
"advertiser": {
"type": "number",
"description": "Advertiser ID"
},
"description": {
"type": "string",
"description": "Contract description"
},
"payment_due_date": {
"type": "string",
"description": "Payment due date (YYYY-MM-DD)"
}
},
"additionalProperties": false
}Update an existing contract document
| Argument | Type | Description |
|---|---|---|
| id* | number | Document ID |
| name | string | Document name |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Document ID"
},
"name": {
"type": "string",
"description": "Document name"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Update an existing contract template
| Argument | Type | Description |
|---|---|---|
| id* | number | Contract template ID |
| name | string | Template name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Contract template ID"
},
"name": {
"type": "string",
"description": "Template name"
}
},
"additionalProperties": false
}Update an existing image creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
| name | string | Creative name |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
},
"name": {
"type": "string",
"description": "Creative name"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Update an existing custom HTML ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
| name | string | Ad item name |
| width | number | Ad width in pixels |
| height | number | Ad height in pixels |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| custom_html | string | The HTML content |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| html_content_below | string | HTML content below the ad item |
| trusted_redirect_domains | array | Trusted redirect domains |
| expand_vertical_direction | string | Vertical expand direction |
| expand_horizontal_direction | string | Horizontal expand direction |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
},
"name": {
"type": "string",
"description": "Ad item name"
},
"width": {
"type": "number",
"description": "Ad width in pixels"
},
"height": {
"type": "number",
"description": "Ad height in pixels"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"custom_html": {
"type": "string",
"description": "The HTML content"
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"html_content_below": {
"type": "string",
"description": "HTML content below the ad item"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
},
"expand_vertical_direction": {
"enum": [
"none",
"up",
"down"
],
"type": "string",
"description": "Vertical expand direction"
},
"expand_horizontal_direction": {
"enum": [
"none",
"left",
"right"
],
"type": "string",
"description": "Horizontal expand direction"
}
},
"additionalProperties": false
}Update an existing report configuration
| Argument | Type | Description |
|---|---|---|
| id* | number | Report configuration ID |
| date | object | Date configuration |
| name | string | Report name |
| type | string | Report type |
| period | string | Data grouping period |
| columns | array | Columns to include |
| filters | object | Filter criteria |
| exclude_channel_stats | boolean | Exclude stats from channel-served ads |
| require_channel_stats | boolean | Only include stats from channel-served ads |
| exclude_campaign_ad_items | boolean | Exclude ad items in campaigns |
| exclude_publisher_ad_items | boolean | Exclude ad items directly in zones |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Report configuration ID"
},
"date": {
"type": "object",
"properties": {
"end": {
"type": "string"
},
"start": {
"type": "string"
},
"preset": {
"type": "string"
},
"timezone": {
"type": "string"
}
},
"description": "Date configuration",
"additionalProperties": false
},
"name": {
"type": "string",
"description": "Report name"
},
"type": {
"enum": [
"overview",
"advertiser",
"publisher",
"zone",
"campaign",
"channel",
"geo-target",
"ad-item"
],
"type": "string",
"description": "Report type"
},
"period": {
"enum": [
"day",
"week",
"month",
"year"
],
"type": "string",
"description": "Data grouping period"
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"description": "Columns to include"
},
"filters": {
"type": "object",
"description": "Filter criteria",
"additionalProperties": {}
},
"exclude_channel_stats": {
"type": "boolean",
"description": "Exclude stats from channel-served ads"
},
"require_channel_stats": {
"type": "boolean",
"description": "Only include stats from channel-served ads"
},
"exclude_campaign_ad_items": {
"type": "boolean",
"description": "Exclude ad items in campaigns"
},
"exclude_publisher_ad_items": {
"type": "boolean",
"description": "Exclude ad items directly in zones"
}
},
"additionalProperties": false
}Update an existing data key
| Argument | Type | Description |
|---|---|---|
| id* | number | Data key ID |
| name | string | Data key name |
| type | string | Data key value type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data key ID"
},
"name": {
"type": "string",
"description": "Data key name"
},
"type": {
"enum": [
"STRING",
"NUMBER",
"DATE",
"DATETIME",
"TIME"
],
"type": "string",
"description": "Data key value type"
}
},
"additionalProperties": false
}Update an existing data key target
| Argument | Type | Description |
|---|---|---|
| id* | number | Data key target ID |
| name | string | Data key target name |
| target | string | JSON formatted target logic |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data key target ID"
},
"name": {
"type": "string",
"description": "Data key target name"
},
"target": {
"type": "string",
"description": "JSON formatted target logic"
}
},
"additionalProperties": false
}Update an existing data list
| Argument | Type | Description |
|---|---|---|
| id* | number | Data list ID |
| label | string | Data list label/name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data list ID"
},
"label": {
"type": "string",
"description": "Data list label/name"
}
},
"additionalProperties": false
}Update an existing day parting rule
| Argument | Type | Description |
|---|---|---|
| id* | number | Day parting ID |
| name | string | Day parting name |
| ranges | object | Object mapping day names (monday-sunday) to arrays of time ranges |
| is_template | boolean | If true, shown in UI when creating/editing schedules |
| use_member_timezone | boolean | If true, use account timezone; if false, use viewer timezone |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Day parting ID"
},
"name": {
"type": "string",
"description": "Day parting name"
},
"ranges": {
"type": "object",
"description": "Object mapping day names (monday-sunday) to arrays of time ranges",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"is_template": {
"type": "boolean",
"description": "If true, shown in UI when creating/editing schedules"
},
"use_member_timezone": {
"type": "boolean",
"description": "If true, use account timezone; if false, use viewer timezone"
}
},
"additionalProperties": false
}Update an existing demand endpoint
| Argument | Type | Description |
|---|---|---|
| id* | number | Demand endpoint ID |
| name | string | Demand endpoint name |
| status | string | Whether to send bid requests |
| priority | string | Serving priority |
| bid_floor | number | Default CPM bid floor |
| geo_target | number | Geo target ID |
| filter_type | string | Zone filtering type |
| allowed_sizes | array | Allowed zone sizes |
| demand_source | number | Demand Source ID |
| revenue_share | number | Revenue share percentage |
| filtered_zones | array | Zone IDs for filter list |
| markup_percent | number | Markup percent |
| supported_formats | array | Supported ad formats |
| default_parameters | object | Default parameters |
| filtered_vast_zones | array | VAST zone IDs for filter list |
| native_json_encoded | boolean | Whether native JSON should be encoded |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Demand endpoint ID"
},
"name": {
"type": "string",
"description": "Demand endpoint name"
},
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "Whether to send bid requests"
},
"priority": {
"enum": [
"sponsorship",
"standard",
"network",
"bulk",
"house"
],
"type": "string",
"description": "Serving priority"
},
"bid_floor": {
"type": "number",
"description": "Default CPM bid floor"
},
"geo_target": {
"type": "number",
"description": "Geo target ID"
},
"filter_type": {
"enum": [
"all",
"whitelist",
"blacklist"
],
"type": "string",
"description": "Zone filtering type"
},
"allowed_sizes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed zone sizes"
},
"demand_source": {
"type": "number",
"description": "Demand Source ID"
},
"revenue_share": {
"type": "number",
"description": "Revenue share percentage"
},
"filtered_zones": {
"type": "array",
"items": {
"type": "number"
},
"description": "Zone IDs for filter list"
},
"markup_percent": {
"type": "number",
"description": "Markup percent"
},
"supported_formats": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supported ad formats"
},
"default_parameters": {
"type": "object",
"description": "Default parameters",
"additionalProperties": {}
},
"filtered_vast_zones": {
"type": "array",
"items": {
"type": "number"
},
"description": "VAST zone IDs for filter list"
},
"native_json_encoded": {
"type": "boolean",
"description": "Whether native JSON should be encoded"
}
},
"additionalProperties": false
}Update an existing demand source
| Argument | Type | Description |
|---|---|---|
| id* | number | Demand source ID |
| name | string | Demand source name |
| status | string | Whether to send bid requests |
| spend_limit | number | Spend limit amount |
| spend_limit_end | string | Spend limit end date (ISO-8601) |
| spend_limit_start | string | Spend limit start date (ISO-8601) |
| spend_limit_period | string | Spend limit reset interval |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Demand source ID"
},
"name": {
"type": "string",
"description": "Demand source name"
},
"status": {
"enum": [
"active",
"inactive"
],
"type": "string",
"description": "Whether to send bid requests"
},
"spend_limit": {
"type": "number",
"description": "Spend limit amount"
},
"spend_limit_end": {
"type": "string",
"description": "Spend limit end date (ISO-8601)"
},
"spend_limit_start": {
"type": "string",
"description": "Spend limit start date (ISO-8601)"
},
"spend_limit_period": {
"enum": [
"once",
"weekly",
"biweekly",
"monthly",
"quarterly"
],
"type": "string",
"description": "Spend limit reset interval"
}
},
"additionalProperties": false
}Update an existing email zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Email zone ID |
| name | string | Zone name |
| width | number | Zone width in pixels |
| height | number | Zone height in pixels |
| metadata | object | Custom metadata key-value pairs |
| publisher | number | Publisher ID |
| uid_rotate | boolean | Serve different ads per user |
| rotate_timer | object | Period after which user sees a new ad |
| auction_tie_break | string | Tie-breaking method |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Email zone ID"
},
"name": {
"type": "string",
"description": "Zone name"
},
"width": {
"type": "number",
"description": "Zone width in pixels"
},
"height": {
"type": "number",
"description": "Zone height in pixels"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"publisher": {
"type": "number",
"description": "Publisher ID"
},
"uid_rotate": {
"type": "boolean",
"description": "Serve different ads per user"
},
"rotate_timer": {
"type": "object",
"required": [
"amount",
"interval"
],
"properties": {
"amount": {
"type": "number",
"description": "Period amount"
},
"interval": {
"enum": [
"minutes",
"days"
],
"type": "string",
"description": "Period interval"
}
},
"description": "Period after which user sees a new ad",
"additionalProperties": false
},
"auction_tie_break": {
"enum": [
"RANDOM",
"SCORE"
],
"type": "string",
"description": "Tie-breaking method"
}
},
"additionalProperties": false
}Update an existing event log upload configuration
| Argument | Type | Description |
|---|---|---|
| id* | number | Upload configuration ID |
| name | string | Configuration name |
| format | string | Log file format |
| enabled | boolean | Whether the upload configuration is enabled |
| frequency | string | Upload frequency (e.g. "daily", "hourly") |
| connection_id | number | SFTP connection ID to use for upload |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Upload configuration ID"
},
"name": {
"type": "string",
"description": "Configuration name"
},
"format": {
"type": "string",
"description": "Log file format"
},
"enabled": {
"type": "boolean",
"description": "Whether the upload configuration is enabled"
},
"frequency": {
"type": "string",
"description": "Upload frequency (e.g. \"daily\", \"hourly\")"
},
"connection_id": {
"type": "number",
"description": "SFTP connection ID to use for upload"
}
},
"additionalProperties": false
}Update an existing geo target
| Argument | Type | Description |
|---|---|---|
| id* | number | Geo target ID |
| name | string | Geo target name |
| unit | string | Distance unit |
| areas | array | Array of geographic areas |
| range | number | Radius range |
| inclusive | boolean | If true, target users IN these areas; if false, EXCLUDE |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Geo target ID"
},
"name": {
"type": "string",
"description": "Geo target name"
},
"unit": {
"enum": [
"miles",
"kilometers"
],
"type": "string",
"description": "Distance unit"
},
"areas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "City name"
},
"region": {
"type": "string",
"description": "Region/state"
},
"country": {
"type": "string",
"description": "Two-letter country code"
},
"continent": {
"type": "string",
"description": "Continent name"
}
},
"additionalProperties": false
},
"description": "Array of geographic areas"
},
"range": {
"type": "number",
"description": "Radius range"
},
"inclusive": {
"type": "boolean",
"description": "If true, target users IN these areas; if false, EXCLUDE"
}
},
"additionalProperties": false
}Update an existing image ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
| name | string | Ad item name |
| width | number | Ad width in pixels |
| height | number | Ad height in pixels |
| creative | number | Image creative ID |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| html_target | string | Window/frame for destination URL |
| creative_url | string | URL to image file |
| html_alt_text | string | Alt text for the image |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| html_content_below | string | HTML content below the ad item |
| trusted_redirect_domains | array | Trusted redirect domains |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
},
"name": {
"type": "string",
"description": "Ad item name"
},
"width": {
"type": "number",
"description": "Ad width in pixels"
},
"height": {
"type": "number",
"description": "Ad height in pixels"
},
"creative": {
"type": "number",
"description": "Image creative ID"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"html_target": {
"type": "string",
"description": "Window/frame for destination URL"
},
"creative_url": {
"type": "string",
"description": "URL to image file"
},
"html_alt_text": {
"type": "string",
"description": "Alt text for the image"
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"html_content_below": {
"type": "string",
"description": "HTML content below the ad item"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
}
},
"additionalProperties": false
}Update the category and category slug of a Kogan marketplace product. Kogan marketplace accounts only — requires the Kogan self-serve feature; other accounts receive a feature-not-enabled error.
| Argument | Type | Description |
|---|---|---|
| sku* | string | Product SKU |
| category* | string | New category name |
| seller_id* | string | Kogan seller ID |
| category_slug* | string | New category slug |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"seller_id",
"sku",
"category",
"category_slug"
],
"properties": {
"sku": {
"type": "string",
"description": "Product SKU"
},
"category": {
"type": "string",
"description": "New category name"
},
"seller_id": {
"type": "string",
"description": "Kogan seller ID"
},
"category_slug": {
"type": "string",
"description": "New category slug"
}
},
"additionalProperties": false
}Update an existing list target
| Argument | Type | Description |
|---|---|---|
| id* | number | List target ID |
| label | string | List target name |
| data_list | number | Data list ID |
| inclusive | boolean | If true, inclusion; if false, exclusion |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "List target ID"
},
"label": {
"type": "string",
"description": "List target name"
},
"data_list": {
"type": "number",
"description": "Data list ID"
},
"inclusive": {
"type": "boolean",
"description": "If true, inclusion; if false, exclusion"
}
},
"additionalProperties": false
}Update an existing manager
| Argument | Type | Description |
|---|---|---|
| id* | number | Manager ID |
| name | string | Manager name |
| string | Manager email address | |
| notes | string | Notes about the manager |
| password | string | Login password |
| position | string | Manager position |
| is_enabled | boolean | Whether the manager account is enabled |
| can_manage_links | boolean | Can manage tracking links |
| can_manage_media | boolean | Can manage creatives and media groups |
| can_manage_users | boolean | Can manage users |
| publisher_access | string | Publisher access level |
| statistics_access | string | Statistics access level |
| can_manage_bidders | boolean | Can manage bidders |
| can_manage_billing | boolean | Can manage billing |
| can_manage_targets | boolean | Can manage targets |
| can_manage_tickets | boolean | Can manage tickets |
| can_manage_contracts | boolean | Can manage contracts |
| can_manage_data_keys | boolean | Can manage data keys |
| can_manage_product_db | boolean | Can manage product catalogs |
| can_manage_self_serve | boolean | Can manage Self-Serve |
| publisher_access_list | array | Publisher IDs for specific access |
| can_manage_programmatic | boolean | Can manage programmatic |
| can_manage_admin_api_access | boolean | Can manage API keys |
| can_assign_campaigns_directly | boolean | Can assign campaigns directly |
| can_manage_native_ad_templates | boolean | Can manage native templates |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Manager ID"
},
"name": {
"type": "string",
"description": "Manager name"
},
"email": {
"type": "string",
"description": "Manager email address"
},
"notes": {
"type": "string",
"description": "Notes about the manager"
},
"password": {
"type": "string",
"description": "Login password"
},
"position": {
"type": "string",
"description": "Manager position"
},
"is_enabled": {
"type": "boolean",
"description": "Whether the manager account is enabled"
},
"can_manage_links": {
"type": "boolean",
"description": "Can manage tracking links"
},
"can_manage_media": {
"type": "boolean",
"description": "Can manage creatives and media groups"
},
"can_manage_users": {
"type": "boolean",
"description": "Can manage users"
},
"publisher_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Publisher access level"
},
"statistics_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Statistics access level"
},
"can_manage_bidders": {
"type": "boolean",
"description": "Can manage bidders"
},
"can_manage_billing": {
"type": "boolean",
"description": "Can manage billing"
},
"can_manage_targets": {
"type": "boolean",
"description": "Can manage targets"
},
"can_manage_tickets": {
"type": "boolean",
"description": "Can manage tickets"
},
"can_manage_contracts": {
"type": "boolean",
"description": "Can manage contracts"
},
"can_manage_data_keys": {
"type": "boolean",
"description": "Can manage data keys"
},
"can_manage_product_db": {
"type": "boolean",
"description": "Can manage product catalogs"
},
"can_manage_self_serve": {
"type": "boolean",
"description": "Can manage Self-Serve"
},
"publisher_access_list": {
"type": "array",
"items": {
"type": "number"
},
"description": "Publisher IDs for specific access"
},
"can_manage_programmatic": {
"type": "boolean",
"description": "Can manage programmatic"
},
"can_manage_admin_api_access": {
"type": "boolean",
"description": "Can manage API keys"
},
"can_assign_campaigns_directly": {
"type": "boolean",
"description": "Can assign campaigns directly"
},
"can_manage_native_ad_templates": {
"type": "boolean",
"description": "Can manage native templates"
}
},
"additionalProperties": false
}Update an existing media group
| Argument | Type | Description |
|---|---|---|
| id* | number | Media group ID |
| name | string | Media group name |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Media group ID"
},
"name": {
"type": "string",
"description": "Media group name"
}
},
"additionalProperties": false
}Update an existing native ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
| name | string | Ad item name |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| template | number | Native template ID |
| variables | object | Template variables as key-value pairs |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| trusted_redirect_domains | array | Trusted redirect domains |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
},
"name": {
"type": "string",
"description": "Ad item name"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"template": {
"type": "number",
"description": "Native template ID"
},
"variables": {
"type": "object",
"description": "Template variables as key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
}
},
"additionalProperties": false
}Update an existing native template. Variables uses add/remove format for updates.
| Argument | Type | Description |
|---|---|---|
| id* | number | Native template ID |
| name | string | Template name |
| raw_html | string | HTML template content with variable placeholders |
| variables | object | Variables to add/remove |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Native template ID"
},
"name": {
"type": "string",
"description": "Template name"
},
"raw_html": {
"type": "string",
"description": "HTML template content with variable placeholders"
},
"variables": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"placeholder",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "Variable name"
},
"type": {
"enum": [
"url",
"url_raw",
"text",
"file",
"number",
"image_url",
"dropdown",
"third_party_script"
],
"type": "string",
"description": "Variable type"
},
"optional": {
"type": "boolean"
},
"max_length": {
"type": "number"
},
"placeholder": {
"type": "string",
"description": "Placeholder in raw_html"
},
"dropdown_values": {
"type": "string"
}
},
"additionalProperties": false
},
"description": "Variables to add"
},
"remove": {
"type": "array",
"items": {
"type": "number"
},
"description": "Variable IDs to remove"
}
},
"description": "Variables to add/remove",
"additionalProperties": false
}
},
"additionalProperties": false
}Update an existing data asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Data asset ID |
| len | number | Max length |
| type | number | Data asset type |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Data asset ID"
},
"len": {
"type": "number",
"description": "Max length"
},
"type": {
"type": "number",
"description": "Data asset type"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Update an existing image asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| h | number | Height |
| w | number | Width |
| id* | number | Image asset ID |
| hmin | number | Min height |
| type | number | Image asset type |
| wmin | number | Min width |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"h": {
"type": "number",
"description": "Height"
},
"w": {
"type": "number",
"description": "Width"
},
"id": {
"type": "number",
"description": "Image asset ID"
},
"hmin": {
"type": "number",
"description": "Min height"
},
"type": {
"type": "number",
"description": "Image asset type"
},
"wmin": {
"type": "number",
"description": "Min width"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Update an existing OpenRTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | ORTB native template ID |
| name | string | ORTB native template name |
| html_template | string | HTML template for rendering the native ad |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "ORTB native template ID"
},
"name": {
"type": "string",
"description": "ORTB native template name"
},
"html_template": {
"type": "string",
"description": "HTML template for rendering the native ad"
}
},
"additionalProperties": false
}Update an existing title asset for an ORTB native template
| Argument | Type | Description |
|---|---|---|
| id* | number | Title asset ID |
| len | number | Max length of title |
| template_id* | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Title asset ID"
},
"len": {
"type": "number",
"description": "Max length of title"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Update an existing placement
| Argument | Type | Description |
|---|---|---|
| id* | number | Placement ID |
| cost | object | Pricing model |
| zone | object | Zone object (mutually exclusive with channel) |
| active | boolean | Whether placement is active |
| payout | object | Publisher payout configuration |
| weight | number | Relative delivery weight |
| channel | number | Channel ID (mutually exclusive with zone) |
| keywords | string | Comma-separated keywords |
| priority | string | Serving priority level |
| schedule | number | Schedule ID |
| geo_target | number | Geotarget ID |
| list_target | number | List Target ID |
| serve_method | string | Serving system |
| advertisement | object | Advertisement object with id and type |
| share_of_voice | number | Share of voice percentage |
| platform_target | number | Platform target ID |
| data_key_target_id | number | Data Key Target ID |
| contextual_segments | array | Array of contextual segment IDs |
| keywords_match_method | string | Keyword matching method |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Placement ID"
},
"cost": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"fixed_cost": {
"type": "number"
}
},
"description": "Pricing model",
"additionalProperties": false
},
"zone": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
},
"type": {
"enum": [
"standard_zone",
"text_zone",
"email_zone"
],
"type": "string",
"description": "Zone type"
}
},
"description": "Zone object (mutually exclusive with channel)",
"additionalProperties": false
},
"active": {
"type": "boolean",
"description": "Whether placement is active"
},
"payout": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"type": {
"enum": [
"rate",
"percent"
],
"type": "string"
},
"fixed": {
"type": "number"
}
},
"description": "Publisher payout configuration",
"additionalProperties": false
},
"weight": {
"type": "number",
"description": "Relative delivery weight"
},
"channel": {
"type": "number",
"description": "Channel ID (mutually exclusive with zone)"
},
"keywords": {
"type": "string",
"description": "Comma-separated keywords"
},
"priority": {
"enum": [
"sponsorship",
"standard",
"network",
"bulk",
"house"
],
"type": "string",
"description": "Serving priority level"
},
"schedule": {
"type": "number",
"description": "Schedule ID"
},
"geo_target": {
"type": "number",
"description": "Geotarget ID"
},
"list_target": {
"type": "number",
"description": "List Target ID"
},
"serve_method": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Serving system"
},
"advertisement": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item or campaign ID"
},
"type": {
"type": "string",
"description": "Type: \"image_ad_item\", \"custom_html_ad_item\", \"rich_media_ad_item\", \"native_ad_item\", \"standard_campaign\""
}
},
"description": "Advertisement object with id and type",
"additionalProperties": false
},
"share_of_voice": {
"type": "number",
"description": "Share of voice percentage"
},
"platform_target": {
"type": "number",
"description": "Platform target ID"
},
"data_key_target_id": {
"type": "number",
"description": "Data Key Target ID"
},
"contextual_segments": {
"type": "array",
"items": {
"type": "number"
},
"description": "Array of contextual segment IDs"
},
"keywords_match_method": {
"enum": [
"required",
"preferred",
"filtered"
],
"type": "string",
"description": "Keyword matching method"
}
},
"additionalProperties": false
}Update an existing platform target
| Argument | Type | Description |
|---|---|---|
| id* | number | Platform target ID |
| name | string | Platform target name |
| platform | string | Preset platform target |
| device_targets | array | List of device patterns to target |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Platform target ID"
},
"name": {
"type": "string",
"description": "Platform target name"
},
"platform": {
"enum": [
"any",
"specific",
"mobile",
"tablet",
"mobile_and_tablet",
"desktop"
],
"type": "string",
"description": "Preset platform target"
},
"device_targets": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of device patterns to target"
}
},
"additionalProperties": false
}Update an existing PMP deal
| Argument | Type | Description |
|---|---|---|
| id* | number | PMP deal ID |
| name | string | PMP deal name |
| bid_floor | number | Bid floor |
| geo_target | number | Geo target ID |
| audience_target | number | Audience target ID |
| whitelist_seats | array | Seat IDs with access |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "PMP deal ID"
},
"name": {
"type": "string",
"description": "PMP deal name"
},
"bid_floor": {
"type": "number",
"description": "Bid floor"
},
"geo_target": {
"type": "number",
"description": "Geo target ID"
},
"audience_target": {
"type": "number",
"description": "Audience target ID"
},
"whitelist_seats": {
"type": "array",
"items": {
"type": "string"
},
"description": "Seat IDs with access"
}
},
"additionalProperties": false
}Update an existing postal code target
| Argument | Type | Description |
|---|---|---|
| id* | number | Postal code target ID |
| label | string | Postal code target name |
| inclusive | boolean | If true, inclusion target; if false, exclusion target |
| locations | array | Array of locations grouped by country |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Postal code target ID"
},
"label": {
"type": "string",
"description": "Postal code target name"
},
"inclusive": {
"type": "boolean",
"description": "If true, inclusion target; if false, exclusion target"
},
"locations": {
"type": "array",
"items": {
"type": "object",
"required": [
"country",
"postal_codes"
],
"properties": {
"country": {
"type": "string",
"description": "Two-letter country code"
},
"postal_codes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of postal codes"
}
},
"additionalProperties": false
},
"description": "Array of locations grouped by country"
}
},
"additionalProperties": false
}Update an existing product catalog
| Argument | Type | Description |
|---|---|---|
| name | string | Catalog name |
| catalog_id* | number | Catalog ID |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"catalog_id"
],
"properties": {
"name": {
"type": "string",
"description": "Catalog name"
},
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Update an existing product catalog item
| Argument | Type | Description |
|---|---|---|
| url | string | Item URL |
| name | string | Item name |
| price | string | Item price |
| category | string | Item category |
| image_url | string | Item image URL |
| catalog_id* | number | Catalog ID |
| identifier* | string | Unique identifier for the catalog item |
| description | string | Item description |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"catalog_id",
"identifier"
],
"properties": {
"url": {
"type": "string",
"description": "Item URL"
},
"name": {
"type": "string",
"description": "Item name"
},
"price": {
"type": "string",
"description": "Item price"
},
"category": {
"type": "string",
"description": "Item category"
},
"image_url": {
"type": "string",
"description": "Item image URL"
},
"catalog_id": {
"type": "number",
"description": "Catalog ID"
},
"identifier": {
"type": "string",
"description": "Unique identifier for the catalog item"
},
"description": {
"type": "string",
"description": "Item description"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Update an existing product source
| Argument | Type | Description |
|---|---|---|
| url | string | Source URL |
| name | string | Source name |
| type | string | Source type |
| source_id* | number | Source ID |
| publisher_id* | number | Publisher ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"source_id"
],
"properties": {
"url": {
"type": "string",
"description": "Source URL"
},
"name": {
"type": "string",
"description": "Source name"
},
"type": {
"type": "string",
"description": "Source type"
},
"source_id": {
"type": "number",
"description": "Source ID"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
}
},
"additionalProperties": false
}Update an existing product source target
| Argument | Type | Description |
|---|---|---|
| name | string | Source target name |
| source_id | number | Source ID to target |
| publisher_id* | number | Publisher ID |
| source_target_id* | number | Source target ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"publisher_id",
"source_target_id"
],
"properties": {
"name": {
"type": "string",
"description": "Source target name"
},
"source_id": {
"type": "number",
"description": "Source ID to target"
},
"publisher_id": {
"type": "number",
"description": "Publisher ID"
},
"source_target_id": {
"type": "number",
"description": "Source target ID"
}
},
"additionalProperties": false
}Update an existing publisher
| Argument | Type | Description |
|---|---|---|
| id* | number | Publisher ID |
| name | string | Publisher name |
| string | Contact email | |
| domain | string | Publisher domain |
| metadata | object | Custom metadata key-value pairs |
| timezone | string | Timezone |
| seller_type | string | Seller type |
| default_payout | object | Default payout configuration |
| can_approve_ads | boolean | Allow publisher to approve/deny ad items |
| can_admin_account | boolean | Grant administrator privileges |
| can_change_password | boolean | Whether publisher can change password |
| can_view_wordpress_key | boolean | Allow publisher to view WordPress key |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Publisher ID"
},
"name": {
"type": "string",
"description": "Publisher name"
},
"email": {
"type": "string",
"description": "Contact email"
},
"domain": {
"type": "string",
"description": "Publisher domain"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"timezone": {
"type": "string",
"description": "Timezone"
},
"seller_type": {
"enum": [
"publisher",
"intermediary",
"both"
],
"type": "string",
"description": "Seller type"
},
"default_payout": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"type": {
"enum": [
"rate",
"percent"
],
"type": "string"
},
"fixed": {
"type": "number"
}
},
"description": "Default payout configuration",
"additionalProperties": false
},
"can_approve_ads": {
"type": "boolean",
"description": "Allow publisher to approve/deny ad items"
},
"can_admin_account": {
"type": "boolean",
"description": "Grant administrator privileges"
},
"can_change_password": {
"type": "boolean",
"description": "Whether publisher can change password"
},
"can_view_wordpress_key": {
"type": "boolean",
"description": "Allow publisher to view WordPress key"
}
},
"additionalProperties": false
}Update a report schedule
| Argument | Type | Description |
|---|---|---|
| frequency | string | Schedule frequency |
| recipients | array | Array of recipient objects |
| schedule_id* | number | Schedule ID |
| report_config_id* | number | Report configuration ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"report_config_id",
"schedule_id"
],
"properties": {
"frequency": {
"type": "string",
"description": "Schedule frequency"
},
"recipients": {
"type": "array",
"items": {},
"description": "Array of recipient objects"
},
"schedule_id": {
"type": "number",
"description": "Schedule ID"
},
"report_config_id": {
"type": "number",
"description": "Report configuration ID"
}
},
"additionalProperties": false
}Update an existing rich media ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | Ad item ID |
| name | string | Ad item name |
| creative | number | Rich media creative ID |
| location | string | Click-through URL |
| metadata | object | Custom metadata key-value pairs |
| tracking_pixel | string | Third-party tracking pixel URL |
| tracking_pixels | array | Array of tracking pixel URLs |
| html_content_below | string | HTML content below the ad item |
| trusted_redirect_domains | array | Trusted redirect domains |
| expand_vertical_direction | string | Vertical expand direction |
| expand_horizontal_direction | string | Horizontal expand direction |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Ad item ID"
},
"name": {
"type": "string",
"description": "Ad item name"
},
"creative": {
"type": "number",
"description": "Rich media creative ID"
},
"location": {
"type": "string",
"description": "Click-through URL"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"tracking_pixel": {
"type": "string",
"description": "Third-party tracking pixel URL"
},
"tracking_pixels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tracking pixel URLs"
},
"html_content_below": {
"type": "string",
"description": "HTML content below the ad item"
},
"trusted_redirect_domains": {
"type": "array",
"items": {
"type": "string"
},
"description": "Trusted redirect domains"
},
"expand_vertical_direction": {
"enum": [
"none",
"up",
"down"
],
"type": "string",
"description": "Vertical expand direction"
},
"expand_horizontal_direction": {
"enum": [
"none",
"left",
"right"
],
"type": "string",
"description": "Horizontal expand direction"
}
},
"additionalProperties": false
}Update an existing rich media creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
| name | string | Creative name |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
},
"name": {
"type": "string",
"description": "Creative name"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Update an existing role
| Argument | Type | Description |
|---|---|---|
| id* | number | Role ID |
| name | string | Role name |
| is_default_role | boolean | Auto-assign to new users |
| can_manage_links | boolean | Can manage tracking links |
| can_manage_media | boolean | Can manage creatives |
| can_manage_users | boolean | Can manage users |
| publisher_access | string | Publisher access level |
| statistics_access | string | Statistics access level |
| can_manage_bidders | boolean | Can manage bidders |
| can_manage_billing | boolean | Can manage billing |
| can_manage_targets | boolean | Can manage targets |
| can_manage_tickets | boolean | Can manage tickets |
| can_manage_contracts | boolean | Can manage contracts |
| can_manage_data_keys | boolean | Can manage data keys |
| can_manage_product_db | boolean | Can manage product catalogs |
| can_manage_self_serve | boolean | Can manage Self-Serve |
| publisher_access_list | array | Publisher IDs for specific access |
| can_manage_programmatic | boolean | Can manage programmatic |
| can_manage_admin_api_access | boolean | Can manage API keys |
| can_assign_campaigns_directly | boolean | Can assign campaigns directly |
| can_manage_native_ad_templates | boolean | Can manage native templates |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Role ID"
},
"name": {
"type": "string",
"description": "Role name"
},
"is_default_role": {
"type": "boolean",
"description": "Auto-assign to new users"
},
"can_manage_links": {
"type": "boolean",
"description": "Can manage tracking links"
},
"can_manage_media": {
"type": "boolean",
"description": "Can manage creatives"
},
"can_manage_users": {
"type": "boolean",
"description": "Can manage users"
},
"publisher_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Publisher access level"
},
"statistics_access": {
"enum": [
"none",
"specific",
"all"
],
"type": "string",
"description": "Statistics access level"
},
"can_manage_bidders": {
"type": "boolean",
"description": "Can manage bidders"
},
"can_manage_billing": {
"type": "boolean",
"description": "Can manage billing"
},
"can_manage_targets": {
"type": "boolean",
"description": "Can manage targets"
},
"can_manage_tickets": {
"type": "boolean",
"description": "Can manage tickets"
},
"can_manage_contracts": {
"type": "boolean",
"description": "Can manage contracts"
},
"can_manage_data_keys": {
"type": "boolean",
"description": "Can manage data keys"
},
"can_manage_product_db": {
"type": "boolean",
"description": "Can manage product catalogs"
},
"can_manage_self_serve": {
"type": "boolean",
"description": "Can manage Self-Serve"
},
"publisher_access_list": {
"type": "array",
"items": {
"type": "number"
},
"description": "Publisher IDs for specific access"
},
"can_manage_programmatic": {
"type": "boolean",
"description": "Can manage programmatic"
},
"can_manage_admin_api_access": {
"type": "boolean",
"description": "Can manage API keys"
},
"can_assign_campaigns_directly": {
"type": "boolean",
"description": "Can assign campaigns directly"
},
"can_manage_native_ad_templates": {
"type": "boolean",
"description": "Can manage native templates"
}
},
"additionalProperties": false
}Update an existing schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | Schedule ID |
| end_at | string | End date/time in ISO-8601 format |
| end_date | string | End date (YYYY-MM-DD HH:MM:SS) — deprecated, use end_at |
| start_at | string | Start date/time in ISO-8601 format |
| quota_type | string | Quota measurement type |
| start_date | string | Start date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at |
| day_cap_type | string | Daily cap type |
| day_cap_limit | number | Daily cap limit |
| day_parting_id | number | Day parting ID for time-of-day targeting |
| quota_lifetime | number | Total quota amount (views or clicks, not per thousand) |
| delivery_method | string | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
| end_at_timezone | string | IANA timezone for end_at |
| start_at_timezone | string | IANA timezone for start_at |
| per_user_view_limit | number | Per-user view frequency cap |
| per_user_view_period | number | Days before per-user view counter resets |
| under_delivery_behaviour | string | Whether to keep serving until quota met or stop on end date |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Schedule ID"
},
"end_at": {
"type": "string",
"description": "End date/time in ISO-8601 format"
},
"end_date": {
"type": "string",
"description": "End date (YYYY-MM-DD HH:MM:SS) — deprecated, use end_at"
},
"start_at": {
"type": "string",
"description": "Start date/time in ISO-8601 format"
},
"quota_type": {
"enum": [
"views",
"clicks"
],
"type": "string",
"description": "Quota measurement type"
},
"start_date": {
"type": "string",
"description": "Start date (YYYY-MM-DD HH:MM:SS) — deprecated, use start_at"
},
"day_cap_type": {
"enum": [
"views",
"clicks"
],
"type": "string",
"description": "Daily cap type"
},
"day_cap_limit": {
"type": "number",
"description": "Daily cap limit"
},
"day_parting_id": {
"type": "number",
"description": "Day parting ID for time-of-day targeting"
},
"quota_lifetime": {
"type": "number",
"description": "Total quota amount (views or clicks, not per thousand)"
},
"delivery_method": {
"enum": [
"default",
"smooth"
],
"type": "string",
"description": "Delivery pacing: \"default\" (ASAP) or \"smooth\" (evenly distributed)"
},
"end_at_timezone": {
"type": "string",
"description": "IANA timezone for end_at"
},
"start_at_timezone": {
"type": "string",
"description": "IANA timezone for start_at"
},
"per_user_view_limit": {
"type": "number",
"description": "Per-user view frequency cap"
},
"per_user_view_period": {
"type": "number",
"description": "Days before per-user view counter resets"
},
"under_delivery_behaviour": {
"enum": [
"endOnQuota",
"endOnDate"
],
"type": "string",
"description": "Whether to keep serving until quota met or stop on end date"
}
},
"additionalProperties": false
}Update an existing SFTP connection
| Argument | Type | Description |
|---|---|---|
| id* | number | SFTP connection ID |
| host | string | SFTP host |
| name | string | Connection name |
| path | string | Remote path |
| port | number | SFTP port |
| password | string | SFTP password |
| username | string | SFTP username |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "SFTP connection ID"
},
"host": {
"type": "string",
"description": "SFTP host"
},
"name": {
"type": "string",
"description": "Connection name"
},
"path": {
"type": "string",
"description": "Remote path"
},
"port": {
"type": "number",
"description": "SFTP port"
},
"password": {
"type": "string",
"description": "SFTP password"
},
"username": {
"type": "string",
"description": "SFTP username"
}
},
"additionalProperties": false
}Update an existing signature request
| Argument | Type | Description |
|---|---|---|
| id* | number | Signature request ID |
| contract_id* | number | Contract ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
}
},
"additionalProperties": false
}Update a recipient for a signature request
| Argument | Type | Description |
|---|---|---|
| name | string | Recipient name |
| string | Recipient email | |
| request_id* | number | Signature request ID |
| contract_id* | number | Contract ID |
| recipient_id* | number | Recipient ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"contract_id",
"request_id",
"recipient_id"
],
"properties": {
"name": {
"type": "string",
"description": "Recipient name"
},
"email": {
"type": "string",
"description": "Recipient email"
},
"request_id": {
"type": "number",
"description": "Signature request ID"
},
"contract_id": {
"type": "number",
"description": "Contract ID"
},
"recipient_id": {
"type": "number",
"description": "Recipient ID"
}
},
"additionalProperties": false
}Update an existing trusted redirect domain
| Argument | Type | Description |
|---|---|---|
| id* | number | Trusted redirect domain ID |
| domain | string | Trusted redirect domain (e.g. example.com) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Trusted redirect domain ID"
},
"domain": {
"type": "string",
"description": "Trusted redirect domain (e.g. example.com)"
}
},
"additionalProperties": false
}Update an existing user attribute in a user database
| Argument | Type | Description |
|---|---|---|
| id* | number | User attribute ID |
| type | string | Data type of the field |
| label | string | Descriptive label for the field |
| user_db_id* | number | User database ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"user_db_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "User attribute ID"
},
"type": {
"enum": [
"number",
"phone_number",
"email",
"text",
"date_time",
"timestamp"
],
"type": "string",
"description": "Data type of the field"
},
"label": {
"type": "string",
"description": "Descriptive label for the field"
},
"user_db_id": {
"type": "number",
"description": "User database ID"
}
},
"additionalProperties": false
}Update an existing video creative
| Argument | Type | Description |
|---|---|---|
| id* | number | Creative ID |
| name | string | Creative name |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Creative ID"
},
"name": {
"type": "string",
"description": "Creative name"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Update an existing standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Zone ID |
| name | string | Zone name |
| width | number | Zone width in pixels |
| height | number | Zone height in pixels |
| metadata | object | Custom metadata key-value pairs |
| bid_floor | number | Default bid floor |
| pmp_deals | array | Allowed PMP Deal IDs |
| publisher | number | Publisher ID |
| dimensions | string | Zone dimensions type |
| min_payout | number | Minimum payout per impression (CPM) |
| responsive | string | Size behavior |
| burn_in_hours | number | Hours before eCPM confidence |
| refresh_limit | number | Total times zone will refresh |
| ad_size_filter | object | Ad size filter (dynamic zones only) |
| api_frameworks | array | Supported API frameworks |
| iab_categories | array | IAB category descriptors |
| private_auction | boolean | Ignore non-deal bids in auction |
| unique_delivery | boolean | Serve unique ads on each zone |
| rtb_placement_id | string | OpenRTB tagid identifier |
| auction_tie_break | string | Tie-breaking method |
| refresh_frequency | number | Interval in seconds for serving new ads |
| burn_in_impressions | number | Impressions before eCPM confidence |
| allow_demand_sources | boolean | Allow requests to demand endpoints |
| serve_priority_order | string | Priority order |
| optimization_strategy | string | Zone optimization strategy |
| ecpm_testing_allowance | number | Percentage for eCPM recalculation |
| allowed_root_native_templates | array | Allowed root native template IDs |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Zone ID"
},
"name": {
"type": "string",
"description": "Zone name"
},
"width": {
"type": "number",
"description": "Zone width in pixels"
},
"height": {
"type": "number",
"description": "Zone height in pixels"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"bid_floor": {
"type": "number",
"description": "Default bid floor"
},
"pmp_deals": {
"type": "array",
"items": {
"type": "number"
},
"description": "Allowed PMP Deal IDs"
},
"publisher": {
"type": "number",
"description": "Publisher ID"
},
"dimensions": {
"enum": [
"fixed",
"dynamic"
],
"type": "string",
"description": "Zone dimensions type"
},
"min_payout": {
"type": "number",
"description": "Minimum payout per impression (CPM)"
},
"responsive": {
"enum": [
"fixed",
"auto",
"inherit"
],
"type": "string",
"description": "Size behavior"
},
"burn_in_hours": {
"type": "number",
"description": "Hours before eCPM confidence"
},
"refresh_limit": {
"type": "number",
"description": "Total times zone will refresh"
},
"ad_size_filter": {
"type": "object",
"properties": {
"type": {
"enum": [
"INCLUSIVE",
"EXCLUSIVE"
],
"type": "string"
},
"sizes": {
"type": "array",
"items": {
"type": "object",
"required": [
"width",
"height"
],
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
},
"additionalProperties": false
}
}
},
"description": "Ad size filter (dynamic zones only)",
"additionalProperties": false
},
"api_frameworks": {
"type": "array",
"items": {
"type": "string"
},
"description": "Supported API frameworks"
},
"iab_categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "IAB category descriptors"
},
"private_auction": {
"type": "boolean",
"description": "Ignore non-deal bids in auction"
},
"unique_delivery": {
"type": "boolean",
"description": "Serve unique ads on each zone"
},
"rtb_placement_id": {
"type": "string",
"description": "OpenRTB tagid identifier"
},
"auction_tie_break": {
"enum": [
"RANDOM",
"SCORE"
],
"type": "string",
"description": "Tie-breaking method"
},
"refresh_frequency": {
"type": "number",
"description": "Interval in seconds for serving new ads"
},
"burn_in_impressions": {
"type": "number",
"description": "Impressions before eCPM confidence"
},
"allow_demand_sources": {
"type": "boolean",
"description": "Allow requests to demand endpoints"
},
"serve_priority_order": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Priority order"
},
"optimization_strategy": {
"type": "string",
"description": "Zone optimization strategy"
},
"ecpm_testing_allowance": {
"type": "number",
"description": "Percentage for eCPM recalculation"
},
"allowed_root_native_templates": {
"type": "array",
"items": {
"type": "number"
},
"description": "Allowed root native template IDs"
}
},
"additionalProperties": false
}Update an existing ORTB native ad for a standard zone
| Argument | Type | Description |
|---|---|---|
| id* | number | ORTB native ad ID |
| name | string | ORTB native ad name |
| zone_id* | number | Standard zone ID |
| template_id | number | ORTB native template ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"zone_id",
"id"
],
"properties": {
"id": {
"type": "number",
"description": "ORTB native ad ID"
},
"name": {
"type": "string",
"description": "ORTB native ad name"
},
"zone_id": {
"type": "number",
"description": "Standard zone ID"
},
"template_id": {
"type": "number",
"description": "ORTB native template ID"
}
},
"additionalProperties": false
}Validate a beacon signing key
| Argument | Type | Description |
|---|---|---|
| key | string | Beacon signing key to validate |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"key": {
"type": "string",
"description": "Beacon signing key to validate"
}
},
"additionalProperties": false
}Create a VAST 4.2 ad item
| Argument | Type | Description |
|---|---|---|
| name* | string | Ad item name |
| active | boolean | Whether ad item is active |
| location | string | VAST tag URL or media location |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Ad item name"
},
"active": {
"type": "boolean",
"description": "Whether ad item is active"
},
"location": {
"type": "string",
"description": "VAST tag URL or media location"
}
},
"additionalProperties": false
}Create a VAST 4.2 campaign assignment
| Argument | Type | Description |
|---|---|---|
| active | boolean | Whether assignment is active |
| ad_item | number | VAST ad item ID |
| campaign | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"active": {
"type": "boolean",
"description": "Whether assignment is active"
},
"ad_item": {
"type": "number",
"description": "VAST ad item ID"
},
"campaign": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Create a VAST 4.2 closed caption file
| Argument | Type | Description |
|---|---|---|
| name | string | Closed caption file name |
| language | string | Language code |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Closed caption file name"
},
"language": {
"type": "string",
"description": "Language code"
}
},
"additionalProperties": false
}Create a VAST 4.2 companion
| Argument | Type | Description |
|---|---|---|
| name* | string | Companion name |
| width | number | Companion width in pixels |
| height | number | Companion height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Companion name"
},
"width": {
"type": "number",
"description": "Companion width in pixels"
},
"height": {
"type": "number",
"description": "Companion height in pixels"
}
},
"additionalProperties": false
}Create a VAST 4.2 creative
| Argument | Type | Description |
|---|---|---|
| name | string | Creative name |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Creative name"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Create a VAST 4.2 icon
| Argument | Type | Description |
|---|---|---|
| name | string | Icon name |
| width | number | Icon width in pixels |
| height | number | Icon height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Icon name"
},
"width": {
"type": "number",
"description": "Icon width in pixels"
},
"height": {
"type": "number",
"description": "Icon height in pixels"
}
},
"additionalProperties": false
}Create a VAST 4.2 icon click fallback image
| Argument | Type | Description |
|---|---|---|
| name | string | Icon click fallback image name |
| width | number | Width in pixels |
| height | number | Height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Icon click fallback image name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
}
},
"additionalProperties": false
}Create a VAST 4.2 interactive creative file
| Argument | Type | Description |
|---|---|---|
| name | string | Interactive creative file name |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Interactive creative file name"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Create a VAST 4.2 linear media
| Argument | Type | Description |
|---|---|---|
| name* | string | Linear media name |
| bitrate | number | Bitrate in kbps |
| duration | number | Duration in seconds |
| mime_type | string | MIME type (e.g. video/mp4) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Linear media name"
},
"bitrate": {
"type": "number",
"description": "Bitrate in kbps"
},
"duration": {
"type": "number",
"description": "Duration in seconds"
},
"mime_type": {
"type": "string",
"description": "MIME type (e.g. video/mp4)"
}
},
"additionalProperties": false
}Create a VAST 4.2 media file
| Argument | Type | Description |
|---|---|---|
| name | string | Media file name |
| width | number | Width in pixels |
| height | number | Height in pixels |
| bitrate | number | Bitrate in kbps |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Media file name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
},
"bitrate": {
"type": "number",
"description": "Bitrate in kbps"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Create a VAST 4.2 mezzanine
| Argument | Type | Description |
|---|---|---|
| name | string | Mezzanine name |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Mezzanine name"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Create a VAST 4.2 non-linear media
| Argument | Type | Description |
|---|---|---|
| name* | string | Non-linear media name |
| width | number | Width in pixels |
| height | number | Height in pixels |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Non-linear media name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Create a VAST 4.2 placement
| Argument | Type | Description |
|---|---|---|
| zone | number | VAST zone ID |
| active | boolean | Whether placement is active |
| channel | number | VAST channel ID |
| priority | number | Priority level |
| schedule | number | Schedule ID |
| advertisement* | object | Advertisement object with id and type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"advertisement"
],
"properties": {
"zone": {
"type": "number",
"description": "VAST zone ID"
},
"active": {
"type": "boolean",
"description": "Whether placement is active"
},
"channel": {
"type": "number",
"description": "VAST channel ID"
},
"priority": {
"type": "number",
"description": "Priority level"
},
"schedule": {
"type": "number",
"description": "Schedule ID"
},
"advertisement": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item or campaign ID"
},
"type": {
"type": "string",
"description": "Advertisement type"
}
},
"description": "Advertisement object with id and type",
"additionalProperties": false
}
},
"additionalProperties": false
}Create a VAST 4.2 resource
| Argument | Type | Description |
|---|---|---|
| name | string | Resource name |
| type | string | Resource type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Resource name"
},
"type": {
"type": "string",
"description": "Resource type"
}
},
"additionalProperties": false
}Create a VAST 4.2 universal ad ID
| Argument | Type | Description |
|---|---|---|
| name | string | Universal ad ID name |
| id_value | string | ID value |
| id_registry | string | ID registry |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"name": {
"type": "string",
"description": "Universal ad ID name"
},
"id_value": {
"type": "string",
"description": "ID value"
},
"id_registry": {
"type": "string",
"description": "ID registry"
}
},
"additionalProperties": false
}Delete a VAST 4.2 ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 ad item ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 campaign assignment ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 closed caption file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 closed caption file ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 closed caption file ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 companion
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 companion ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 companion ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 creative
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 creative ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 icon
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 icon ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 icon ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 icon click fallback image
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 icon click fallback image ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 icon click fallback image ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 interactive creative file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 interactive creative file ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 interactive creative file ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 linear media ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 media file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 media file ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 media file ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 mezzanine
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 mezzanine ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 mezzanine ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 non-linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 non-linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 non-linear media ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 placement
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 placement ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 resource
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 resource ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 resource ID"
}
},
"additionalProperties": false
}Delete a VAST 4.2 universal ad ID
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 universal ad ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 universal ad ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 ad item ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 campaign assignment ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 closed caption file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 closed caption file ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 closed caption file ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 companion
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 companion ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 companion ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 creative
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 creative ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 creative ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 icon
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 icon ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 icon ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 icon click fallback image
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 icon click fallback image ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 icon click fallback image ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 interactive creative file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 interactive creative file ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 interactive creative file ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 linear media ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 media file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 media file ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 media file ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 mezzanine
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 mezzanine ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 mezzanine ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 non-linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 non-linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 non-linear media ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 placement
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 placement ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 resource
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 resource ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 resource ID"
}
},
"additionalProperties": false
}Get a single VAST 4.2 universal ad ID
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 universal ad ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 universal ad ID"
}
},
"additionalProperties": false
}List all VAST 4.2 ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 campaign assignments
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 closed caption files
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 companions
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 creatives
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 icon click fallback images
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 icons
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 interactive creative files
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 linear media
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 media files
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 mezzanines
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 non-linear media
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 placements
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 resources
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST 4.2 universal ad IDs
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}Update a VAST 4.2 ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 ad item ID |
| name | string | Ad item name |
| active | boolean | Whether ad item is active |
| location | string | VAST tag URL or media location |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 ad item ID"
},
"name": {
"type": "string",
"description": "Ad item name"
},
"active": {
"type": "boolean",
"description": "Whether ad item is active"
},
"location": {
"type": "string",
"description": "VAST tag URL or media location"
}
},
"additionalProperties": false
}Update a VAST 4.2 campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 campaign assignment ID |
| active | boolean | Whether assignment is active |
| ad_item | number | VAST ad item ID |
| campaign | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 campaign assignment ID"
},
"active": {
"type": "boolean",
"description": "Whether assignment is active"
},
"ad_item": {
"type": "number",
"description": "VAST ad item ID"
},
"campaign": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Update a VAST 4.2 closed caption file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 closed caption file ID |
| name | string | Closed caption file name |
| language | string | Language code |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 closed caption file ID"
},
"name": {
"type": "string",
"description": "Closed caption file name"
},
"language": {
"type": "string",
"description": "Language code"
}
},
"additionalProperties": false
}Update a VAST 4.2 companion
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 companion ID |
| name | string | Companion name |
| width | number | Companion width in pixels |
| height | number | Companion height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 companion ID"
},
"name": {
"type": "string",
"description": "Companion name"
},
"width": {
"type": "number",
"description": "Companion width in pixels"
},
"height": {
"type": "number",
"description": "Companion height in pixels"
}
},
"additionalProperties": false
}Update a VAST 4.2 creative
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 creative ID |
| name | string | Creative name |
| description | string | Creative description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 creative ID"
},
"name": {
"type": "string",
"description": "Creative name"
},
"description": {
"type": "string",
"description": "Creative description"
}
},
"additionalProperties": false
}Update a VAST 4.2 icon
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 icon ID |
| name | string | Icon name |
| width | number | Icon width in pixels |
| height | number | Icon height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 icon ID"
},
"name": {
"type": "string",
"description": "Icon name"
},
"width": {
"type": "number",
"description": "Icon width in pixels"
},
"height": {
"type": "number",
"description": "Icon height in pixels"
}
},
"additionalProperties": false
}Update a VAST 4.2 icon click fallback image
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 icon click fallback image ID |
| name | string | Icon click fallback image name |
| width | number | Width in pixels |
| height | number | Height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 icon click fallback image ID"
},
"name": {
"type": "string",
"description": "Icon click fallback image name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
}
},
"additionalProperties": false
}Update a VAST 4.2 interactive creative file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 interactive creative file ID |
| name | string | Interactive creative file name |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 interactive creative file ID"
},
"name": {
"type": "string",
"description": "Interactive creative file name"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Update a VAST 4.2 linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 linear media ID |
| name | string | Linear media name |
| bitrate | number | Bitrate in kbps |
| duration | number | Duration in seconds |
| mime_type | string | MIME type (e.g. video/mp4) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 linear media ID"
},
"name": {
"type": "string",
"description": "Linear media name"
},
"bitrate": {
"type": "number",
"description": "Bitrate in kbps"
},
"duration": {
"type": "number",
"description": "Duration in seconds"
},
"mime_type": {
"type": "string",
"description": "MIME type (e.g. video/mp4)"
}
},
"additionalProperties": false
}Update a VAST 4.2 media file
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 media file ID |
| name | string | Media file name |
| width | number | Width in pixels |
| height | number | Height in pixels |
| bitrate | number | Bitrate in kbps |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 media file ID"
},
"name": {
"type": "string",
"description": "Media file name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
},
"bitrate": {
"type": "number",
"description": "Bitrate in kbps"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Update a VAST 4.2 mezzanine
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 mezzanine ID |
| name | string | Mezzanine name |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 mezzanine ID"
},
"name": {
"type": "string",
"description": "Mezzanine name"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Update a VAST 4.2 non-linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 non-linear media ID |
| name | string | Non-linear media name |
| width | number | Width in pixels |
| height | number | Height in pixels |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 non-linear media ID"
},
"name": {
"type": "string",
"description": "Non-linear media name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Update a VAST 4.2 placement
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 placement ID |
| zone | number | VAST zone ID |
| active | boolean | Whether placement is active |
| channel | number | VAST channel ID |
| priority | number | Priority level |
| schedule | number | Schedule ID |
| advertisement | object | Advertisement object with id and type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 placement ID"
},
"zone": {
"type": "number",
"description": "VAST zone ID"
},
"active": {
"type": "boolean",
"description": "Whether placement is active"
},
"channel": {
"type": "number",
"description": "VAST channel ID"
},
"priority": {
"type": "number",
"description": "Priority level"
},
"schedule": {
"type": "number",
"description": "Schedule ID"
},
"advertisement": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item or campaign ID"
},
"type": {
"type": "string",
"description": "Advertisement type"
}
},
"description": "Advertisement object with id and type",
"additionalProperties": false
}
},
"additionalProperties": false
}Update a VAST 4.2 resource
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 resource ID |
| name | string | Resource name |
| type | string | Resource type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 resource ID"
},
"name": {
"type": "string",
"description": "Resource name"
},
"type": {
"type": "string",
"description": "Resource type"
}
},
"additionalProperties": false
}Update a VAST 4.2 universal ad ID
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST 4.2 universal ad ID |
| name | string | Universal ad ID name |
| id_value | string | ID value |
| id_registry | string | ID registry |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST 4.2 universal ad ID"
},
"name": {
"type": "string",
"description": "Universal ad ID name"
},
"id_value": {
"type": "string",
"description": "ID value"
},
"id_registry": {
"type": "string",
"description": "ID registry"
}
},
"additionalProperties": false
}Archive a VAST campaign (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Archive a VAST channel (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST channel ID"
}
},
"additionalProperties": false
}Archive a VAST zone (soft-delete, can be restored later)
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST zone ID"
}
},
"additionalProperties": false
}Create a new VAST ad item
| Argument | Type | Description |
|---|---|---|
| name* | string | Ad item name |
| active | boolean | Whether ad item is active |
| location* | string | VAST tag URL or media location |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"location"
],
"properties": {
"name": {
"type": "string",
"description": "Ad item name"
},
"active": {
"type": "boolean",
"description": "Whether ad item is active"
},
"location": {
"type": "string",
"description": "VAST tag URL or media location"
}
},
"additionalProperties": false
}Create a new VAST campaign
| Argument | Type | Description |
|---|---|---|
| name* | string | Campaign name |
| contract | number | Contract ID (requires Contract Management add-on) |
| advertiser* | number | Advertiser ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"advertiser"
],
"properties": {
"name": {
"type": "string",
"description": "Campaign name"
},
"contract": {
"type": "number",
"description": "Contract ID (requires Contract Management add-on)"
},
"advertiser": {
"type": "number",
"description": "Advertiser ID"
}
},
"additionalProperties": false
}Create a VAST campaign assignment (assign an ad item to a campaign)
| Argument | Type | Description |
|---|---|---|
| active | boolean | Whether to actively serve ads (defaults to true) |
| ad_item* | number | VAST ad item ID |
| campaign* | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"ad_item",
"campaign"
],
"properties": {
"active": {
"type": "boolean",
"description": "Whether to actively serve ads (defaults to true)"
},
"ad_item": {
"type": "number",
"description": "VAST ad item ID"
},
"campaign": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Create a new VAST channel
| Argument | Type | Description |
|---|---|---|
| name* | string | Channel name |
| description | string | Channel description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Channel name"
},
"description": {
"type": "string",
"description": "Channel description"
}
},
"additionalProperties": false
}Assign a VAST zone to a VAST channel
| Argument | Type | Description |
|---|---|---|
| zone* | number | VAST zone ID |
| channel* | number | VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"channel",
"zone"
],
"properties": {
"zone": {
"type": "number",
"description": "VAST zone ID"
},
"channel": {
"type": "number",
"description": "VAST channel ID"
}
},
"additionalProperties": false
}Create a new VAST companion
| Argument | Type | Description |
|---|---|---|
| name* | string | Companion name |
| width | number | Companion width in pixels |
| height | number | Companion height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Companion name"
},
"width": {
"type": "number",
"description": "Companion width in pixels"
},
"height": {
"type": "number",
"description": "Companion height in pixels"
}
},
"additionalProperties": false
}Create a new VAST linear media
| Argument | Type | Description |
|---|---|---|
| name* | string | Linear media name |
| bitrate | number | Bitrate in kbps |
| duration | number | Duration in seconds |
| mime_type | string | MIME type (e.g. video/mp4) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Linear media name"
},
"bitrate": {
"type": "number",
"description": "Bitrate in kbps"
},
"duration": {
"type": "number",
"description": "Duration in seconds"
},
"mime_type": {
"type": "string",
"description": "MIME type (e.g. video/mp4)"
}
},
"additionalProperties": false
}Create a new VAST non-linear media
| Argument | Type | Description |
|---|---|---|
| name* | string | Non-linear media name |
| width | number | Width in pixels |
| height | number | Height in pixels |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Non-linear media name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Create a new VAST placement (assign a VAST ad item or campaign to a VAST zone or channel)
| Argument | Type | Description |
|---|---|---|
| cost | object | Pricing model: fixed_cost OR cpm/cpc/cpa |
| zone | number | VAST zone ID (required if channel not set; mutually exclusive with channel) |
| active | boolean | Whether placement is active (defaults to true) |
| payout | object | Publisher payout configuration |
| channel | number | VAST channel ID (required if zone not set; mutually exclusive with zone) |
| priority | number | Priority level (sponsorship, standard, network, bulk, house) |
| schedule* | number | VAST schedule ID |
| serve_method | string | Serving system: weight-based or auction-based |
| advertisement* | object | Advertisement object with id and type |
| max_frequency | number | Frequency cap limit |
| data_key_target_id | number | Data Key Target ID (Enterprise only) |
| max_frequency_type | string | Event type to count for frequency capping |
| max_frequency_period | number | Days before frequency counter resets |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"advertisement",
"schedule"
],
"properties": {
"cost": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"fixed_cost": {
"type": "number"
}
},
"description": "Pricing model: fixed_cost OR cpm/cpc/cpa",
"additionalProperties": false
},
"zone": {
"type": "number",
"description": "VAST zone ID (required if channel not set; mutually exclusive with channel)"
},
"active": {
"type": "boolean",
"description": "Whether placement is active (defaults to true)"
},
"payout": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"type": {
"enum": [
"rate",
"percent"
],
"type": "string"
},
"fixed": {
"type": "number"
}
},
"description": "Publisher payout configuration",
"additionalProperties": false
},
"channel": {
"type": "number",
"description": "VAST channel ID (required if zone not set; mutually exclusive with zone)"
},
"priority": {
"type": "number",
"description": "Priority level (sponsorship, standard, network, bulk, house)"
},
"schedule": {
"type": "number",
"description": "VAST schedule ID"
},
"serve_method": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Serving system: weight-based or auction-based"
},
"advertisement": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item or campaign ID"
},
"type": {
"enum": [
"vast_ad_item",
"vast_campaign"
],
"type": "string",
"description": "Type of advertisement"
}
},
"description": "Advertisement object with id and type",
"additionalProperties": false
},
"max_frequency": {
"type": "number",
"description": "Frequency cap limit"
},
"data_key_target_id": {
"type": "number",
"description": "Data Key Target ID (Enterprise only)"
},
"max_frequency_type": {
"enum": [
"start",
"view",
"firstQuartile",
"midpoint",
"thirdQuartile",
"complete"
],
"type": "string",
"description": "Event type to count for frequency capping"
},
"max_frequency_period": {
"type": "number",
"description": "Days before frequency counter resets"
}
},
"additionalProperties": false
}Create a new VAST schedule for time-based ad delivery
| Argument | Type | Description |
|---|---|---|
| end_date | string | End date (YYYY-MM-DD HH:MM:SS), null for indefinite |
| geo_target | number | Geotarget ID (0 = no targeting) |
| quota_type | string | Quota measurement type |
| start_date | string | Start date (YYYY-MM-DD HH:MM:SS) |
| day_parting_id | number | Day parting ID for time-of-day targeting |
| quota_lifetime | number | Total quota amount (views or clicks, not per thousand) |
| delivery_method | string | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"end_date": {
"type": "string",
"description": "End date (YYYY-MM-DD HH:MM:SS), null for indefinite"
},
"geo_target": {
"type": "number",
"description": "Geotarget ID (0 = no targeting)"
},
"quota_type": {
"enum": [
"views",
"clicks"
],
"type": "string",
"description": "Quota measurement type"
},
"start_date": {
"type": "string",
"description": "Start date (YYYY-MM-DD HH:MM:SS)"
},
"day_parting_id": {
"type": "number",
"description": "Day parting ID for time-of-day targeting"
},
"quota_lifetime": {
"type": "number",
"description": "Total quota amount (views or clicks, not per thousand)"
},
"delivery_method": {
"enum": [
"default",
"smooth"
],
"type": "string",
"description": "Delivery pacing: \"default\" (ASAP) or \"smooth\" (evenly distributed)"
}
},
"additionalProperties": false
}Create a new VAST tracking entry
| Argument | Type | Description |
|---|---|---|
| url | string | Tracking URL |
| name* | string | Tracking name |
| event | string | Tracking event type (e.g. start, firstQuartile, midpoint, thirdQuartile, complete) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name"
],
"properties": {
"url": {
"type": "string",
"description": "Tracking URL"
},
"name": {
"type": "string",
"description": "Tracking name"
},
"event": {
"type": "string",
"description": "Tracking event type (e.g. start, firstQuartile, midpoint, thirdQuartile, complete)"
}
},
"additionalProperties": false
}Create a new VAST zone
| Argument | Type | Description |
|---|---|---|
| name* | string | Zone name |
| metadata | object | Custom metadata key-value pairs |
| publisher* | number | Publisher ID |
| default_vast_ad_item | number | Default VAST ad item ID (mutually exclusive with default_vast_campaign) |
| serve_priority_order | string | Priority order for serving: "weight" or "auction" |
| default_vast_campaign | number | Default VAST campaign ID (mutually exclusive with default_vast_ad_item) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"publisher"
],
"properties": {
"name": {
"type": "string",
"description": "Zone name"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"publisher": {
"type": "number",
"description": "Publisher ID"
},
"default_vast_ad_item": {
"type": "number",
"description": "Default VAST ad item ID (mutually exclusive with default_vast_campaign)"
},
"serve_priority_order": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Priority order for serving: \"weight\" or \"auction\""
},
"default_vast_campaign": {
"type": "number",
"description": "Default VAST campaign ID (mutually exclusive with default_vast_ad_item)"
}
},
"additionalProperties": false
}Delete a VAST ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item ID"
}
},
"additionalProperties": false
}Permanently delete an archived VAST campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST campaign ID"
}
},
"additionalProperties": false
}Permanently delete an archived VAST channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST channel ID"
}
},
"additionalProperties": false
}Permanently delete an archived VAST zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST zone ID"
}
},
"additionalProperties": false
}Delete a VAST campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Delete a VAST campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign assignment ID"
}
},
"additionalProperties": false
}Delete a VAST channel
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST channel ID"
}
},
"additionalProperties": false
}Remove a VAST zone from a VAST channel
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST channel zone assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST channel zone assignment ID"
}
},
"additionalProperties": false
}Delete a VAST companion
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST companion ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST companion ID"
}
},
"additionalProperties": false
}Delete a VAST linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST linear media ID"
}
},
"additionalProperties": false
}Delete a VAST non-linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST non-linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST non-linear media ID"
}
},
"additionalProperties": false
}Delete a VAST placement
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST placement ID"
}
},
"additionalProperties": false
}Delete a VAST schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST schedule ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST schedule ID"
}
},
"additionalProperties": false
}Delete a VAST tracking entry
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST tracking ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST tracking ID"
}
},
"additionalProperties": false
}Delete a VAST zone
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST zone ID"
}
},
"additionalProperties": false
}Get details of a specific VAST ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST ad item ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item ID"
}
},
"additionalProperties": false
}Get details of a specific archived VAST campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST campaign ID"
}
},
"additionalProperties": false
}Get details of a specific archived VAST channel
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST channel ID"
}
},
"additionalProperties": false
}Get details of a specific archived VAST zone
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST zone ID"
}
},
"additionalProperties": false
}Get details of a specific VAST campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Get details of a specific VAST campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign assignment ID"
}
},
"additionalProperties": false
}Get details of a specific VAST channel
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST channel ID"
}
},
"additionalProperties": false
}Get details of a specific VAST channel zone assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST channel zone assignment ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST channel zone assignment ID"
}
},
"additionalProperties": false
}Get details of a specific VAST companion
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST companion ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST companion ID"
}
},
"additionalProperties": false
}Get details of a specific VAST linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST linear media ID"
}
},
"additionalProperties": false
}Get details of a specific VAST non-linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST non-linear media ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST non-linear media ID"
}
},
"additionalProperties": false
}Get details of a specific VAST placement
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST placement ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST placement ID"
}
},
"additionalProperties": false
}Get details of a specific VAST schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST schedule ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST schedule ID"
}
},
"additionalProperties": false
}Get details of a specific VAST tracking entry
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST tracking ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST tracking ID"
}
},
"additionalProperties": false
}Get details of a specific VAST zone
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST zone ID"
}
},
"additionalProperties": false
}List all VAST ad items
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived VAST campaigns
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived VAST channels
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all archived VAST zones
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST campaign assignments
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST campaigns
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST channel zone assignments
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST channels
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST companions
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST linear media
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST media (linear and non-linear)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST non-linear media
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST placements (assignments of VAST ad items to VAST zones)
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST schedules
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST tracking entries
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}List all VAST zones
| Argument | Type | Description |
|---|---|---|
| limit | number | Max results to return (default 100, max 100) |
| offset | number | Pagination offset |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "number",
"description": "Max results to return (default 100, max 100)"
},
"offset": {
"type": "number",
"description": "Pagination offset"
}
},
"additionalProperties": false
}Restore an archived VAST campaign back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST campaign ID"
}
},
"additionalProperties": false
}Restore an archived VAST channel back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST channel ID"
}
},
"additionalProperties": false
}Restore an archived VAST zone back to active status
| Argument | Type | Description |
|---|---|---|
| id* | number | Archived VAST zone ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Archived VAST zone ID"
}
},
"additionalProperties": false
}Update an existing VAST ad item
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST ad item ID |
| name | string | Ad item name |
| active | boolean | Whether ad item is active |
| location | string | VAST tag URL or media location |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item ID"
},
"name": {
"type": "string",
"description": "Ad item name"
},
"active": {
"type": "boolean",
"description": "Whether ad item is active"
},
"location": {
"type": "string",
"description": "VAST tag URL or media location"
}
},
"additionalProperties": false
}Update an existing VAST campaign
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign ID |
| name | string | Campaign name |
| contract | number | Contract ID (requires Contract Management add-on) |
| advertiser | number | Advertiser ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign ID"
},
"name": {
"type": "string",
"description": "Campaign name"
},
"contract": {
"type": "number",
"description": "Contract ID (requires Contract Management add-on)"
},
"advertiser": {
"type": "number",
"description": "Advertiser ID"
}
},
"additionalProperties": false
}Update a VAST campaign assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST campaign assignment ID |
| active | boolean | Whether to actively serve ads |
| ad_item | number | VAST ad item ID |
| campaign | number | VAST campaign ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST campaign assignment ID"
},
"active": {
"type": "boolean",
"description": "Whether to actively serve ads"
},
"ad_item": {
"type": "number",
"description": "VAST ad item ID"
},
"campaign": {
"type": "number",
"description": "VAST campaign ID"
}
},
"additionalProperties": false
}Update an existing VAST channel
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST channel ID |
| name | string | Channel name |
| description | string | Channel description |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST channel ID"
},
"name": {
"type": "string",
"description": "Channel name"
},
"description": {
"type": "string",
"description": "Channel description"
}
},
"additionalProperties": false
}Update a VAST channel zone assignment
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST channel zone assignment ID |
| zone | number | VAST zone ID |
| channel | number | VAST channel ID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST channel zone assignment ID"
},
"zone": {
"type": "number",
"description": "VAST zone ID"
},
"channel": {
"type": "number",
"description": "VAST channel ID"
}
},
"additionalProperties": false
}Update an existing VAST companion
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST companion ID |
| name | string | Companion name |
| width | number | Companion width in pixels |
| height | number | Companion height in pixels |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST companion ID"
},
"name": {
"type": "string",
"description": "Companion name"
},
"width": {
"type": "number",
"description": "Companion width in pixels"
},
"height": {
"type": "number",
"description": "Companion height in pixels"
}
},
"additionalProperties": false
}Update an existing VAST linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST linear media ID |
| name | string | Linear media name |
| bitrate | number | Bitrate in kbps |
| duration | number | Duration in seconds |
| mime_type | string | MIME type (e.g. video/mp4) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST linear media ID"
},
"name": {
"type": "string",
"description": "Linear media name"
},
"bitrate": {
"type": "number",
"description": "Bitrate in kbps"
},
"duration": {
"type": "number",
"description": "Duration in seconds"
},
"mime_type": {
"type": "string",
"description": "MIME type (e.g. video/mp4)"
}
},
"additionalProperties": false
}Update an existing VAST non-linear media
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST non-linear media ID |
| name | string | Non-linear media name |
| width | number | Width in pixels |
| height | number | Height in pixels |
| mime_type | string | MIME type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST non-linear media ID"
},
"name": {
"type": "string",
"description": "Non-linear media name"
},
"width": {
"type": "number",
"description": "Width in pixels"
},
"height": {
"type": "number",
"description": "Height in pixels"
},
"mime_type": {
"type": "string",
"description": "MIME type"
}
},
"additionalProperties": false
}Update an existing VAST placement
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST placement ID |
| cost | object | Pricing model: fixed_cost OR cpm/cpc/cpa |
| zone | number | VAST zone ID (mutually exclusive with channel) |
| active | boolean | Whether placement is active |
| payout | object | Publisher payout configuration |
| channel | number | VAST channel ID (mutually exclusive with zone) |
| priority | number | Priority level |
| schedule | number | VAST schedule ID |
| serve_method | string | Serving system: weight-based or auction-based |
| advertisement | object | Advertisement object with id and type |
| max_frequency | number | Frequency cap limit |
| data_key_target_id | number | Data Key Target ID (Enterprise only) |
| max_frequency_type | string | Event type for frequency capping |
| max_frequency_period | number | Days before frequency counter resets |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST placement ID"
},
"cost": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"fixed_cost": {
"type": "number"
}
},
"description": "Pricing model: fixed_cost OR cpm/cpc/cpa",
"additionalProperties": false
},
"zone": {
"type": "number",
"description": "VAST zone ID (mutually exclusive with channel)"
},
"active": {
"type": "boolean",
"description": "Whether placement is active"
},
"payout": {
"type": "object",
"properties": {
"cpa": {
"type": "number"
},
"cpc": {
"type": "number"
},
"cpm": {
"type": "number"
},
"type": {
"enum": [
"rate",
"percent"
],
"type": "string"
},
"fixed": {
"type": "number"
}
},
"description": "Publisher payout configuration",
"additionalProperties": false
},
"channel": {
"type": "number",
"description": "VAST channel ID (mutually exclusive with zone)"
},
"priority": {
"type": "number",
"description": "Priority level"
},
"schedule": {
"type": "number",
"description": "VAST schedule ID"
},
"serve_method": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Serving system: weight-based or auction-based"
},
"advertisement": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "number",
"description": "VAST ad item or campaign ID"
},
"type": {
"enum": [
"vast_ad_item",
"vast_campaign"
],
"type": "string",
"description": "Type of advertisement"
}
},
"description": "Advertisement object with id and type",
"additionalProperties": false
},
"max_frequency": {
"type": "number",
"description": "Frequency cap limit"
},
"data_key_target_id": {
"type": "number",
"description": "Data Key Target ID (Enterprise only)"
},
"max_frequency_type": {
"enum": [
"start",
"view",
"firstQuartile",
"midpoint",
"thirdQuartile",
"complete"
],
"type": "string",
"description": "Event type for frequency capping"
},
"max_frequency_period": {
"type": "number",
"description": "Days before frequency counter resets"
}
},
"additionalProperties": false
}Update an existing VAST schedule
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST schedule ID |
| end_date | string | End date (YYYY-MM-DD HH:MM:SS), null for indefinite |
| geo_target | number | Geotarget ID (0 = no targeting) |
| quota_type | string | Quota measurement type |
| start_date | string | Start date (YYYY-MM-DD HH:MM:SS) |
| day_parting_id | number | Day parting ID for time-of-day targeting |
| quota_lifetime | number | Total quota amount (views or clicks, not per thousand) |
| delivery_method | string | Delivery pacing: "default" (ASAP) or "smooth" (evenly distributed) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST schedule ID"
},
"end_date": {
"type": "string",
"description": "End date (YYYY-MM-DD HH:MM:SS), null for indefinite"
},
"geo_target": {
"type": "number",
"description": "Geotarget ID (0 = no targeting)"
},
"quota_type": {
"enum": [
"views",
"clicks"
],
"type": "string",
"description": "Quota measurement type"
},
"start_date": {
"type": "string",
"description": "Start date (YYYY-MM-DD HH:MM:SS)"
},
"day_parting_id": {
"type": "number",
"description": "Day parting ID for time-of-day targeting"
},
"quota_lifetime": {
"type": "number",
"description": "Total quota amount (views or clicks, not per thousand)"
},
"delivery_method": {
"enum": [
"default",
"smooth"
],
"type": "string",
"description": "Delivery pacing: \"default\" (ASAP) or \"smooth\" (evenly distributed)"
}
},
"additionalProperties": false
}Update an existing VAST tracking entry
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST tracking ID |
| url | string | Tracking URL |
| name | string | Tracking name |
| event | string | Tracking event type |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST tracking ID"
},
"url": {
"type": "string",
"description": "Tracking URL"
},
"name": {
"type": "string",
"description": "Tracking name"
},
"event": {
"type": "string",
"description": "Tracking event type"
}
},
"additionalProperties": false
}Update an existing VAST zone
| Argument | Type | Description |
|---|---|---|
| id* | number | VAST zone ID |
| name | string | Zone name |
| metadata | object | Custom metadata key-value pairs |
| publisher | number | Publisher ID |
| default_vast_ad_item | number | Default VAST ad item ID (mutually exclusive with default_vast_campaign) |
| serve_priority_order | string | Priority order for serving: "weight" or "auction" |
| default_vast_campaign | number | Default VAST campaign ID (mutually exclusive with default_vast_ad_item) |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "VAST zone ID"
},
"name": {
"type": "string",
"description": "Zone name"
},
"metadata": {
"type": "object",
"description": "Custom metadata key-value pairs",
"additionalProperties": {
"type": "string"
}
},
"publisher": {
"type": "number",
"description": "Publisher ID"
},
"default_vast_ad_item": {
"type": "number",
"description": "Default VAST ad item ID (mutually exclusive with default_vast_campaign)"
},
"serve_priority_order": {
"enum": [
"weight",
"auction"
],
"type": "string",
"description": "Priority order for serving: \"weight\" or \"auction\""
},
"default_vast_campaign": {
"type": "number",
"description": "Default VAST campaign ID (mutually exclusive with default_vast_ad_item)"
}
},
"additionalProperties": false
}Verify a trial account email with the verification code sent to the user. Call this after create_trial_account. The user must provide the code from their email. On success, the API key is automatically configured.
| Argument | Type | Description |
|---|---|---|
| email* | string | The email address used to create the trial account |
| verification_code* | string | The verification code from the email |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"email",
"verification_code"
],
"properties": {
"email": {
"type": "string",
"description": "The email address used to create the trial account"
},
"verification_code": {
"type": "string",
"description": "The verification code from the email"
}
},
"additionalProperties": false
}