completed, working < 120s, or submitted for manual review)
PATCH Semantics: Only specified fields are updated; omitted fields remain unchanged.
Request Schema: /schemas/v3/media-buy/update-media-buy-request.json
Response Schema: /schemas/v3/media-buy/update-media-buy-response.json
Quick Start
Create a media buy, then pause it:Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
media_buy_id | string | Yes* | Seller’s media buy identifier to update |
revision | integer | No | Expected current revision for optimistic concurrency. Seller rejects with CONFLICT on mismatch. Obtain from get_media_buys or the most recent response. |
start_time | string | No | Updated campaign start time |
end_time | string | No | Updated campaign end time |
paused | boolean | No | Pause/resume entire media buy (true = paused, false = active) |
canceled | boolean | No | Cancel the entire media buy (irreversible). Must be true when present. Seller may reject with NOT_CANCELLABLE. |
cancellation_reason | string | No | Reason for cancellation |
packages | PackageUpdate[] | No | Package-level updates (see below) |
reporting_webhook | object | No | Update reporting webhook configuration (see below) |
idempotency_key | string | No | Unique key for safe retries. If an update with the same key has already been processed, the seller returns the original response. MUST be unique per (seller, request) pair. Min 16 chars. |
invoice_recipient | BusinessEntity | No | Override who receives the invoice for this buy. The seller MUST validate authorization and include in check_governance when governance agents are configured. |
new_packages | PackageRequest[] | No | New packages to add to this media buy. Same shape as create_media_buy packages. Only supported by sellers that advertise add_packages in valid_actions. |
push_notification_config | object | No | Webhook for async operation notifications |
media_buy_id is required to identify the media buy to update.
Reporting Webhook Object
Configure automated delivery reporting for this media buy:| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Webhook endpoint URL |
authentication | object | Yes | Auth config with schemes and credentials |
reporting_frequency | string | Yes | hourly, daily, or monthly |
requested_metrics | string[] | No | Specific metrics to include (defaults to all) |
token | string | No | Client token for validation (min 16 chars) |
reporting_webhook configures ongoing campaign reporting. push_notification_config is for async operation notifications (e.g., “notify me when this update completes”).
Package Update Object
| Parameter | Type | Description |
|---|---|---|
package_id | string | Seller’s package identifier to update |
paused | boolean | Pause/resume specific package (true = paused, false = active) |
canceled | boolean | Cancel this package (irreversible). Must be true when present. Seller may reject with NOT_CANCELLABLE. |
cancellation_reason | string | Reason for canceling this package |
budget | number | Updated budget allocation |
impressions | number | Updated impression goal for this package |
start_time | string | Updated flight start date/time in ISO 8601 format. Must fall within the media buy’s date range. |
end_time | string | Updated flight end date/time in ISO 8601 format. Must fall within the media buy’s date range. |
pacing | string | Updated pacing strategy |
bid_price | number | Updated bid price (auction products only). This is the exact bid/price to honor unless the selected pricing option has max_bid: true, in which case it is treated as the buyer’s maximum willingness to pay (ceiling). |
optimization_goals | OptimizationGoal[] | Replace all optimization goals for this package. Uses replacement semantics — omit to leave goals unchanged. |
targeting_overlay | TargetingOverlay | Updated targeting restrictions |
catalogs | Catalog[] | Replace the catalogs this package promotes. Uses replacement semantics — omit to leave unchanged. |
keyword_targets_add | KeywordTarget[] | Keyword targets to add or upsert by (keyword, match_type) identity. On create, these are set as keyword_targets inside targeting_overlay. |
keyword_targets_remove | KeywordTarget[] | Keyword targets to remove by (keyword, match_type) identity. |
negative_keywords_add | NegativeKeyword[] | Negative keywords to append to this package. On create, these are set as negative_keywords inside targeting_overlay. |
negative_keywords_remove | NegativeKeyword[] | Negative keywords to remove from this package. |
creative_assignments | CreativeAssignment[] | Replace assigned creatives with optional weights and placement targeting |
creatives | CreativeAsset[] | Upload and assign new creatives inline (must not exist in library) |
package_id is required to identify the package to update.
Response
Success Response
| Field | Description |
|---|---|
media_buy_id | Media buy identifier |
status | Media buy status after the update (present when status changes, e.g., cancellation) |
revision | Revision number after this update. Use in subsequent requests for optimistic concurrency. |
implementation_date | ISO 8601 timestamp when changes take effect (null if pending approval) |
invoice_recipient | Updated invoice recipient, echoed from request when provided. Confirms the seller accepted the billing override. Bank details are omitted (write-only). |
valid_actions | Actions the buyer can perform after this update. Saves a round-trip to get_media_buys. |
affected_packages | Array of full Package objects showing complete state after update |
Error Response
| Field | Description |
|---|---|
errors | Array of error objects explaining failure |
errors before accessing success fields.
Common Scenarios
Update Package Budget
Increase budget for a specific package:Change Campaign Dates
Extend campaign end date:Update Targeting
Add or modify geographic restrictions:Replace Creatives
Swap out creative assignments for a package:Multiple Package Updates
Update multiple packages in one call:Cancel a Media Buy
Cancel an entire media buy:NOT_CANCELLABLE error response:
INVALID_STATE error response (e.g., trying to update a completed media buy):
Cancel a Package
Cancel a single package while the media buy remains active:What Can Be Updated
Campaign-Level Updates
✅ Can update:- Start/end times (subject to seller approval)
- Campaign status (active/paused/canceled)
- Reporting webhook configuration (URL, frequency, metrics)
- Media buy ID
- Brand reference
- Original package product IDs
Package-Level Updates
✅ Can update:- Budget allocation
- Pacing strategy
- Bid prices (auction products)
- Optimization goal (event source, event type, target ROAS/CPA)
- Targeting overlays
- Creative assignments
- Package status (active/paused/canceled)
- Catalog reference (replace the catalog a catalog-driven package promotes)
- Creative assignments (before the package’s
creative_deadline)
- Package ID
- Product ID
- Pricing option ID
- Format IDs (creatives must match existing formats)
Error Handling
Common errors and resolutions:| Error Code | Description | Resolution |
|---|---|---|
MEDIA_BUY_NOT_FOUND | Media buy doesn’t exist | Verify media_buy_id |
PACKAGE_NOT_FOUND | Package doesn’t exist | Verify package_id |
UPDATE_NOT_ALLOWED | Field cannot be changed | See “What Can Be Updated” above |
BUDGET_INSUFFICIENT | New budget below minimum | Increase budget amount |
POLICY_VIOLATION | Update violates content policy | Review policy requirements |
INVALID_STATE | Operation not allowed in current state (e.g., updating completed/canceled media buy) | Check campaign status via get_media_buys |
NOT_CANCELLABLE | Media buy or package cannot be canceled | Check seller’s cancellation policy or contact seller |
CREATIVE_REJECTED | Creative failed content policy review | Revise the creative per the seller’s advertising policies |
CREATIVE_DEADLINE_EXCEEDED | Creative change submitted past the package’s creative_deadline | Check package creative_deadline before submitting creative changes |
CREATIVE_ID_EXISTS | Creative ID already exists in library | Use a different creative_id, assign existing creatives via creative_assignments, or update via sync_creatives |
BUDGET_EXCEEDED | Operation would exceed allocated budget | Reduce the amount or increase media buy total budget |
CONFLICT | Revision mismatch — another update was applied since you last read | Re-read via get_media_buys and retry with current revision |
VALIDATION_ERROR | Request format or business rule violation | Check error field and message for specifics |
Update Approval
Some updates require seller approval and return pending status:- Significant budget increases (threshold varies by seller)
- Date range changes affecting inventory availability
- Targeting changes that alter campaign scope
- Creative changes requiring policy review
implementation_date will be null and affected_packages contains the proposed state of each package that would be modified:
PATCH Semantics
Only specified fields are updated - omitted fields remain unchanged:creative_assignments), provide the complete new array:
Asynchronous Operations
Updates may be asynchronous, especially with seller approval.Response Patterns
Synchronous (completed immediately) — campaign-level update (e.g.,paused: true):
Protocol-Specific Handling
AdCP tasks work across multiple protocols (MCP, A2A, REST). Each protocol handles async operations differently:- Status checking: Polling, webhooks, or streaming
- Updates: Protocol-specific mechanisms
- Long-running tasks: Different timeout and notification patterns
Best Practices
1. Use Precise Updates Update only what needs to change - don’t resend unchanged values. 2. Budget Increases Small incremental increases are more likely to be auto-approved than large jumps. 3. Pause Before Major Changes Pause campaigns before making significant targeting or creative changes to avoid delivery issues. 4. Test with Small Changes Test update workflows with minor changes before critical campaign modifications. 5. Monitor Status Always check response status andimplementation_date for approval requirements.
6. Validate Package State
Check affected_packages in response to confirm changes were applied correctly.
Usage Notes
- Updates are atomic - either all changes apply or none do
- Both media buys and packages can be referenced by publisher IDs
- Pending states (
working,submitted) are normal, not errors - Orchestrators MUST handle pending states as part of normal workflow
implementation_dateindicates when changes take effect (null if pending approval)- Inline creatives: The
creativesarray creates NEW creatives only. To update existing creatives, usesync_creatives. To assign existing library creatives, usecreative_assignmentsin the Package Update object.
Campaign Governance — Modification PhaseWhen a buyer’s account has governance agents configured, sellers MUST call
check_governance with media_buy_id, planned_delivery, and phase: "modification" before confirming an update. The governance agent validates change magnitude, budget reallocation, and new parameters against the campaign plan.See the seller integration guide for the full execution check workflow and code example.Next Steps
After updating a media buy:- Verify Changes: Use
get_media_buy_deliveryto confirm updates - Upload New Creatives: Use
sync_creativesif creative assignments changed - Monitor Performance: Track impact of changes on campaign metrics
- Optimize Further: Use
provide_performance_feedbackfor ongoing optimization
Learn More
- Media Buy Lifecycle - Complete campaign workflow
- Targeting - Targeting overlays and restrictions
- Async Operations - Async patterns and status checking
- create_media_buy - Initial campaign creation